Skip to content
Work in progress. These docs describe Spawnite at launch, and some parts are still being built.

readDisplayName

readDisplayName(entity): string

What a player reads for the entity, from the first of: its DisplayNameTrait, the name of the player it is or stands for as her presence, an NPC’s own name, and its model’s name in words; empty for an entity with none. One reader for every plate and frame, so where a name is kept can change under them. For a React component, useDisplayName.

Parameter Type
entity Entity | null

string