Version: Unity 7.0 Alpha (7000.0)
LanguageEnglish
  • C#

ArchetypeChunk.SetComponentEnabled

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public void SetComponentEnabled(ref ComponentTypeHandle`1 typeHandle, int entityIndexInChunk, bool value);

Parameters

Parameter Description
typeHandle A type handle for the component type that will be enabled or disabled.
entityIndexInChunk The index within this chunk of the entity whose component should be checked.
value True if the specified component should be enabled, or false if it should be disabled.

Description

Enable or disable a IComponentData on the specified Entity. This operation does not cause a structural change, 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.

Additional resources: ArchetypeChunk.IsComponentEnabled


Declaration

public void SetComponentEnabled(ref BufferTypeHandle`1 bufferTypeHandle, int entityIndexInChunk, bool value);

Parameters

Parameter Description
bufferTypeHandle A type handle for the buffer component type that will be enabled or disabled.
entityIndexInChunk The index within this chunk of the entity whose buffer component should be checked.
value True if the specified buffer component should be enabled, or false if it should be disabled.

Description

Enable or disable a IBufferElementData on the specified Entity. This operation does not cause a structural change, 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.

Additional resources: ArchetypeChunk.IsComponentEnabled


Declaration

public void SetComponentEnabled(ref DynamicComponentTypeHandle typeHandle, int entityIndexInChunk, bool value);

Parameters

Parameter Description
typeHandle A type handle for the component type that will be enabled or disabled.
entityIndexInChunk The index within this chunk of the entity whose component should be checked.
value True if the specified component should be enabled, or false if it should be disabled.

Description

Enable or disable a IComponentData on the specified Entity. This operation does not cause a structural change, 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.