NameplateOptions

How the plates over other players look and when they show.

Properties

Property	Type	Default value	Description
background?	boolean	false	Whether a dark pill, 50% black, stands behind the name. Without it a thin dark outline and a soft shadow keep the name legible.
color?	string	"#ffffff"	The CSS colour of a name with no team colour.
component?	ComponentType<NameplateProps>	undefined	Draws each plate in place of the engine’s Nameplate, from the same props, in pixels with the plate’s bottom middle at its origin.
distance?	number	30	Metres from the camera past which another player’s plate is gone. It shows whole to two thirds of it and fades out over the last third. fade sets both ends instead.
fade?	[number, number]	[20, 30]	Metres from the camera to where another player’s plate starts to fade, and to where it is gone, such as [20, 30]. A teammate’s plate never fades unless fade or distance is set.
offset?	Vector3Tuple	[0, 0.15, 0]	Metres from the top of her head to the bottom of her name, in her own axes.
show?	NameplateAudience	"all"	Whose plates show: every other player’s, teammates’ only, or none.
size?	number	12	CSS pixels the name’s letters stand at, the same at any distance.
teamColors?	TeamColorMode	TeamColorMode.Team	Whether a plate wears its team’s colour, or the plate’s own color whatever her team.
throughWalls?	NameplateWalls	"team"	When a plate shows through a wall: "never" hides it behind one, "team" shows a teammate’s through it and hides everyone else’s, and "always" shows every plate through it.