API:TomeIsWarJournalStorylineUnlocked

UI Lua API · Tome functions
Version: WAR 1.4.8

Returns whether a War Journal storyline is unlocked, that is, whether the player has unlocked at least one of its entries.

unlocked = TomeIsWarJournalStorylineUnlocked(storylineId)

Arguments

storylineId

number – Storyline id.

Returns

unlocked

boolean – true if at least one entry of the storyline is unlocked; false otherwise, or if the id is unknown.

Details

• Unknown ids return false without an error.
• TomeGetWarJournalAvailiableStorylines lists exactly the storylines for which this is true, and TomeGetWarJournalStorylineData refuses the others.

Errors

None besides the Invalid Parameters argument check.

Example

From ea_tomeofknowledge/source/tomewindow_warjournal.lua:

-- Is the storyline unlocked?
if( TomeIsWarJournalStorylineUnlocked(id) ~= true ) then
    return
end

See also

• TomeGetWarJournalStorylineData
• TomeGetWarJournalAvailiableStorylines
• TomeIsWarJournalEntryUnlocked