Method IsComponentEnabled
IsComponentEnabled<T>(Entity)
Checks whether the IComponentData of type T is enabled on the specified Entity. 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.
Declaration
public static bool IsComponentEnabled<T>(Entity entity) where T : unmanaged, IComponentData, IEnableableComponentParameters
| Type | Name | Description |
|---|---|---|
| Entity | entity | The entity whose component should be checked. |
Returns
| Type | Description |
|---|---|
| bool | True if the specified component is enabled, or false if it is disabled. |
Type Parameters
| Name | Description |
|---|---|
| T | An unmanaged IComponentData type |
Remarks
Not working in Entities.ForEach, IJobEntity, Utility methods, and Aspects
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | The Entity does not exist. |
See Also
IsComponentEnabled<T>(SystemHandle)
Checks whether the IComponentData of type T is enabled on the specified system using a SystemHandle. 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.
Declaration
public static bool IsComponentEnabled<T>(SystemHandle systemHandle) where T : unmanaged, IComponentData, IEnableableComponentParameters
| Type | Name | Description |
|---|---|---|
| SystemHandle | systemHandle | The system whose component should be checked. |
Returns
| Type | Description |
|---|---|
| bool | True if the specified component is enabled, or false if it is disabled. |
Type Parameters
| Name | Description |
|---|---|
| T | An unmanaged IComponentData type |
Remarks
Not working in Entities.ForEach, IJobEntity, Utility methods, and Aspects
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | The SystemHandle does not exist. |