Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:35Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Tome}}
Returns the data of a player title: its display name, description and where it is unlocked.

<pre>
titleData = TomeGetPlayerTitleData(titleId)
</pre>

== Arguments ==
;titleId : <code>number</code> – Title id, for example <code>GameData.Player.activeTitle</code> or an <code>id</code> from [[API:TomeGetPlayerTitlesTypeData|TomeGetPlayerTitlesTypeData]].

== Returns ==
;titleData : <code>table</code> – The title's data. Empty if the title is locked or the id is invalid.

{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Title id.
|-
| <code>name</code> || <code>wstring</code> || The title as displayed, with the player's name filled in. If no name is available, <code>Title #</code> followed by a number.
|-
| <code>text</code> || <code>wstring</code> || Description of the title.
|-
| <code>type</code> || <code>number</code> || A number stored with the title.
|-
| <code>unlockInfo</code> || <code>table</code> || Where the title is unlocked: <code>section</code> (<code>number</code>), <code>entry</code> (<code>number</code>), <code>name</code> (<code>wstring</code>), <code>text</code> (<code>wstring</code>). <code>section</code> and <code>entry</code> are <code>0</code> when there is no unlocking entry.
|}

== Details ==
* For a title the player has not unlocked, the returned table is empty. The stock UI checks <code>titleData.name ~= nil</code>.
* If the id is unknown, an error is logged and an empty table is returned.

== Errors ==
These are written to the UI log; the call returns normally.
* <code>Error in function call 'TomeGetPlayerTitleData': %d is not a valid title id.</code>

== Example ==
From <code>ea_tomeofknowledge/source/tomewindow_rewards.lua</code>:
<pre>
local titleId = GameData.Player.activeTitle
if( titleId ~= 0 ) then
local titleData = TomeGetPlayerTitleData( titleId )
if( titleData ) then
titleText = titleData.name
end
end
</pre>

From <code>ea_tomeofknowledge/source/tomewindow.lua</code>:
<pre>
local titleData = TomeGetPlayerTitleData( rewardData.rewardId )
if( titleData.name ~= nil ) then
name = titleData.name
end
</pre>

== See also ==
* [[API:TomeGetPlayerTitlesTypeData|TomeGetPlayerTitlesTypeData]]
* [[API:TomeIsPlayerTitleUnlocked|TomeIsPlayerTitleUnlocked]]
* [[API:TomeSetActivePlayerTitle|TomeSetActivePlayerTitle]]

API:TomeGetPlayerTitleData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)