SetComponentEnabled
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.
Read time 2 minutesLast updated a day ago
Definition
- Type: Method
- Namespace: Unity.Entities
- Assembly: UnityEngine.EntitiesModule
SetComponentEnabled(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 void SetComponentEnabled(SystemHandle systemHandle, bool value)
Parameters
The system whose component should be enabled or disabled.
True if the specified component should be enabled, or false if it should be disabled.
Remarks
Additional Resources: ComponentLookup<T>.IsComponentEnabled
SetComponentEnabled(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 void SetComponentEnabled(Entity entity, bool value)
Parameters
Remarks
Additional Resources: ComponentLookup<T>.IsComponentEnabled