View source for API:ModulesLoadFromListFile

{{LuaApi|group=Module}}
Loads the definitions of the UI modules listed in a text file.

<pre>
ModulesLoadFromListFile(listFilePath, moduleType, allowLooseFiles)
</pre>

== Arguments ==
;listFilePath : <code>wstring</code> – Path of the list file. It must be a wide string (<code>L"..."</code>).
;moduleType : <code>number</code> – A <code>SystemData.UiModuleType</code> value from 1 to 5. Every listed module is given this type.
;allowLooseFiles : <code>boolean</code> – <code>false</code>: the list file must be inside the game archives. <code>true</code>: the client first looks for it on disk and then in the archives.

== Returns ==
Nothing.

== Details ==
* The stock list file <code>interface/default/EADefaultMods.txt</code> contains one <code>.mod</code> path per line, for example <code>interface/default\EASystem_DialogManager\EASystem_DialogManager.mod</code>.
* The modules are only registered with the client. Call [[API:ModulesInitializeAllEnabled|ModulesInitializeAllEnabled]] afterwards to run them.
* <code>allowLooseFiles</code> is also passed on to the loader. The stock UI passes <code>IsInternalBuild()</code>, which is always <code>false</code>.
* <code>allowLooseFiles</code> must be a real boolean, and <code>listFilePath</code> a wide string, or an ''Invalid Parameters'' error is raised.

== Errors ==
These are written to the UI log; the call returns normally.
* <code>Error in function call 'ModulesLoadFromListFile': file %ls does not exist.</code>
* <code>Error in function call 'ModulesLoadFromListFile': Module Type %d is invalid.</code>

== Example ==
From <code>interfacecore/interfacecore.lua</code>:
<pre>
ModulesLoadFromListFile( SystemData.Directories.DefaultInterface..L"/EADefaultMods.txt", SystemData.UiModuleType.DEFAULT_INGAME, IsInternalBuild() )
ModulesLoadFromListFile( L"interface/MythicApprovedAddOns/MythicApprovedMods.txt", SystemData.UiModuleType.MYTHIC_APPROVED_ADDON, IsInternalBuild() )
</pre>

== See also ==
* [[API:ModulesLoadFromDirectory|ModulesLoadFromDirectory]]
* [[API:ModuleLoad|ModuleLoad]]
* [[API:ModulesInitializeAllEnabled|ModulesInitializeAllEnabled]]