Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:47:53Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Pregame}}
Sets one appearance feature of the character being created on the character creation screen.

<pre>
PregameSetFeature(featureType, featureValue)
</pre>

== Arguments ==
;featureType : <code>number</code> – Index of the feature, starting at 1. This is the index into the feature table that <code>CHARACTER_CREATE_FEATURES_UPDATED</code> delivers.
;featureValue : <code>number</code> – The value to use for that feature, one of the values listed in that feature's table. It is stored as a single byte (0–255).

== Returns ==
Nothing.

== Details ==
* The call only works in the pregame state while the character creation data is set up. At any other time it does nothing.
* The value is applied to the preview character, which is then redrawn with its new appearance.
* Afterwards the client fires <code>SystemData.Events.CHARACTER_CREATE_FEATURES_UPDATED</code> with the updated feature table. The stock handler is <code>CharacterSelectWindow.FeaturesUpdated(featuresData)</code>, which reads <code>featuresData[featureType]</code> as a list of allowed values plus <code>curValue</code>, the current one.
* The function needs at least two arguments and only reads the last two.

== Errors ==
None besides the generic ''Invalid Parameters'' message when an argument is not a number.

== Example ==
Stepping to the next allowed value, from <code>interfacecore/source/characterselectwindow.lua</code>:
<pre>
function CharacterSelectWindow.NextFeature()
local featureType = WindowGetId( WindowGetParent( SystemData.ActiveWindow.name ) )
local featureData = CharacterSelectWindow.featuresData[featureType]

local curValue = CharacterSelectWindow.FindFeatureCurrentValue( featureData )
local featureValue = featureData[curValue + 1]
if ( featureValue == nil )
then
featureValue = featureData[1]
end

PregameSetFeature( featureType, featureValue )
end
</pre>

== See also ==
* [[API:PregameRandomFeatures|PregameRandomFeatures]]
* [[API:BarbershopSetFeature|BarbershopSetFeature]]

API:PregameSetFeature - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)