View source for API:EA Window HelpGetTopicList

{{LuaApi|group=Help}}
Returns the topic tree of the in-game manual.

<pre>
topics = EA_Window_HelpGetTopicList()
</pre>

== Arguments ==
None.

== Returns ==
;topics : <code>table</code> – Array of top-level entries, indexed from 1.

Each entry is a table with these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Entry id. Pass it to [[API:EA_Window_HelpGetEntryData|EA_Window_HelpGetEntryData]] to get the entry's text.
|-
| <code>parentEntryId</code> || <code>number</code> || Id of the parent entry.
|-
| <code>name</code> || <code>wstring</code> || Title of the entry. Missing if the client's manual name list is not loaded.
|-
| <code>expanded</code> || <code>boolean</code> || Always <code>false</code>. The stock UI uses the field to remember which entries are open.
|-
| <code>childEntries</code> || <code>table</code> || Array of the child entries, indexed from 1, each with the same fields. Empty if the entry has no children.
|}

== Details ==
* The client loads its manual data the first time it is needed.* The names come from the client's <code>game_manual_entry_names</code> data list, indexed by entry id.
* A new table is built on every call. The stock manual window calls it once and keeps the result.
* Arguments are not checked; anything passed is ignored.

== Errors ==
None.

== Example ==
From <code>ea_helpwindow/source/manualwindow.lua</code>:
<pre>
-- lazy load the manual data as this window is almost never opened
if not ManualWindow.data
then
    ManualWindow.data = EA_Window_HelpGetTopicList()
</pre>

Walking the tree, from the same file:
<pre>
local function AddEntryAsRow(entryIndex, entryData, depth)
    local entryTable = {name = entryData.name, depth = depth}
    ...
    if entryData.expanded
    then
        -- entry is expanded so add children as rows, recursively
        for childEntryIndex, childEntryData in ipairs( entryData.childEntries ) do
            AddEntryAsRow(childEntryIndex, childEntryData, depth+1)
        end
    end
end

for entryIndex, entryData in ipairs( ManualWindow.data ) do
    AddEntryAsRow(entryIndex, entryData, 0)
end
</pre>

== See also ==
* [[API:EA_Window_HelpGetEntryData|EA_Window_HelpGetEntryData]]
* [[API:EA_Window_HelpGetFAQTopicList|EA_Window_HelpGetFAQTopicList]]
* [[API:EA_Window_HelpGetHelpTipsList|EA_Window_HelpGetHelpTipsList]]