Method SetComponent
SetComponent<T>(int, Entity, T)
Records a command to set a component value on an entity.
Declaration
public void SetComponent<T>(int sortKey, Entity e, T component) where T : unmanaged, IComponentData
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 component value of. |
T | component | The component value to set. |
Type Parameters
Name | Description |
---|---|
T | The type of component to set. |
Remarks
At playback, this command throws an error if this entity is destroyed before playback, if this entity is still deferred, if the entity doesn't have the component type, if the entity has the Prefab tag, or if T is zero sized.
Exceptions
Type | Condition |
---|---|
NullReferenceException | Throws if an Allocator was not passed in when the EntityCommandBuffer was created. |