View source for API:GetCreditsData

{{LuaApi|group=Pregame}}
Returns the game credits as nested tables of sections, subsections and people.

<pre>
creditsData = GetCreditsData()
</pre>

== Arguments ==
None.

== Returns ==
;creditsData : <code>table</code> – A table with one field, <code>sections</code>.

{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>sections</code> || <code>table</code> || Array of section tables, indexed from 1.
|}

Each section table:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>name</code> || <code>wstring</code> || Section title.
|-
| <code>subsections</code> || <code>table</code> || Array of subsection tables, indexed from 1.
|}

Each subsection table:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>name</code> || <code>wstring</code> || Subsection title. <code>L""</code> when the CSV gives no string id.
|-
| <code>desc</code> || <code>wstring</code> || Subsection description. <code>L""</code> when the CSV gives no string id.
|-
| <code>people</code> || <code>table</code> || Array of person tables, indexed from 1.
|}

Each person table:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>name</code> || <code>wstring</code> || The person's name.
|-
| <code>title</code> || <code>wstring</code> || The person's job title. Only present when the subsection's title string file could be loaded.
|}

== Details ==
* The structure comes from <code>interfacecore/credits/sections.csv</code> and <code>interfacecore/credits/subsections.csv</code>. Each subsections row names a section, string ids for its name and description, a names file, a titles file and the number of people.
* The texts are loaded from the client's credits string files for the current language. The string tables are loaded for the call and unloaded again afterwards.
* The whole table is built from the files on every call.

== Errors ==
None.

== Example ==
From <code>interfacecore/source/creditswindow.lua</code>:
<pre>
local creditsData = GetCreditsData()
for sectionIndex, sectionData in ipairs( creditsData.sections )
do
    LabelSetText( sectionWindowName, wstring.upper( sectionData.name )  )
    for subSectionIndex, subSectionData in ipairs( sectionData.subsections )
    do
        local namesText = L""
        local titlesText = L""
        for _, personData in ipairs( subSectionData.people )
        do
            namesText = namesText..L"\n"..personData.name
            if( personData.title )
            then
                titlesText = titlesText..L"\n"..personData.title
            end
        end
        -- ...
</pre>
(Window creation lines left out.)

== See also ==
* [[API:LoadStringTable|LoadStringTable]]
* [[API:BuildTableFromCSV|BuildTableFromCSV]]