Method SetComponent

SetComponent<T>(Int32, 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 : struct, IComponentData

Parameters

Type	Name	Description
Int32	sortKey	A unique index for each set of commands added to this EntityCommandBuffer across all parallel jobs writing commands to this buffer. The entityInQueryIndex argument provided by Entities is an appropriate value to use for this parameter. In an IJobEntityBatch pass the 'batchIndex' value from Execute(ArchetypeChunk, Int32).
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

Behavior at Playback: Will throw an error if this entity is destroyed before playback, if this entity is still deferred, if the entity doesn't have the component type, or if T is zero sized.

Exceptions

Type	Condition
NullReferenceException	Throws if an Allocator was not passed in when the EntityCommandBuffer was created.