C_ScenarioInfo

namespaceavailable in: camelot

Status in wowlua

10 functions: 0 implemented, 1 recorded, 9 guessed. 9 events, 1 of them fired by the emulator on its own.

Functions

function	what it does	status
`GetCriteriaInfo`	Returns information about a criterion of the current scenario step. · by wowlua `(criteriaIndex: number): ScenarioCriteriaInfo?`	guessed
`GetCriteriaInfoByStep`	Returns information about a criterion of the given scenario step. · by wowlua `(stepID: number, criteriaIndex: number): ScenarioCriteriaInfo?`	guessed
`GetDisplayInfo`	Returns display information for the current scenario. · by wowlua `(): ScenarioDisplayInfo?`	guessed
`GetJailersTowerTypeString`	Returns the display name of a Torghast run type. · by wowlua `(runType: JailersTowerType): string?`	guessed
`GetScenarioIconInfo`	Returns the scenario icons to show on the given map. · by wowlua `(uiMapID: number): ScenarioIconInfo[]?`	guessed
`GetScenarioInfo`	Returns information about the current scenario, or nil when the player is not in one. · by wowlua `(): ScenarioInformation?`	guessed
`GetScenarioStepInfo`	Returns information about a scenario step. · by wowlua `(scenarioStepID: number?): ScenarioStepInfo?`	guessed
`GetTieredEntranceActiveSpells`	Returns list of active challenge spells if inside a tiered entrance scenario `(): number[]?`	guessed
`GetUnitCriteriaProgressValues`	Returns the unit's progress values for scenario criteria. · by wowlua `(unit: string): (number?, number?, string?)`	guessed
`IsTieredEntranceScenario`	Whether the current scenario is a tiered entrance scenario. · by wowlua `(): boolean`	recorded

"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
`JAILERS_TOWER_LEVEL_UPDATE`	`level: number, type: JailersTowerType`	not implemented
`SCENARIO_BONUS_OBJECTIVE_COMPLETE`	`bonusObjectiveID: number`	not implemented
`SCENARIO_BONUS_VISIBILITY_UPDATE`	`no payload`	not implemented
`SCENARIO_COMPLETED`	`questID: number?, xp: number?, money: number?`	not implemented
`SCENARIO_CRITERIA_SHOW_STATE_UPDATE`	`show: boolean`	not implemented
`SCENARIO_CRITERIA_UPDATE`	`criteriaID: number`	not implemented
`SCENARIO_POI_UPDATE`	`no payload`	not implemented
`SCENARIO_SPELL_UPDATE`	`no payload`	not implemented
`SCENARIO_UPDATE`	`newStep: boolean?`	implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("JAILERS_TOWER_LEVEL_UPDATE").

Structures

ScenarioCriteriaInfo · description, criteriaType, completed, quantity, totalQuantity, flags, assetID, criteriaID, duration, elapsed, failed, isWeightedProgress, isFormatted, quantityString
ScenarioDisplayInfo · themeColor?, startSoundKitID?
ScenarioIconInfo · x, y, atlas, description
ScenarioInformation · name, currentStage, numStages, flags, isComplete, xp, money, type, area, uiTextureKit, scenarioID
ScenarioStepInfo · title, description, numCriteria, stepFailed, isBonusStep, isForCurrentStepOnly, shouldShowBonusObjective, spells, weightedProgress?, rewardQuestID, widgetSetID?, stepID
ScenarioStepSpellInfo · spellID, name, icon

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (ScenarioInfo 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.