Changes: API EJ GetEncounterInfo

Revision as of 13:47, 14 October 2021

Returns encounter info from the journal.

name, description, journalEncounterID, rootSectionID, link, journalInstanceID, dungeonEncounterID, instanceID
   = EJ_GetEncounterInfo(journalEncounterID)
   = EJ_GetEncounterInfoByIndex(index [, instanceID])

Arguments

EJ_GetEncounterInfo

journalEncounterID: number : JournalEncounterID

EJ_GetEncounterInfoByIndex

index: number
instanceID: number? : JournalInstance.ID - If omitted, defaults to the currently selected instance from EJ_SelectInstance()

Returns

name: string
description: string
journalEncounterID: number : JournalEncounterID - IDs for the Encounter Journal
rootSectionID: number : JournalEncounterSection.ID - The first section article that describes the boss abilities
link: string : journalLink
journalInstanceID: number : JournalInstance.ID - The dungeon instance as used by the Encounter Journal
dungeonEncounterID: number : DungeonEncounterID - IDs from ENCOUNTER_START
instanceID: number : InstanceID - The map instance

Example

/dump EJ_GetEncounterInfo(95)

[1] = "Vanessa VanCleef", -- name
[2] = "As a young girl, Vanessa witnessed the gruesome death of her father and former Defias Brotherhood leader, Edwin VanCleef. She has since taken up his mantle of leadership, plotting to exact vengeance on Stormwind from the dark corridors of the Defias's stronghold in the Deadmines.", -- description
[3] = 95,    -- journalEncounterID
[4] = 2060,  -- rootSectionID
[5] = "|cff66bbff|Hjournal:1:95:0|h[Vanessa VanCleef]|h|r", -- link 
[6] = 63,    -- journalInstanceID
[7] = 1081,  -- dungeonEncounterID
[8] = 36     -- instanceID

Patch changes

Patch 4.2.0 (2011-06-28): Added.

@@ Line 1: / Line 1: @@
 {{wowapi}}
-Returns Encounter info.
+Returns encounter info from the journal.
- name, description, encounterID, rootSectionID, link, instanceID = EJ_GetEncounterInfo(encounterID)
+ name, description, journalEncounterID, rootSectionID, link, journalInstanceID, dungeonEncounterID, instanceID
+    = EJ_GetEncounterInfo(journalEncounterID)
+    = EJ_GetEncounterInfoByIndex(index [, instanceID])
-== Arguments ==
+==Arguments==
+===<font color="#4ec9b0">EJ_GetEncounterInfo</font>===
-;encounterID : number
+:;journalEncounterID : <span class="apitype">number</span> : [[JournalEncounterID]]
+===<font color="#4ec9b0">EJ_GetEncounterInfoByIndex</font>===
+:;index : <span class="apitype">number</span>
+:;instanceID : <span title="optional"><span class="apitype">number</span>?</span> : [https://wow.tools/dbc/?dbc=journalinstance JournalInstance.ID] - If omitted, defaults to the currently selected instance from {{api|EJ_SelectInstance}}()
-== Returns ==
+==Returns==
-;name : string
+;name : <span class="apitype">string</span>
-;description : string
+;description : <span class="apitype">string</span>
+;journalEncounterID : <span class="apitype">number</span> : [[JournalEncounterID]] - IDs for the Encounter Journal
-;[[EncounterId|encounterID]] : number
+;rootSectionID : <span class="apitype">number</span> : [https://wow.tools/dbc/?dbc=journalencountersection JournalEncounterSection.ID] - The first section article that describes the boss abilities
-;[[EncounterSectionId|rootSectionID]] : number - first abilities section ID.
-;link : String - [[UI_escape_sequences|Encounter Journal link]].
+;link : <span class="apitype">string</span> : [[UI_escape_sequences#journal|journalLink]]
+;journalInstanceID : <span class="apitype">number</span> : [https://wow.tools/dbc/?dbc=journalinstance JournalInstance.ID] - The dungeon instance as used by the Encounter Journal
-;[[EncounterInstanceId|instanceID]] : number
+;dungeonEncounterID : <span class="apitype">number</span> : [[DungeonEncounterID]] - IDs from [[ENCOUNTER_START]]
+;instanceID : <span class="apitype">number</span> : [[InstanceID]] - The map instance
-== See also ==
+==Example==
+ /dump EJ_GetEncounterInfo(95)
-* {{api|EJ_GetEncounterInfoByIndex}}
+<syntaxhighlight lang="lua">
+[1] = "Vanessa VanCleef", -- name
+[2] = "As a young girl, Vanessa witnessed the gruesome death of her father and former Defias Brotherhood leader, Edwin VanCleef. She has since taken up his mantle of leadership, plotting to exact vengeance on Stormwind from the dark corridors of the Defias's stronghold in the Deadmines.", -- description
+[3] = 95,    -- journalEncounterID
+[4] = 2060,  -- rootSectionID
+[5] = "|cff66bbff|Hjournal:1:95:0|h[Vanessa VanCleef]|h|r", -- link
+[6] = 63,    -- journalInstanceID
+[7] = 1081,  -- dungeonEncounterID
+[8] = 36     -- instanceID
+</syntaxhighlight>
+==Patch changes==
+* {{Patch 4.2.0|note=Added.}}