Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:57Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Tome}}
Asks the server to make a title the player's displayed title, or to clear it.

<pre>
TomeSetActivePlayerTitle(titleId)
</pre>

== Arguments ==
;titleId : <code>number</code> – Id of an unlocked title, or <code>0</code> to show no title.

== Returns ==
Nothing.

== Details ==
* The title must exist and be unlocked; otherwise an error is logged and nothing is sent.
* The client sends the request to the server. The current title is published in <code>GameData.Player.activeTitle</code>, which the stock UI reads.
* <code>0</code> always clears the title.

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

== Example ==
From <code>ea_tomeofknowledge/source/tomewindow_rewards.lua</code>, choosing a title from the list (the entry windows' ids are title ids):
<pre>
local windowId = WindowGetId( SystemData.ActiveWindow.name )

if( TomeWindow.Rewards.currentState == STATE_TITLES )
then
TomeSetActivePlayerTitle( windowId )
end
</pre>

Clearing the title, from the same file:
<pre>
if( GameData.Player.activeTitle ~= 0 )
then
TomeSetActivePlayerTitle( 0 )
end
</pre>

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

API:TomeSetActivePlayerTitle - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)