Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

SetEnabled(Entity, bool)

Adds or removes the Disabled component to an Entity.
Read time 1 minuteLast updated a day ago

Definition

  • Type: Method
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule
public void SetEnabled(Entity entity, bool enabled)

Parameters

entity

Entity
The entity to enable or disable

enabled

bool
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 EntityManager.SetComponentEnabled.
Additional Resources: EntityManager.IsEnabled