Version: Unity 7.0 Alpha (7000.0)
LanguageEnglish
  • C#

EntityCommandBuffer.AddComponentForLinkedEntityGroup

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public void AddComponentForLinkedEntityGroup(Entity e, EntityQueryMask mask, T component);

Parameters

Parameter Description
e The entity whose LinkedEntityGroup will be referenced.
mask The EntityQueryMask that is used to determine which linked entities to add the component to. Note that EntityQueryMask ignores all query filtering (including chunk filtering and enableable components), and may thus match more entities than expected.
component The component value to set.

Description

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

At playback, this command throws an error if the entity is destroyed before playback, or if any of the matching linked entities cannot add the component.


Declaration

public void AddComponentForLinkedEntityGroup(Entity e, EntityQueryMask mask, ComponentType componentType);

Parameters

Parameter Description
e The entity whose LinkedEntityGroup will be referenced.
mask The EntityQueryMask that is used to determine which linked entities to add the component to. Note that EntityQueryMask ignores all query filtering (including chunk filtering and enableable components), and may thus match more entities than expected.
componentType The component type to add.

Description

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

At playback, this command throws an error if the entity is destroyed before playback, or if any of the matching linked entities cannot add the component.