IsComponentEnabled
Checks whether a given IComponentData 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.
Read time 2 minutesLast updated a day ago
Definition
- Type: Method
- Namespace: Unity.Entities
- Assembly: UnityEngine.EntitiesModule
IsComponentEnabled<T>(ComponentTypeHandle<T>, int)
Checks whether a given IComponentData 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.
public readonly bool IsComponentEnabled<T>(ref ComponentTypeHandle<T> typeHandle, int entityIndexInChunk) where T : struct, IComponentData, IEnableableComponent
Parameters
A type handle for the component type that will be queried.
The index within this chunk of the entity whose component should be checked.
Returns
Type | Description |
|---|---|
| bool | True if the specified component is enabled, or false if it is disabled. Also returns false if the |
Remarks
Additional Resources: ArchetypeChunk.SetComponentEnabled
IsComponentEnabled<T>(BufferTypeHandle<T>, int)
Checks whether a given IBufferElementData 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.
public readonly bool IsComponentEnabled<T>(ref BufferTypeHandle<T> bufferTypeHandle, int entityIndexInChunk) where T : unmanaged, IBufferElementData, IEnableableComponent
Parameters
A type handle for the component type that will be queried.
The index within this chunk of the entity whose component should be checked.
Returns
Type | Description |
|---|---|
| bool | True if the specified buffer component is enabled, or false if it is disabled. Also returns false if the |
Remarks
Additional Resources: ArchetypeChunk.SetComponentEnabled
IsComponentEnabled(DynamicComponentTypeHandle, int)
Checks whether a given IBufferElementData 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.
public readonly bool IsComponentEnabled(ref DynamicComponentTypeHandle typeHandle, int entityIndexInChunk)
Parameters
A type handle for the component type that will be queried.
The index within this chunk of the entity whose component should be checked.
Returns
Type | Description |
|---|---|
| bool | True if the specified buffer component is enabled, or false if it is disabled. Also returns false if the |
Remarks
Additional Resources: ArchetypeChunk.SetComponentEnabled