Method SetBuffer
SetBuffer<T>(int, Entity)
Records a command to set a dynamic buffer on an entity.
Declaration
public DynamicBuffer<T> SetBuffer<T>(int sortKey, Entity e) where T : unmanaged, IBufferElementData
Parameters
Type | Name | Description |
---|---|---|
int | sortKey | A unique index for each set of commands added to this EntityCommandBuffer across all parallel jobs writing commands to this buffer. The ChunkIndexInQuery provided by IJobEntity is an appropriate value to use for this parameter. In an IJobChunk pass the 'unfilteredChunkIndex' value from Execute(in ArchetypeChunk, int, bool, in v128). |
Entity | e | The entity to set the dynamic buffer on. |
Returns
Type | Description |
---|---|
DynamicBuffer<T> | The DynamicBuffer<T> that will be set when the command plays back. |
Type Parameters
Name | Description |
---|---|
T | The IBufferElementData type stored by the DynamicBuffer<T>. |
Remarks
At playback, this command throws 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. |