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

2026-09-09T03:08:43Z

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

New page

= setPlayerNameplateIdVisible =
<div style="background:#fff5f5; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111111; padding:0.85rem 1rem; margin:0.75rem 0 1rem;">
<div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">AVAILABLE FROM UPDATE 0.1.3</div>
<div style="color:#111111; margin-top:0.25rem;">This function is available in G1R:MP 0.1.3 and later. The contract below includes the compatibility guarantees introduced in that update.</div>
</div>

Sets the global numeric session-ID visibility fallback for a human player's overhead label.

== Syntax ==
<syntaxhighlight lang="lua">
bool setPlayerNameplateIdVisible(int playerId, bool visible)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player identifier.
|-
| <code>visible</code> || <code>bool</code> || yes || Strict boolean; true restores the normal ID suffix, false hides only that suffix.
|}

== Returns ==
Returns <code>true</code> when the server accepts the global policy; otherwise <code>false</code>. This is not a client-render acknowledgement.

== Examples ==
Keep a roleplay label while removing its numeric session ID:
<syntaxhighlight lang="lua" line>
setPlayerNameplateText(playerId, "Stranger")
setPlayerNameplateIdVisible(playerId, false)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Defaults to true. A per-observer ID override takes precedence. Text, whole-label visibility and speaking state are preserved; custom text never automatically hides IDs.
* Uses existing global-state semantics: not resource-owned and not automatically reverted when the calling resource stops. The runtime state ends on player disconnect; persistent policy must be reapplied by the gamemode.
* Not a permission boundary or anonymous networking mode; canonical identity remains available in other packets/UI. See [[Observer nameplates]].
* PascalCase alias: <code>SetPlayerNameplateIdVisible</code>.

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

SetPlayerNameplateIdVisible - Revision history

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