API:TomeGetTacticRewardData
From RoR Wiki
UI Lua API · Tome functions
Version: WAR 1.4.8
Returns the tactic behind a Tome of Knowledge tactic reward, and where in the Tome it is unlocked.
tacticData = TomeGetTacticRewardData(rewardId)
Arguments
- rewardId
number– Reward id: therewardIdof a reward with typeGameData.Tome.REWARD_ABILITY, or of an entry from TomeGetTacticRewardsList.
Returns
- tacticData
table– Always a table (possibly empty) when the argument is a number.
| Key | Type | Meaning |
|---|---|---|
rewardId |
number |
The reward id that was passed in. |
name |
wstring |
Name of the tactic. If no name is available, Tactic # followed by a number.
|
| ability fields | various | The tactic's ability data, in the same layout as other ability tables (for example iconNum, which the stock UI reads).
|
unlockInfo |
table |
Where the reward is unlocked: section (number), entry (number), name (wstring), text (wstring), as in TomeGetItemRewardData. Empty when the reward has no unlocking entry.
|
Details
- When there is no local player, the table stays empty.
- If the id is not a valid tactic reward, an error is logged and an empty table is returned. The error message carries the name
TomeGetPlayerTacticRewardData.
Errors
These are written to the UI log; the call returns normally.
Error in function call 'TomeGetPlayerTacticRewardData': %d is not a valid tactic reward id.
Example
From ea_tomeofknowledge/source/tomewindow.lua:
local tacticData = TomeGetTacticRewardData( rewardData.rewardId ) iconNum = tacticData.iconNum