Method AddChunkComponentData

AddChunkComponentData<T>(EntityManager, Entity)

Adds a chunk component to the specified entity.

Declaration

public static void AddChunkComponentData<T>(this EntityManager manager, Entity entity) where T : class, IComponentData, new()

Parameters

Type	Name	Description
EntityManager	manager	This entity manager.
Entity	entity	The entity.

Type Parameters

Name	Description
T	The type of component, which must implement IComponentData.

Remarks

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.

Exceptions

Type	Condition
ArgumentException	The Entity does not exist.

AddChunkComponentData<T>(EntityManager, EntityQuery, T)

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

Declaration

public static void AddChunkComponentData<T>(this EntityManager manager, EntityQuery entityQuery, T componentData) where T : class, IComponentData, new()

Parameters

Type	Name	Description
EntityManager	manager	This entity manager.
EntityQuery	entityQuery	The EntityQuery identifying the chunks to modify.
T	componentData	The data to set.

Type Parameters

Name	Description
T	The type of component, which must implement IComponentData.

Remarks

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.