GetPlayerTattoo

From Wiki G1R-MP G1 Remake Multiplayer
Jump to navigation Jump to search

getPlayerTattoo

AVAILABLE FROM UPDATE 0.1.3
This function is available in G1R:MP 0.1.3 and later. The contract below includes the compatibility guarantees introduced in that update.

Returns the enabled canonical tattoo preset key from server state.

Syntax

string|false getPlayerTattoo(int playerId)

Parameters

Name Type Required Description
playerId int yes The connected player identifier.

Returns

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

Examples

Distinguish an explicit no-tattoo override from native defaults:

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

Notes

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