C_EncounterJournal.GetSectionInfo

Main Menu
WoW API Lua API FrameXML util Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Returns information about an entry in the Abilities section of the Encounter Journal.

info = C_EncounterJournal.GetSectionInfo(sectionID)

Arguments

sectionID

number : JournalEncounterSection.ID

Returns

info

EncounterJournalSectionInfo

Field	Type	Description
spellID	number
title	string	Section title, e.g. "Stage One: The Final Assault", "Mutated Corruption", "Impale"
description	string?	Description text, e.g. "A Mutated Corruption appears shortly after assaulting a platform"
headerType	number	Section depth, i.e. the number of ancestors it has before reaching a sibling of the root section for the encounter (0 for the root section and its siblings, 1 for their children, 2 for their children's children...).
abilityIcon	number	Path to a texture to display as an icon next to the section title, or "" if no static icon should be shown.
creatureDisplayID	number	DisplayID as the icon next to the section title, or 0 if no model-based icon should be shown.
uiModelSceneID	number	ModelSceneID
siblingSectionID	number?	Section ID of the next section on the same depth as this one, nil if none.
firstChildSectionID	number?	Section ID of the first child section of this section, nil if none.
filteredByDifficulty	boolean	True if this section should be hidden because it does not apply to the current DifficultyID}, false otherwise.
link	string	journalLink to this section, e.g. " |cff66bbff|Hjournal:2:4102:4|h[Cataclysm]|h|r".
startsOpen	boolean	True if the section should be expanded by default, false if it should be collapsed by default.

Details

• EJ_GetEncounterInfo() returns the rootSectionID for a given encounter: the first Ability section to display. Subsequent sections can be navigated through the siblingSectionID and firstChildSectionID return values of this function.
• The returned link is affected by the current difficulty; this function can return invalid difficulty/section combinations. If you attempt to send one of those links in a chat message, it will be filtered by the server.

Example

The following snippet prints links to all sections of a given encounter in the Encounter Journal.

function PrintAllEncounterSections(encounterID, difficultyID)
	EJ_SetDifficulty(difficultyID)
	local stack, encounter, _, _, curSectionID = {}, EJ_GetEncounterInfo(encounterID)
	print(encounter.." abilities:")
	
	repeat
		local info = C_EncounterJournal.GetSectionInfo(curSectionID)
		if not info.filteredByDifficulty then
			print(("  "):rep(info.headerType)..info.link.. ": "..info.description)
		end
		table.insert(stack, info.siblingSectionID)
		if not info.filteredByDifficulty then
			table.insert(stack, info.firstChildSectionID)
		end
		curSectionID = table.remove(stack)
	until not curSectionID
end

-- Print everything in 25-man Normal Madness of Deathwing:
PrintAllEncounterSections(333, 4)

Patch changes

Patch 8.0.1 (2018-07-17): Added spellID field.
Patch 7.3.5 (2018-01-16): Moved to C_EncounterJournal.GetSectionInfo()^[1]
Patch 4.2.0 (2011-06-28): Added as EJ_GetSectionInfo()

See also

• C_EncounterJournal.GetSectionIconFlags()