Method SetName

SetName(int, Entity, in FixedString64Bytes)

Records a command to set a name of an entity if Debug Names is enabled.

Declaration

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

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 name value of.
FixedString64Bytes	name	The name 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 has the Prefab tag, or if the EntityNameStore has reached its limit.

Exceptions

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