C_EncounterJournal
namespaceavailable in: camelotStatus in wowlua
22 functions: 0 implemented, 1 recorded, 21 guessed. 3 events, 0 of them fired by the emulator on its own.
Functions
| function | what it does | status |
|---|---|---|
GetBaseDifficultyID | Returns the base difficulty ID that the given difficulty ID belongs to. · by wowlua(difficultyID: number): number | guessed |
GetDungeonEntrancesForMap | Returns the instance entrances for a map; including raid instances.(uiMapID: number): DungeonEntranceMapInfo[] | recorded |
GetEncounterJournalLink | Returns a chat link to an Encounter Journal entry. · by wowlua(linkType: JournalLinkTypes, ID: number, displayText: string, difficultyID: number): string | guessed |
GetEncountersOnMap | Returns boss pin locations for an instance map.(uiMapID: number): EncounterJournalMapEncounterInfo[] | guessed |
GetInstanceForGameMap | GameMap as opposed to UIMap since we use a mapID not a uiMapID.(mapID: number): number? | guessed |
GetLootInfo | Returns info for loot items available from an encounter.(id: number): EncounterJournalItemInfo | guessed |
GetLootInfoByIndex | Returns info for loot items available from an encounter.(index: number, encounterIndex: number?): EncounterJournalItemInfo? | guessed |
GetSectionIconFlags | Returns the icon flags for a section, such as Magic Effect and Heroic Difficulty(sectionID: number): number[]? | guessed |
GetSectionInfo | Returns information about an entry in the Abilities section of the Encounter Journal.(sectionID: number): EncounterJournalSectionInfo? | guessed |
GetSlotFilter | Returns the current item slot filter for loot items.(): ItemSlotFilterType | guessed |
InitalizeSelectedTier | Sets the Encounter Journal's selected tier to its initial value. · by wowlua() | guessed |
InstanceHasDifficultyID | Whether the Encounter Journal's selected instance has the given difficulty. · by wowlua(difficultyID: number): boolean | guessed |
InstanceHasLoot | Returns whether an instance has a loot table in the journal.(instanceID: number?): boolean | guessed |
IsEncounterComplete | Returns if a boss encounter has been completed.(journalEncounterID: number): boolean | guessed |
OnClose | Tells the game that the Encounter Journal was closed. · by wowlua() | guessed |
OnOpen | Tells the game that the Encounter Journal was opened. · by wowlua() | guessed |
ResetSlotFilter | Resets the item slot filter for loot items.() | guessed |
SetPreviewMythicPlusLevel | Sets the Mythic+ keystone level the Encounter Journal previews loot for. · by wowlua(level: number) | guessed |
SetPreviewPvpTier | Sets the PvP tier the Encounter Journal previews rewards for. · by wowlua(tier: number) | guessed |
SetSlotFilter | Sets the item slot filter for loot items.(filterSlot: ItemSlotFilterType) | guessed |
SetTab | Sets the Encounter Journal's selected tab. · by wowlua(tabIdx: number) | guessed |
StartArathiRPE | Called from the Tutorials tab of the Adventure Guide to start the Catch Up Experience set in the Arathi Highlands.() | guessed |
"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.
Events
| event | payload | fired by the emulator |
|---|---|---|
EJ_DIFFICULTY_UPDATE | difficultyID: number | not implemented |
EJ_LOOT_DATA_RECIEVED | itemID: number? | not implemented |
SHOW_JOURNEYS_UI | factionID: number | not implemented |
An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("EJ_DIFFICULTY_UPDATE").
Structures
DungeonEntranceMapInfo· areaPoiID, position, name, description, atlasName, journalInstanceIDEncounterJournalItemInfo· itemID, encounterID?, name?, itemQuality?, filterType?, icon?, slot?, armorType?, link?, handError?, weaponTypeError?, displayAsPerPlayerLoot?, displayAsVeryRare?, displayAsExtremelyRare?, displaySeasonID?EncounterJournalMapEncounterInfo· encounterID, mapX, mapYEncounterJournalSectionInfo· spellID, title, description?, headerType, abilityIcon, creatureDisplayID, uiModelSceneID, siblingSectionID?, firstChildSectionID?, filteredByDifficulty, link, startsOpen
sources
Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (EncounterJournal system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.