C_DelvesUI

namespaceavailable in: camelot

Status in wowlua

40 functions: 0 implemented, 4 recorded, 36 guessed. 6 events, 0 of them fired by the emulator on its own.

Functions

function	what it does	status
`GetActiveDelveTier`	Returns the entrance tier information for the active Delve (via party data). Assumes only Delves use this type for now. `(): TieredEntranceTierInfo`	guessed
`GetCompanionInfoForActivePlayer`	Returns the ID of the player's delve companion. · by wowlua `(): number`	guessed
`GetCreatureDisplayInfoForCompanion`	Returns the creature display ID of a delve companion. · by wowlua `(companionID: number?): number`	guessed
`GetCurioLink`	Given the spell ID for an owned curio and its rarity, return a spell link style hyperlink for the curio spell, since they aren't items when learned `(spellID: SpellIdentifier, rarity: CurioRarity): string`	guessed
`GetCurioNodeForCompanion`	Returns a delve companion's curio trait node of a kind. · by wowlua `(curioType: CurioType, companionID: number?): number`	recorded
`GetCurioRarityByTraitCondAccountElementID`	Returns the rarity of a curio. · by wowlua `(traitCondAccountElementID: number): CurioRarity`	guessed
`GetCurrentDelvesSeasonNumber`	Returns the number of the current delves season. · by wowlua `(): number`	guessed
`GetDelveEntranceBackgroundWidgetSetID`	Returns the widget set ID of the delve entrance window's background. · by wowlua `(): number`	guessed
`GetDelveEntranceDescriptionString`	Returns the description shown at the delve entrance. · by wowlua `(): string?`	guessed
`GetDelveEntranceHeaderString`	Returns the header shown at the delve entrance. · by wowlua `(): string?`	guessed
`GetDelveEntranceMapID`	Returns the map ID of the delve whose entrance is open. · by wowlua `(): number`	guessed
`GetDelveEntranceTiers`	Returns the tiers the delve entrance offers. · by wowlua `(): TieredEntranceTierInfo[]`	guessed
`GetDelveEntranceTitleString`	Returns the title shown at the delve entrance. · by wowlua `(): string?`	guessed
`GetDelvesAffixSpellsForSeason`	Returns the spells of this season's delve affixes. · by wowlua `(): number[]`	guessed
`GetDelvesFactionForSeason`	Returns the faction ID of this season's delves. · by wowlua `(): number`	guessed
`GetDelvesMinRequiredLevel`	Players must be at or above the min level + offset to enter Delves. This function returns that min level. `(): number?`	guessed
`GetFactionForCompanion`	Returns the faction ID of a delve companion. · by wowlua `(companionID: number?): number`	guessed
`GetFlavorNodeForCompanion`	Returns a delve companion's flavor trait node. · by wowlua `(companionID: number?): number`	recorded
`GetFlavorNodeNameForCompanion`	Returns the name of a delve companion's flavor trait node. · by wowlua `(companionID: number?): string`	guessed
`GetLockedTextForCompanion`	Returns the text shown while a delve companion is locked. · by wowlua `(companionID: number?): string`	guessed
`GetModelSceneForCompanion`	Returns the model scene ID of a delve companion. · by wowlua `(companionID: number?): number`	guessed
`GetPlayerCompanionPDEID`	Returns the player data element ID of a delve companion. · by wowlua `(companionID: number?): number?`	guessed
`GetRoleNodeForCompanion`	Returns a delve companion's role trait node. · by wowlua `(companionID: number?): number`	recorded
`GetRoleSubtreeForCompanion`	Returns a delve companion's trait subtree for a role. · by wowlua `(roleType: CompanionRoleType, companionID: number?): number`	guessed
`GetTieredEntranceOptionalAffixTraitTreeID`	Returns the trait tree ID of the tiered entrance's optional affixes. · by wowlua `(): number?`	guessed
`GetTieredEntrancePDEID`	Returns the player data element ID of the tiered entrance. · by wowlua `(): number`	guessed
`GetTieredEntranceType`	Returns the kind of tiered entrance that is open. · by wowlua `(): TieredEntranceType`	guessed
`GetTraitTreeForCompanion`	Returns the trait tree ID of a delve companion. · by wowlua `(companionID: number?): number`	recorded
`GetUnseenCuriosBySlotType`	Returns the curios of a slot type the player hasn't seen yet. · by wowlua `(slotType: CompanionConfigSlotTypes, ownedCurioNodeIDs: number[]): number[]`	guessed
`GetWorldTierDifficultyForActivePlayer`	Returns the player's world tier difficulty. · by wowlua `(): WorldTierDifficulty`	guessed
`HasActiveDelve`	Whether the player has an active delve. · by wowlua `(): boolean`	guessed
`HasActiveLFGLair`	Whether the player has an active lair from the group finder. · by wowlua `(): boolean`	guessed
`HasActiveLair`	Whether the player has an active lair. · by wowlua `(): boolean`	guessed
`IsDelveEntranceTierEnabled`	Whether a delve tier can be chosen, and the reason when it can't. · by wowlua `(tier: number): (boolean, string?)`	guessed
`IsEligibleForActiveDelveRewards`	Whether the unit can get the rewards of the active delve. · by wowlua `(unit: string): boolean`	guessed
`IsInLair`	Whether the player is in a lair. · by wowlua `(): boolean`	guessed
`IsTraitTreeForCompanion`	Whether a trait tree belongs to a delve companion. · by wowlua `(traitTreeID: number): boolean`	guessed
`RequestPartyEligibilityForDelveTiers`	Queries private party members to see what level they have unlocked for the Delve. Ineligible members are added to the tooltip of dropdown entries. `(mapID: number)`	guessed
`SaveSeenCuriosBySlotType`	Marks the curios of a slot type as seen. · by wowlua `(slotType: CompanionConfigSlotTypes, ownedCurioNodeIDs: number[])`	guessed
`SelectDelveEntranceTier`	Selects a tier at the delve entrance. · by wowlua `(tier: number)`	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
`ACTIVE_DELVE_DATA_UPDATE`	`no payload`	not implemented
`DELVES_ACCOUNT_DATA_ELEMENT_CHANGED`	`no payload`	not implemented
`DELVE_ASSIST_ACTION`	`data: DelveAssistActionData`	not implemented
`PARTY_ELIGIBILITY_FOR_DELVE_TIERS_CHANGED`	`playerName: string, maxEligibleLevel: number`	not implemented
`SHOW_DELVES_COMPANION_CONFIGURATION_UI`	`no payload`	not implemented
`WALK_IN_DATA_UPDATE`	`no payload`	not implemented

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

Structures

TieredEntranceRewardInfo · id, quantity, rewardType, context
TieredEntranceTierInfo · tier, suggestedILvl, overrideTooltipSpellID, unlocked, tierDescription, rewards, modifierUIWidgetSetID, lockedReason?, queueAsLFG, difficultyID

sources

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