Skip to content

Return of Reckoning

Wiki

RoR Wiki

API:TomeGetWarJournalAvailiableStorylines

From RoR Wiki

UI Lua API · Tome functions
Version: WAR 1.4.8

Returns the War Journal storylines the player has unlocked.

storylines = TomeGetWarJournalAvailiableStorylines()

The name is spelled Availiable in the client.

Arguments

None.

Returns

storylines
table – Array of unlocked storylines; empty if there are none.

Each entry:

Key Type Meaning
id number Storyline id, for TomeGetWarJournalStorylineData.
name wstring Storyline name.

Details

  • A storyline is listed once at least one of its entries is unlocked (see TomeIsWarJournalStorylineUnlocked).
  • If the name table is not loaded, names are empty wide strings.

Errors

None.

Example

From ea_tomeofknowledge/source/tomewindow_warjournal.lua:

TomeWindow.WarJournal.AvailStorylinesTOC = TomeGetWarJournalAvailiableStorylines()
if( TomeWindow.WarJournal.AvailStorylinesTOC == nil ) then
    return
end

-- Sort the Storylines List alphabetically
table.sort( TomeWindow.WarJournal.AvailStorylinesTOC, DataUtils.AlphabetizeByNames )

See also