View source for API:ModulesGetData

{{LuaApi|group=Module}}
Returns information about every UI module (addon) the client has loaded.

<pre>
modules = ModulesGetData()
</pre>

== Arguments ==
None.

== Returns ==
;modules : <code>table</code> – An array with one table per loaded module, in the client's module order. Empty if no module has been loaded.

Each module table has these fields, filled by the client:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>wideStrName</code> || <code>wstring</code> || The module's name, for display.
|-
| <code>moduleType</code> || <code>number</code> || The <code>SystemData.UiModuleType</code> the module was loaded with (1–5).
|-
| <code>loadStatus</code> || <code>number</code> || A <code>SystemData.UiModuleLoadStatus</code> value: not loaded, replaced, loading dependencies, one of the failure states, or succeeded with or without errors.
|-
| <code>isEnabled</code> || <code>boolean</code> || The enabled flag (see [[API:ModuleSetEnabled|ModuleSetEnabled]]).
|-
| <code>isForCurrentGameVersion</code> || <code>boolean</code> || Whether the game version in the module's <code>.mod</code> file matches the client's.
|-
| <code>isAutoDisabledOnGameVersionMismatch</code> || <code>boolean</code> || Whether the module is turned off automatically when the versions do not match.
|-
| <code>replacedByModuleName</code> || <code>string</code> || Name of the module that replaced this one, when <code>loadStatus</code> is <code>REPLACED</code>.
|-
| <code>categories</code> || <code>table</code> || Array of category numbers from the <code>.mod</code> file.
|-
| <code>careers</code> || <code>table</code> || Array of career-line numbers from the <code>.mod</code> file.
|}

The table also contains the data from the module's <code>.mod</code> file. The keys the client writes are <code>name</code>, <code>version</code>, <code>date</code>, <code>autoenabled</code>, <code>f2pusable</code>, <code>replaces</code>, <code>author</code>, <code>description</code>, <code>warinfo</code>, <code>dependencies</code>, <code>files</code>, <code>oninitialize</code>, <code>onupdate</code>, <code>onshutdown</code>, <code>onmessage</code>, <code>versionsettings</code> and <code>savedvariables</code>. The stock UI reads these of them:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>name</code> || <code>string</code> || The module's name. This is the name [[API:ModuleSetEnabled|ModuleSetEnabled]] and [[API:ModuleInitialize|ModuleInitialize]] expect.
|-
| <code>version</code> || <code>string</code> || The module's version.
|-
| <code>author.name</code> || <code>string</code> || The author's name (<code>author</code> is a table).
|-
| <code>description.text</code> || <code>string</code> || The description (<code>description</code> is a table).
|-
| <code>versionsettings.gameVersion</code> || <code>string</code> || The game version the module was made for.
|-
| <code>dependencies</code> || <code>table</code> || Array of dependency tables; <code>dependencies[i].name</code> is the name of the required module.
|}

== Details ==
* The data is a snapshot. Changing a field in the returned table (the stock UI does this with <code>isEnabled</code>) does not change the module; use [[API:ModuleSetEnabled|ModuleSetEnabled]].
* Text from the <code>.mod</code> file is returned as ordinary strings; the stock UI converts it with <code>StringToWString</code> before display.

== Errors ==
None.

== Example ==
From <code>ea_uimodwindow/source/uimodwindow.lua</code>:
<pre>
UiModWindow.modsListData = ModulesGetData()

for modIndex, modData in ipairs( UiModWindow.modsListData )
do
    modData.modIndex = modIndex
    for _, category in ipairs( modData.categories )
    do
        ...
    end
end
</pre>

Reading the details of one module, also from <code>ea_uimodwindow/source/uimodwindow.lua</code>:
<pre>
LabelSetText( windowName.."ScrollChildName", modData.wideStrName )
...
local version = StringToWString( modData.version )
</pre>

== See also ==
* [[API:ModuleSetEnabled|ModuleSetEnabled]]
* [[API:ModuleInitialize|ModuleInitialize]]
* [[API:ModulesLoadFromDirectory|ModulesLoadFromDirectory]]