Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:48:54Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Interface}}
Turns load-order tracking for UI module initialization on or off. With it on, circular-dependency errors include the load order.

<pre>
SetCheckForCircularDependencies(enabled)
</pre>

== Arguments ==
;enabled : <code>boolean</code> – <code>true</code> to track the load order while modules are initialized.

== Returns ==
Nothing.

== Details ==
* The flag is read by [[API:ModulesInitializeAllEnabled|ModulesInitializeAllEnabled]] and [[API:ModuleInitialize|ModuleInitialize]]. When it is set, the client keeps a list of the modules it is currently initializing.
* Circular dependencies are detected either way. The flag only changes the error text: with tracking on, the message <code>Error Loading UiMod %s: Circular Dependency detected with %s. Load Order = %s</code> ends with the chain of module names in parentheses, joined by <code>-></code>. With tracking off it ends with <code>Not Tracked</code>.
* The flag is off when the client starts. [[API:GetCheckForCircularDependencies|GetCheckForCircularDependencies]] returns the current value.
* <code>enabled</code> must be a real boolean. Passing <code>nil</code> or a number raises an ''Invalid Parameters'' error.
* The stock UI never calls this function.

== Errors ==
None besides the ''Invalid Parameters'' argument check.

== Example ==
A minimal example built from the signature:
<pre>
SetCheckForCircularDependencies( true )
ModulesInitializeAllEnabled()
</pre>

== See also ==
* [[API:GetCheckForCircularDependencies|GetCheckForCircularDependencies]]
* [[API:ModulesInitializeAllEnabled|ModulesInitializeAllEnabled]]
* [[API:ModuleInitialize|ModuleInitialize]]

API:SetCheckForCircularDependencies - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)