https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ATomeGetAchievementsTOC
API:TomeGetAchievementsTOC - Revision history
2026-10-30T19:51:44Z
Revision history for this page on the wiki
MediaWiki 1.43.11
https://wiki.returnofreckoning.com/index.php?title=API:TomeGetAchievementsTOC&diff=30797&oldid=prev
Maintenance script: UI Lua API import (WAR 1.4.8)
2026-10-16T19:50:16Z
<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Tome}}<br />
Returns the table of contents of the Tome of Knowledge achievements section: every achievement type with its subtypes.<br />
<br />
<pre><br />
types = TomeGetAchievementsTOC()<br />
</pre><br />
<br />
== Arguments ==<br />
None.<br />
<br />
== Returns ==<br />
;types : <code>table</code> – Array of achievement types. The stock UI sorts the subtypes by name itself.<br />
<br />
Each type table:<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>id</code> || <code>number</code> || Type id.<br />
|-<br />
| <code>name</code> || <code>wstring</code> || Type name.<br />
|-<br />
| <code>subtypes</code> || <code>table</code> || Array of the type's subtypes (see below).<br />
|}<br />
<br />
Each subtype table in <code>subtypes</code>:<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>id</code> || <code>number</code> || Subtype id, as used by [[API:TomeGetAchievementsSubTypeData|TomeGetAchievementsSubTypeData]]. <code>0</code> for a locked subtype.<br />
|-<br />
| <code>name</code> || <code>wstring</code> || Subtype name. <code>L"???"</code> for a locked subtype.<br />
|-<br />
| <code>isUnlocked</code> || <code>boolean</code> || Whether the subtype is unlocked (see [[API:TomeIsAchievementsSubTypeUnlocked|TomeIsAchievementsSubTypeUnlocked]]).<br />
|-<br />
| <code>numUnlocks</code> || <code>number</code> || Number of unlocked entries in the subtype.<br />
|}<br />
<br />
== Details ==<br />
* All types and subtypes are listed, including locked ones.<br />
* If the name tables are not loaded, names are empty wide strings.<br />
<br />
== Errors ==<br />
None.<br />
<br />
== Example ==<br />
From <code>default/ea_tomeofknowledge/source/tomewindow_achievements.lua</code>:<br />
<pre><br />
TomeWindow.Achievements.TOCData = TomeGetAchievementsTOC()<br />
...<br />
for subTypeIndex, subTypeData in ipairs( typeData.subtypes ) do<br />
...<br />
local killText = L""..subTypeData.numUnlocks<br />
TomeWindow.SetTOCItemText( subTypeWindowName, subTypeData.id, subTypeData.name, killText )<br />
ButtonSetDisabledFlag( subTypeWindowName.."Text", subTypeData.isUnlocked == false )<br />
end<br />
</pre><br />
<br />
== See also ==<br />
* [[API:TomeGetAchievementsSubTypeData|TomeGetAchievementsSubTypeData]]<br />
* [[API:TomeIsAchievementsSubTypeUnlocked|TomeIsAchievementsSubTypeUnlocked]]<br />
* [[API:TomeGetAchievementsEntryData|TomeGetAchievementsEntryData]]</div>
Maintenance script