Method AddSharedComponent

AddSharedComponent<T>(Entity, T)

Records a command to add a shared component value on an entity.

Declaration

public void AddSharedComponent<T>(Entity e, T component)
    where T : struct, ISharedComponentData

Parameters

Type	Name	Description
Entity	e	The entity to add the shared component value to.
T	component	The shared component value to add.

Type Parameters

Name	Description
T	The type of shared component to add.

Remarks

Behavior at Playback: Will throw an error if this entity is destroyed before playback, if this entity is still deferred, if adding this shared component exceeds the maximum number of shared components, or adding a component type makes the archetype too large.

Exceptions

Type	Condition
NullReferenceException	Throws if an Allocator was not passed in when the EntityCommandBuffer was created.
InvalidOperationException	Throws if this EntityCommandBuffer has already been played back.

AddSharedComponent<T>(NativeArray<Entity>, T)

Records a command to add a shared component value on a NativeArray of entities.

Declaration

public void AddSharedComponent<T>(NativeArray<Entity> entities, T component)
    where T : struct, ISharedComponentData

Parameters

Type	Name	Description
NativeArray<Entity>	entities	The NativeArray of entities to add the shared component value to.
T	component	The shared component value to add.

Type Parameters

Name	Description
T	The type of shared component to add.

Remarks

Behavior at Playback: Will throw an error if any entity is destroyed before playback, if any entity is still deferred, if adding this shared component exceeds the maximum number of shared components, or adding a component type makes the archetype too large.

Exceptions

Type	Condition
NullReferenceException	Throws if an Allocator was not passed in when the EntityCommandBuffer was created.
InvalidOperationException	Throws if this EntityCommandBuffer has already been played back.