Documentation

Unity Engine


Unity Engine


AddBuffer<T>(int, Entity)

Records a command to add a dynamic buffer to an entity.
Read time 1 minuteLast updated a day ago

Definition

  • Type: Method
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule
public DynamicBuffer<T> AddBuffer<T>(int sortKey, Entity e) where T : unmanaged, IBufferElementData

Parameters

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 IJobChunk.Execute.

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.

Remarks

At playback, if the entity already has this type of dynamic buffer, this method sets the dynamic buffer contents. If the entity doesn't have a DynamicBuffer<T> component that stores elements of type T, then this method adds a DynamicBuffer component with the provided contents. If the entity is destroyed before playback, an error is thrown.