Struct EntityCommandBuffer.ParallelWriter

Allows concurrent (deterministic) command buffer recording.

Namespace: Unity.Entities
Syntax
[NativeContainer]
[NativeContainerIsAtomicWriteOnly]
public struct ParallelWriter

Methods

AddBuffer<T>(Int32, Entity)

Declaration
public DynamicBuffer<T> AddBuffer<T>(int sortKey, Entity e)
    where T : struct, IBufferElementData
Parameters
Type Name Description
Int32 sortKey
Entity e
Returns
Type Description
DynamicBuffer<T>
Type Parameters
Name Description
T

AddComponent(Int32, Entity, ComponentType)

Declaration
public void AddComponent(int sortKey, Entity e, ComponentType componentType)
Parameters
Type Name Description
Int32 sortKey
Entity e
ComponentType componentType

AddComponent(Int32, Entity, ComponentTypes)

Records a command to add one or more components to an entity.

Declaration
public void AddComponent(int sortKey, Entity e, ComponentTypes types)
Parameters
Type Name Description
Int32 sortKey
Entity e

The entity to get additional components.

ComponentTypes types

The types of components to add.

AddComponent<T>(Int32, Entity)

Declaration
public void AddComponent<T>(int sortKey, Entity e)
    where T : struct, IComponentData
Parameters
Type Name Description
Int32 sortKey
Entity e
Type Parameters
Name Description
T

AddComponent<T>(Int32, Entity, T)

Declaration
public void AddComponent<T>(int sortKey, Entity e, T component)
    where T : struct, IComponentData
Parameters
Type Name Description
Int32 sortKey
Entity e
T component
Type Parameters
Name Description
T

AddSharedComponent<T>(Int32, Entity, T)

Declaration
public void AddSharedComponent<T>(int sortKey, Entity e, T component)
    where T : struct, ISharedComponentData
Parameters
Type Name Description
Int32 sortKey
Entity e
T component
Type Parameters
Name Description
T

AppendToBuffer<T>(Int32, Entity, T)

Appends a single element to the end of a dynamic buffer component.

Declaration
public void AppendToBuffer<T>(int sortKey, Entity e, T element)
    where T : struct, IBufferElementData
Parameters
Type Name Description
Int32 sortKey

A unique index for each set of commands added to the concurrent command buffer across all parallel jobs writing commands to this buffer. The entityInQueryIndex argument provided by Entities is an appropriate value to use for this parameter. You can calculate a similar index in an IJobChunk by adding the current entity index within a chunk to the Execute(ArchetypeChunk, Int32, Int32) method's firstEntityIndex argument.
Entity e

The entity to which the dynamic buffer belongs.
T element

The new element to add to the DynamicBuffer<T> component.
Type Parameters
Name Description
T

The IBufferElementData type stored by the DynamicBuffer<T>.
Remarks

At Playback(EntityManager), this command throws an InvalidOperationException if the entity doesn't have a DynamicBuffer<T> component storing elements of type T.

Exceptions
Type Condition
InvalidOperationException

Thrown if the entity does not have a DynamicBuffer<T> component storing elements of type T at the time the entity command buffer executes this append-to-buffer command.

CreateEntity(Int32)

Create an entity with no components.

Declaration
public Entity CreateEntity(int sortKey)
Parameters
Type Name Description
Int32 sortKey

A unique index for each set of commands added to the concurrent command buffer across all parallel jobs writing commands to this buffer. The entityInQueryIndex argument provided by Entities is an appropriate value to use for this parameter. You can calculate a similar index in an IJobChunk by adding the current entity index within a chunk to the Execute(ArchetypeChunk, Int32, Int32) method's firstEntityIndex argument.
Returns
Type Description
Entity
Remarks

Returns the new Entity.

CreateEntity(Int32, EntityArchetype)

Create an entity with specified archetype.

Declaration
public Entity CreateEntity(int sortKey, EntityArchetype archetype)
Parameters
Type Name Description
Int32 sortKey

A unique index for each set of commands added to the concurrent command buffer across all parallel jobs writing commands to this buffer. The entityInQueryIndex argument provided by Entities is an appropriate value to use for this parameter. You can calculate a similar index in an IJobChunk by adding the current entity index within a chunk to the Execute(ArchetypeChunk, Int32, Int32) method's firstEntityIndex argument.
EntityArchetype archetype

The archetype of the new entity.
Returns
Type Description
Entity
Remarks

Returns the new Entity.

DestroyEntity(Int32, Entity)

Declaration
public void DestroyEntity(int sortKey, Entity e)
Parameters
Type Name Description
Int32 sortKey
Entity e

Instantiate(Int32, Entity)

Declaration
public Entity Instantiate(int sortKey, Entity e)
Parameters
Type Name Description
Int32 sortKey
Entity e
Returns
Type Description
Entity

RemoveComponent(Int32, Entity, ComponentType)

Declaration
public void RemoveComponent(int sortKey, Entity e, ComponentType componentType)
Parameters
Type Name Description
Int32 sortKey
Entity e
ComponentType componentType

RemoveComponent(Int32, Entity, ComponentTypes)

Records a command to remove one or more components from an entity.

Declaration
public void RemoveComponent(int sortKey, Entity e, ComponentTypes types)
Parameters
Type Name Description
Int32 sortKey
Entity e

The entity to have the components removed.

ComponentTypes types

The types of components to remove.

RemoveComponent<T>(Int32, Entity)

Declaration
public void RemoveComponent<T>(int sortKey, Entity e)
Parameters
Type Name Description
Int32 sortKey
Entity e
Type Parameters
Name Description
T

SetBuffer<T>(Int32, Entity)

Declaration
public DynamicBuffer<T> SetBuffer<T>(int sortKey, Entity e)
    where T : struct, IBufferElementData
Parameters
Type Name Description
Int32 sortKey
Entity e
Returns
Type Description
DynamicBuffer<T>
Type Parameters
Name Description
T

SetComponent<T>(Int32, Entity, T)

Declaration
public void SetComponent<T>(int sortKey, Entity e, T component)
    where T : struct, IComponentData
Parameters
Type Name Description
Int32 sortKey
Entity e
T component
Type Parameters
Name Description
T

SetSharedComponent<T>(Int32, Entity, T)

Declaration
public void SetSharedComponent<T>(int sortKey, Entity e, T component)
    where T : struct, ISharedComponentData
Parameters
Type Name Description
Int32 sortKey
Entity e
T component
Type Parameters
Name Description
T