QCherry: Document skin color and tattoos available from 0.1.3; identity/armor improvements

2026-09-09T02:32:26Z

Document skin color and tattoos available from 0.1.3; identity/armor improvements

New page

= getPlayerTattoo =
<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>

Returns the enabled canonical tattoo preset key from server state.

== Syntax ==
<syntaxhighlight lang="lua">
string|false getPlayerTattoo(int playerId)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player identifier.
|}

== Returns ==
Returns a canonical lowercase catalog key, including <code>"none"</code> for explicit removal, or <code>false</code> if the override is disabled or the player/state is unavailable.

== Examples ==
Distinguish an explicit no-tattoo override from native defaults:
<syntaxhighlight lang="lua" line>
local preset = getPlayerTattoo(playerId)
if preset == "none" then
outputDebugString("Tattoos explicitly removed.")
elseif preset then
outputDebugString("Tattoo preset: " .. preset)
else
outputDebugString("No enabled tattoo override, or player unavailable.")
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Alias: <code>GetPlayerTattoo</code>.
* Read-only canonical state, not a rendering acknowledgement. This does not inspect tattoos already contained in native material defaults.
* Use <code>resetPlayerTattoo</code> to disable the override; <code>none</code> is a real enabled preset. Skin color is independent.
* The getter remains queryable during <code>onPlayerQuit</code> so resource persistence can capture the final state.
* See [[Player customization]] and [[Player tattoo catalog]].

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

GetPlayerTattoo - Revision history

QCherry: Document skin color and tattoos available from 0.1.3; identity/armor improvements