Method SetComponentEnabled

SetComponentEnabled(Entity, ComponentType, bool)

Enable or disable ComponentType on the specified Entity.

Declaration
public void SetComponentEnabled(Entity entity, ComponentType componentType, bool value)
Parameters
Type Name Description
Entity entity

The entity whose component should be enabled or disabled.
ComponentType componentType

The component type to enable or disable. This type must implement the IEnableableComponent interface.
bool value

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

This operation does not cause a structural change, and does not affect the current value of the component.

An entity with a disabled component will not match an EntityQuery that requires that component, and will match a query that excludes that component.

To enable/disable components from a job, use SetComponentEnabled(Entity, bool). To enable/disable an entire Entity, use SetEnabled(Entity, bool) (which, unlike this function, does involve a structural change).

Exceptions
Type Condition
ArgumentException

The Entity does not exist.
See Also

SetComponentEnabled<T>(Entity, bool)

Enable or disable a ComponentType on the specified Entity.

Declaration
[GenerateTestsForBurstCompatibility(GenericTypeArguments = new Type[] { typeof(BurstCompatibleEnableableComponent) })]
public void SetComponentEnabled<T>(Entity entity, bool value) where T : IEnableableComponent
Parameters
Type Name Description
Entity entity

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.
Type Parameters
Name Description
T

The component type to enable or disable. This type must implement the IEnableableComponent interface.
Remarks

This operation does not cause a structural change, and does not affect the current value of the component.

An entity with a disabled component will not match an EntityQuery that requires that component, and will match a query that excludes that component.

To enable/disable components from a job, use SetComponentEnabled(Entity, bool). To enable/disable an entire Entity, use SetEnabled(Entity, bool) (which, unlike this function, does involve a structural change).

Exceptions
Type Condition
ArgumentException

The Entity does not exist.
See Also