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

EntityManager.AddChunkComponentData

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 bool AddChunkComponentData(Entity entity);

Parameters

Parameter Description
entity The entity.

Returns

bool False if the entity already had the chunk component. The chunk component's value is set regardless.

Description

Adds a chunk component to the specified entity.

Adding a chunk component to an entity changes that entity's archetype and results in the entity being moved to a different chunk, either one that already has an archetype containing the chunk component or a new chunk.

A chunk component is common to all entities in a chunk. You can access a chunk IComponentData instance through either the chunk itself or through an entity stored in that chunk. In either case, getting or setting the component reads or writes the same data.

Important: This method creates a sync point, which means that the EntityManager waits for all currently running jobs to complete before adding the component. No additional jobs can start before the method is finished. A sync point can cause a drop in performance because the ECS framework might not be able to use the processing power of all available cores.


Declaration

public void AddChunkComponentData(EntityQuery entityQuery, T componentData);

Parameters

Parameter Description
entityQuery The EntityQuery identifying the chunks to modify.
componentData The data to set.

Description

Adds a chunk component to each of the chunks identified by an EntityQuery and sets the component values.

This function finds all chunks whose archetype satisfies the EntityQuery and adds the specified component to them.

A chunk component is common to all entities in a chunk. You can access a chunk IComponentData instance through either the chunk itself or through an entity stored in that chunk.

Important: This method creates a sync point, which means that the EntityManager waits for all currently running jobs to complete before adding the component. No additional jobs can start before the method is finished. A sync point can cause a drop in performance because the ECS framework might not be able to use the processing power of all available cores.