Method SetEnabled
SetEnabled(int, Entity, bool)
Records a command to add or remove the Disabled component. By default EntityQuery does not include entities containing the Disabled component. Enabled entities are processed by systems, disabled entities are not.
If the entity was converted from a prefab and thus has a LinkedEntityGroup component, the entire group will be enabled or disabled.
Declaration
[GenerateTestsForBurstCompatibility]
public void SetEnabled(int sortKey, Entity e, bool value)
Parameters
Type | Name | Description |
---|---|---|
int | sortKey | A unique index for each set of commands added to this EntityCommandBuffer across all parallel jobs writing commands to this buffer. The ChunkIndexInQuery provided by IJobEntity is an appropriate value to use for this parameter. In an IJobChunk pass the 'unfilteredChunkIndex' value from Execute(in ArchetypeChunk, int, bool, in v128). |
Entity | e | The entity whose component should be enabled or disabled. |
bool | value | True if the specified component should be enabled, or false if it should be disabled. |
Remarks
At playback, this command throws an error if this entity is destroyed before playback, if the entity has the Prefab tag, or if this entity is still deferred.