ResetPlayerNameplateText: Difference between revisions
Jump to navigation
Jump to search
Document Protocol 23 voice and player presentation APIs |
Document universal per-observer nameplates and test resource available from update 0.1.3 |
||
| Line 1: | Line 1: | ||
= resetPlayerNameplateText = | = resetPlayerNameplateText = | ||
Removes a player's global custom overhead text, restoring the canonical player name as the fallback. | |||
== Syntax == | == Syntax == | ||
| Line 26: | Line 25: | ||
== Notes == | == Notes == | ||
* Available only in server-side resource scripts. | * Available only in server-side resource scripts. | ||
* Does not clear per-observer text overrides or change visibility/ID policy. See [[Observer nameplates]]. | |||
[[Category:Lua Functions]] | [[Category:Lua Functions]] | ||
Latest revision as of 03:08, 9 September 2026
resetPlayerNameplateText
Removes a player's global custom overhead text, restoring the canonical player name as the fallback.
Syntax
bool resetPlayerNameplateText(int playerId)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
playerId |
int |
yes | The connected player identifier. |
Returns
Returns true when the state was reset; otherwise returns false.
Examples
Remove a temporary roleplay label:
resetPlayerNameplateText(playerId)
Notes
- Available only in server-side resource scripts.
- Does not clear per-observer text overrides or change visibility/ID policy. See Observer nameplates.