Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

SetComponentEnabled

Enable or disable the IComponentData of type T on the specified Entity. This operation does not cause a structural change (even if it occurs on a worker thread), or affect the value of the component. For the purposes of EntityQuery matching, an entity with a disabled component will behave as if it does not have that component. The type T must implement the IEnableableComponent interface.
Read time 2 minutesLast updated a day ago

Definition

  • Type: Method
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule

SetComponentEnabled<T>(Entity, bool)

Enable or disable the IComponentData of type T on the specified Entity. This operation does not cause a structural change (even if it occurs on a worker thread), or affect the value of the component. For the purposes of EntityQuery matching, an entity with a disabled component will behave as if it does not have that component. The type T must implement the IEnableableComponent interface.
public static void SetComponentEnabled<T>(Entity entity, bool value) where T : unmanaged, IComponentData, IEnableableComponent

Parameters

entity

Entity
The entity whose component should be enabled or disabled.

value

bool
True if the specified component should be enabled, or false if it should be disabled.

Remarks

Not working in Entities.ForEach, IJobEntity, and Utility methods
Additional Resources: SystemAPI.IsComponentEnabled

SetComponentEnabled<T>(SystemHandle, bool)

Enable or disable the IComponentData of type T on the specified system using a SystemHandle. This operation does not cause a structural change (even if it occurs on a worker thread), or affect the value of the component. For the purposes of EntityQuery matching, a system with a disabled component will behave as if it does not have that component. The type T must implement the IEnableableComponent interface.
public static void SetComponentEnabled<T>(SystemHandle systemHandle, bool value) where T : unmanaged, IComponentData, IEnableableComponent

Parameters

systemHandle

SystemHandle
The system whose component should be enabled or disabled.

value

bool
True if the specified component should be enabled, or false if it should be disabled.

Remarks

Not working in Entities.ForEach, IJobEntity, and Utility methods
Additional Resources: SystemAPI.IsComponentEnabled