Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:44:46Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Appearance}}
Returns the player character's appearance variation values.

<pre>
variations = GetPlayerVariation()
</pre>

== Arguments ==
None.

== Returns ==
;variations : <code>table</code> – A table with the field below, plus one entry per variation slot, indexed from 1.

{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>maxVariations</code> || <code>number</code> || Number of variation slots the player's model has. The array part has this many entries.
|-
| <code>[1]</code> … <code>[maxVariations]</code> || <code>table</code> || One table per slot with a single field, <code>variation</code> (<code>number</code>).
|}

== Details ==
* The <code>variation</code> value of a slot is the value stored in the player's appearance data for that slot. It is 0 when the player's appearance data is marked as not set, and for slot numbers above 15.
* The function returns nothing if there is no player or the player's data is not available.
* [[API:SetPlayerVariation|SetPlayerVariation]] changes these values for a preview.
* The stock UI never calls this function.

== Errors ==
None.

== Example ==
A minimal example built from the return value described above:
<pre>
local variations = GetPlayerVariation()
if ( variations ~= nil )
then
for slot = 1, variations.maxVariations
do
DEBUG( L"slot "..slot..L": "..variations[slot].variation )
end
end
</pre>

== See also ==
* [[API:SetPlayerVariation|SetPlayerVariation]]
* [[API:RevertPlayerVariation|RevertPlayerVariation]]
* [[API:ApplyPlayerVariation|ApplyPlayerVariation]]

API:GetPlayerVariation - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)