Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:41Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Tome}}
Returns the tactic unlocked by a Tome of Knowledge tactic counter, and whether the player has unlocked it.

<pre>
tacticData = TomeGetTacticCounterRewardData(rewardId)
</pre>

== Arguments ==
;rewardId : <code>number</code> – Reward id, as in the <code>rewards</code> list from [[API:TomeGetTacticCounter|TomeGetTacticCounter]].

== Returns ==
;tacticData : <code>table</code> – An [[API:GetAbilityData#Ability data table|ability data table]] for the tactic, plus the field below. Nothing is returned if the id is unknown or the player is not in the world.

{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>unlocked</code> || <code>boolean</code> || Whether the player has unlocked this tactic.
|}

== Details ==
* Unlike [[API:GetAbilityData|GetAbilityData]], the table has no <code>isActive</code> field.
* No error is logged for an unknown id.
* Exactly one argument must be passed.

== Errors ==
None besides the generic ''Invalid Parameters'' message when the argument is missing or not a number.

== Example ==
From <code>default/ea_tomeofknowledge/source/tomewindow.lua</code>:
<pre>
for index, reward in ipairs( rewards )
do
local tactic = TomeGetTacticCounterRewardData( reward.rewardId )
local tacticText = GetFormatStringFromTable( "Default", StringTables.Default.TOOLTIP_X_REQUIRES_Y_FRAGMENTS, { tactic.name, reward.threshold } )
local texture, x, y = GetIconData( tactic.iconNum )
...
</pre>

From <code>default/ea_interactionwindow/source/interactiontometraining.lua</code>:
<pre>
local tacticData = TomeGetTacticCounterRewardData( advanceData.packageId )
if tacticData ~= nil
then
return tacticData.unlocked and (progress >= advanceData.requiredActionCounterCount)
</pre>

== See also ==
* [[API:TomeGetTacticCounter|TomeGetTacticCounter]]
* [[API:GetAbilityData|GetAbilityData]]
* [[API:TomeGetTacticRewardData|TomeGetTacticRewardData]]

API:TomeGetTacticCounterRewardData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)