Method SetEnabled

SetEnabled(Entity, Boolean)

Adds or removes the Disabled component to an Entity.

Declaration

public void SetEnabled(Entity entity, bool enabled)

Parameters

Type	Name	Description
Entity	entity	The entity to enable or disable
Boolean	enabled	True if the entity should be enabled

Remarks

Entities with the Disabled component are not matched by any EntityQuery, and are therefore not processed by systems. To override this behavior for a specific query, use EntityQueryOptions.IncludeDisabledEntities at query creation time.

If the entity was converted from a prefab and thus has a LinkedEntityGroup component, the entire group will be enabled or disabled.

This operation requires a structural change to add or remove the Disabled component. To enable or disable individual components without requiring a structural change, see IEnableableComponent and SetComponentEnabled<T>(SystemHandle, Boolean).

Exceptions

Type	Condition
ArgumentException	The Entity does not exist.

See Also

IsEnabled(Entity)