https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3AModuleLoadAPI:ModuleLoad - Revision history2026-10-17T16:47:38ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:ModuleLoad&diff=30607&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:47:16Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Module}}<br />
Loads the definition of a single UI module from its <code>.mod</code> file.<br />
<br />
<pre><br />
ModuleLoad(modFilePath, moduleType, allowLooseFiles)<br />
</pre><br />
<br />
== Arguments ==<br />
;modFilePath : <code>wstring</code> – Path of the <code>.mod</code> file. It must be a wide string (<code>L"..."</code>).<br />
;moduleType : <code>number</code> – A <code>SystemData.UiModuleType</code> value from 1 to 5 (<code>PREGAME</code>, <code>DEFAULT_INGAME</code>, <code>CUSTOM_INGAME</code>, <code>MYTHIC_APPROVED_ADDON</code>, <code>USER_ADDON</code>).<br />
;allowLooseFiles : <code>boolean</code> – <code>false</code>: the file must be inside the game archives. <code>true</code>: the client first looks for the file on disk and then in the archives.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* The module is only registered with the client. Its files are not run yet. Call [[API:ModulesInitializeAllEnabled|ModulesInitializeAllEnabled]] or [[API:ModuleInitialize|ModuleInitialize]] afterwards.<br />
* The module type is stored with the module and reported as <code>moduleType</code> by [[API:ModulesGetData|ModulesGetData]].<br />
* <code>allowLooseFiles</code> is also passed on to the loader. The stock UI passes <code>IsInternalBuild()</code>, which is always <code>false</code>.<br />
* <code>allowLooseFiles</code> must be a real boolean, and <code>modFilePath</code> a wide string, or an ''Invalid Parameters'' error is raised.<br />
<br />
== Errors ==<br />
These are written to the UI log; the call returns normally.<br />
* <code>Error in function call 'ModuleLoad': file %ls does not exist.</code><br />
* <code>Error in function call 'ModuleLoad': Module Type %d is invalid.</code><br />
<br />
== Example ==<br />
Loading the pregame modules one by one, from <code>interfacecore/interfacecore.lua</code>:<br />
<pre><br />
for _, modFilePath in ipairs( PREGAME_MODS )<br />
do<br />
ModuleLoad( modFilePath, SystemData.UiModuleType.PREGAME, IsInternalBuild() )<br />
end<br />
<br />
ModulesInitializeAllEnabled()<br />
</pre><br />
<br />
== See also ==<br />
* [[API:ModulesLoadFromDirectory|ModulesLoadFromDirectory]]<br />
* [[API:ModulesLoadFromListFile|ModulesLoadFromListFile]]<br />
* [[API:ModulesInitializeAllEnabled|ModulesInitializeAllEnabled]]<br />
* [[API:ModuleInitialize|ModuleInitialize]]</div>Maintenance script