Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:47:14Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Module}}
Adds a saved variable to a UI module at run time, as if it were listed in the module's <code>.mod</code> file.

<pre>
ModuleAddSavedVariable(moduleName, variableName, flag)
</pre>

== Arguments ==
;moduleName : <code>string</code> – The module's name, as in the <code>name</code> field of [[API:ModulesGetData|ModulesGetData]].
;variableName : <code>string</code> – Name of the Lua variable to save, for example <code>"MyAddon.Settings"</code>.
;flag : <code>boolean</code> – Selects which of the module's two saved-variable lists the name is added to. See [[#Details|Details]].

== Returns ==
Nothing.

== Details ==
* A module keeps two lists of saved variables. <code>flag = false</code> adds the name to the first list, <code>true</code> to the second. The name is refused if it is already in either list. The client also uses this routine for the <code><SavedVariable></code> names of the <code>.mod</code> file. Which list is saved where could not be confirmed.
* The change is accepted only while the module is initialized or being initialized (from the moment its initialization starts). For a module that has not started initializing, the ''is not loaded'' error is logged. Its wording ("You may not modify the SavedVariables on a Module that is initialized") is the opposite of what the check does.
* <code>flag</code> must be a real boolean. Passing <code>nil</code> or a number raises an ''Invalid Parameters'' error.
* The function needs at least three arguments and only reads the last three.
* The stock UI never calls <code>ModuleAddSavedVariable</code>; stock modules list their saved variables in their <code>.mod</code> files.

== Errors ==
These are written to the UI log; the call returns normally.
* <code>Error in function call 'ModuleAddSavedVariable': %s is not a valid UiMod name.</code>
* <code>Error in function call 'ModuleAddSavedVariable': %s is not loaded. You may not modify the SavedVariables on a Module that is initialized.</code>
* <code>Error in function call 'ModuleAddSavedVariable': %s already has '%s' registered as a saved variable.</code>

== Example ==
A minimal example built from the signature above:
<pre>
ModuleAddSavedVariable( "MyAddon", "MyAddon.Settings", false )
</pre>

== See also ==
* [[API:ModuleRemoveSavedVariable|ModuleRemoveSavedVariable]]
* [[API:ModulesSaveSettings|ModulesSaveSettings]]
* [[API:ModulesGetData|ModulesGetData]]

API:ModuleAddSavedVariable - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)