Struct EntityCommandBuffer.ParallelWriter
Allows concurrent (deterministic) command buffer recording.
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
Returns
Type Parameters
AddComponent(Int32, Entity, ComponentType)
Declaration
public void AddComponent(int sortKey, Entity e, ComponentType componentType)
Parameters
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 Parameters
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
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
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
Remarks
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, EntityArchetype)
Declaration
public Entity CreateEntity(int sortKey, EntityArchetype archetype = default(EntityArchetype))
Parameters
Returns
DestroyEntity(Int32, Entity)
Declaration
public void DestroyEntity(int sortKey, Entity e)
Parameters
Instantiate(Int32, Entity)
Declaration
public Entity Instantiate(int sortKey, Entity e)
Parameters
Returns
RemoveComponent(Int32, Entity, ComponentType)
Declaration
public void RemoveComponent(int sortKey, Entity e, ComponentType componentType)
Parameters
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 Parameters
SetBuffer<T>(Int32, Entity)
Declaration
public DynamicBuffer<T> SetBuffer<T>(int sortKey, Entity e)
where T : struct, IBufferElementData
Parameters
Returns
Type Parameters
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
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
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.