Method SetComponentForLinkedEntityGroup

SetComponentForLinkedEntityGroup<T>(Entity, EntityQueryMask, T)

Records a command that sets a component for an entity's LinkedEntityGroup based on an EntityQueryMask. Entities in the LinkedEntityGroup that don't match the mask will be skipped safely.

Declaration

public void SetComponentForLinkedEntityGroup<T>(Entity e, EntityQueryMask mask, T component) where T : unmanaged, IComponentData

Parameters

Type	Name	Description
Entity	e	The entity whose LinkedEntityGroup will be modified by this command.
EntityQueryMask	mask	The EntityQueryMask that is used to determine which linked entities to set the component for. Note that EntityQueryMask ignores all query filtering (including chunk filtering and enableable components), and may thus match more entities than expected.
T	component	The component value to set.

Type Parameters

Name	Description
T	The type of component to add.

Remarks

At playback, this command throws an error if the entity is destroyed before playback, if the entity is still deferred, if the entity has the Prefab tag, or if any of the matching linked entities do not already have the component.

Exceptions

Type	Condition
ArgumentException	Throws if the component has a reference to a deferred entity, requiring fixup within the command buffer.
NullReferenceException	Throws if an Allocator was not passed in when the EntityCommandBuffer was created.
InvalidOperationException	Throws if this EntityCommandBuffer has already been played back.