API:TomeIsWarJournalEntryUnlocked

UI Lua API · Tome functions
Version: WAR 1.4.8

Returns whether the player has unlocked a War Journal entry.

unlocked = TomeIsWarJournalEntryUnlocked(entryId)

Arguments

entryId: number – Entry id.

Returns

unlocked: boolean – true if the entry is unlocked; false if it is locked or the id is unknown.

Details

Unknown ids return false without an error.
The same flag is reported as unlocked in the entries list of TomeGetWarJournalStorylineData.

Errors

None besides the Invalid Parameters argument check.

Example

From ea_tomeofknowledge/source/tomewindow_warjournal.lua:

function TomeWindow.OnShowWarJournalEntry( entryId )
    -- Is the Entry unlocked?
    if( TomeIsWarJournalEntryUnlocked(entryId) ~= true ) then
        return
    end

    local entryData  = TomeGetWarJournalEntryData( entryId )
    ...
end

Return of Reckoning