Documentation

Unity Engine


Unity Engine


SetName(int, Entity, in FixedString64Bytes)

Records a command to set a name of an entity if Debug Names is enabled.
Read time 1 minuteLast updated 3 days ago

Definition

  • Type: Method
  • Namespace: Unity.Entities
  • Assembly: UnityEngine.EntitiesModule

SetName(int, Entity, FixedString64Bytes)

public void SetName(int sortKey, Entity e, in FixedString64Bytes name)

Parameters

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

The entity to set the name value of.

The name to set.

Remarks

At playback, this command throws an error if this entity is destroyed before playback, if the entity has the Prefab tag, or if the EntityNameStore has reached its limit.