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

2026-09-09T02:32:24Z

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

New page

= setPlayerTattoo =
<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 a server-owned tattoo preset from the supported catalog, independently of skin color.

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

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>playerId</code> || <code>int</code> || yes || The connected player identifier.
|-
| <code>presetKey</code> || <code>string</code> || yes || A case-insensitive key from <code>getPlayerTattooNames</code>. The key <code>none</code> explicitly removes tattoos; it does not reset the override.
|}

== Returns ==
Returns <code>true</code> when the server accepts the preset; returns <code>false</code> for an unavailable player, unknown key or rejected change.

== Examples ==
Apply a catalog preset, explicitly remove it, or restore defaults:
<syntaxhighlight lang="lua" line>
-- The resource must authorize these changes first.
setPlayerTattoo(playerId, "novice1")
-- Explicitly no tattoo (enabled override):
setPlayerTattoo(playerId, "none")
-- Restore native defaults (disabled override):
resetPlayerTattoo(playerId)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* Alias: <code>SetPlayerTattoo</code>.
* Cosmetic state only: this does not change identity, equipped armor, inventory, HP or other progression statistics.
* Only catalog keys are accepted. Arbitrary texture paths and unknown keys are rejected. Getters return canonical lowercase keys.
* The skin-color override is preserved. <code>none</code> is an enabled no-tattoo override; use <code>resetPlayerTattoo</code>, not <code>default</code>, to restore native defaults.
* Presets contain only their verified head/torso/legs regions. Covered skin and unsupported cooked material permutations may not display a tattoo; catalog acceptance is not a guarantee that every body part or armor combination can show it.
* The server owns the reliable state and replays it on late join and relevance entry; the native client reapplies it after supported visual rebuilds. Acceptance is not confirmation that a client has already rendered the change.
* Resources must implement their own authorization before allowing a player request to call a setter. There is no client mutation packet or arbitrary texture upload API.
* See [[Player customization]] and [[Player tattoo catalog]].

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

SetPlayerTattoo - Revision history

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