Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

SetComponent<T>(int, Entity, T)

Records a command to set a component value on an entity.
Read time 1 minuteLast updated 20 hours ago

Definition

  • Type: Method
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule
public void SetComponent<T>(int sortKey, Entity e, T component) where T : unmanaged, IComponentData

Parameters

sortKey

int
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 IJobChunk.Execute.

e

Entity
The entity to set the component value of.

component

T
The component value to set.

Remarks

At playback, this command throws an error if this entity is destroyed before playback, if the entity doesn't have the component type, if the entity has the Prefab tag, or if T is zero sized.