Method AddBuffer

AddBuffer<T>(Int32, Entity)

Records a command to add a dynamic buffer to an entity.

Declaration

public DynamicBuffer<T> AddBuffer<T>(int sortKey, Entity e)
    where T : struct, IBufferElementData

Parameters

Type	Name	Description
Int32	sortKey	A unique index for each set of commands added to this EntityCommandBuffer across all parallel jobs writing commands to this buffer. The entityInQueryIndex argument provided by Entities is an appropriate value to use for this parameter. In an IJobEntityBatch pass the 'batchIndex' value from Execute(ArchetypeChunk, Int32).
Entity	e	The entity to add the dynamic buffer to.

Returns

Type	Description
DynamicBuffer<T>	The DynamicBuffer<T> that will be added when the command plays back.

Type Parameters

Name	Description
T	The IBufferElementData type stored by the DynamicBuffer<T>.

Remarks

Behavior at Playback: If the entity already has this type of dynamic buffer, the dynamic buffer will just be set. Will throw an error if this entity is destroyed before playback, if this entity is still deferred, or if the entity doesn't have a DynamicBuffer<T> component storing elements of type T.

Exceptions

Type	Condition
NullReferenceException	Throws if an Allocator was not passed in when the EntityCommandBuffer was created.