QCherry: Document universal per-observer nameplates and test resource available from update 0.1.3

2026-09-09T03:08:48Z

Document universal per-observer nameplates and test resource available from update 0.1.3

← Older revision		Revision as of 03:08, 9 September 2026
Line 1:		Line 1:
	~~<!-- This page is generated automatically from the function definition: setPlayerNameplateText. -->~~
	= setPlayerNameplateText =		= setPlayerNameplateText =
	Changes a player's server-authoritative overhead nameplate text.		Changes a player's server-authoritative overhead nameplate text.
Line 18:		Line 17:

	== Returns ==		== Returns ==
	Returns <code>true</code> when the text was accepted ~~and replicated~~; otherwise returns <code>false</code>.		Returns <code>true</code> when the global text was accepted; otherwise returns <code>false</code>. This is not a client-render acknowledgement.

	== Examples ==		== Examples ==
Line 31:		Line 30:
	* Control characters, HTML delimiters, ampersands, byte-order marks and bidirectional formatting characters are rejected.		* Control characters, HTML delimiters, ampersands, byte-order marks and bidirectional formatting characters are rejected.
	* The reliable state is replayed during relevance entry and late join.		* The reliable state is replayed during relevance entry and late join.
			* Changes the global fallback only. An explicit [[setPlayerNameplateTextFor\|per-observer text override]] still wins; visibility and ID policy are preserved. Custom text does not automatically hide the numeric ID.

	[[Category:Lua Functions]]		[[Category:Lua Functions]]

QCherry: Document Protocol 23 voice and player presentation APIs

2026-08-24T06:13:15Z

Document Protocol 23 voice and player presentation APIs

New page

= setPlayerNameplateText =
Changes a player's server-authoritative overhead nameplate text.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerNameplateText(int playerId, string text)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player identifier.
|-
| <code>text</code> || <code>string</code> || yes || Validated UTF-8 text, or an empty string to restore the default player name.
|}

== Returns ==
Returns <code>true</code> when the text was accepted and replicated; otherwise returns <code>false</code>.

== Examples ==
Show a roleplay label:
<syntaxhighlight lang="lua" line>
setPlayerNameplateText(playerId, "Militia Guard")
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Text is limited to 48 Unicode code points and 96 UTF-8 bytes.
* Control characters, HTML delimiters, ampersands, byte-order marks and bidirectional formatting characters are rejected.
* The reliable state is replayed during relevance entry and late join.

[[Category:Lua Functions]]
[[Category:Server Functions]]
[[Category:Player Functions]]
[[Category:Nameplate Functions]]

SetPlayerNameplateText - Revision history

QCherry: Document universal per-observer nameplates and test resource available from update 0.1.3

QCherry: Document Protocol 23 voice and player presentation APIs