Struct EntityCommandBuffer
A thread-safe command buffer that can buffer commands that affect entities and components for later playback.
Inherited Members
System.ValueType.Equals(System.Object)
System.ValueType.GetHashCode()
System.ValueType.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
Syntax
public struct EntityCommandBuffer
Properties
MinimumChunkSize
Allows controlling the size of chunks allocated from the temp job allocator to back the command buffer.
Declaration
public int MinimumChunkSize { get; set; }
Property Value
| Type |
Description |
| System.Int32 |
|
Methods
AddComponent<T>(T)
Declaration
public void AddComponent<T>(T component)where T : struct, IComponentData
Parameters
| Type |
Name |
Description |
| T |
component |
|
Type Parameters
AddComponent<T>(Entity, T)
Declaration
public void AddComponent<T>(Entity e, T component)where T : struct, IComponentData
Parameters
| Type |
Name |
Description |
| Entity |
e |
|
| T |
component |
|
Type Parameters
AddSharedComponent<T>(T)
Declaration
public void AddSharedComponent<T>(T component)where T : struct, ISharedComponentData
Parameters
| Type |
Name |
Description |
| T |
component |
|
Type Parameters
AddSharedComponent<T>(Entity, T)
Declaration
public void AddSharedComponent<T>(Entity e, T component)where T : struct, ISharedComponentData
Parameters
| Type |
Name |
Description |
| Entity |
e |
|
| T |
component |
|
Type Parameters
CreateEntity()
Declaration
public void CreateEntity()
CreateEntity(EntityArchetype)
Declaration
public void CreateEntity(EntityArchetype archetype)
Parameters
DestroyEntity(Entity)
Declaration
public void DestroyEntity(Entity e)
Parameters
| Type |
Name |
Description |
| Entity |
e |
|
Playback(EntityManager)
Play back all recorded operations against an entity manager.
Declaration
public void Playback(EntityManager mgr)
Parameters
| Type |
Name |
Description |
| EntityManager |
mgr |
The entity manager that will receive the operations
|
RemoveComponent<T>(Entity)
Declaration
public void RemoveComponent<T>(Entity e)
Parameters
| Type |
Name |
Description |
| Entity |
e |
|
Type Parameters
RemoveSystemStateComponent<T>(Entity)
Declaration
public void RemoveSystemStateComponent<T>(Entity e)
Parameters
| Type |
Name |
Description |
| Entity |
e |
|
Type Parameters
SetComponent<T>(T)
Declaration
public void SetComponent<T>(T component)where T : struct, IComponentData
Parameters
| Type |
Name |
Description |
| T |
component |
|
Type Parameters
SetComponent<T>(Entity, T)
Declaration
public void SetComponent<T>(Entity e, T component)where T : struct, IComponentData
Parameters
| Type |
Name |
Description |
| Entity |
e |
|
| T |
component |
|
Type Parameters
SetSharedComponent<T>(T)
Declaration
public void SetSharedComponent<T>(T component)where T : struct, ISharedComponentData
Parameters
| Type |
Name |
Description |
| T |
component |
|
Type Parameters
SetSharedComponent<T>(Entity, T)
Declaration
public void SetSharedComponent<T>(Entity e, T component)where T : struct, ISharedComponentData
Parameters
| Type |
Name |
Description |
| 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.