C_CovenantSanctumUI
namespaceavailable in: camelotStatus in wowlua
16 functions: 0 implemented, 0 recorded, 16 guessed. 2 events, 0 of them fired by the emulator on its own.
Functions
| function | what it does | status |
|---|---|---|
CanAccessReservoir | Whether the player can access the anima reservoir. · by wowlua(): boolean | guessed |
CanDepositAnima | Whether the player can deposit anima. · by wowlua(): boolean | guessed |
DepositAnima | Deposits anima to a Covenant Sanctum.() | guessed |
EndInteraction | Ends the interaction with the covenant sanctum. · by wowlua() | guessed |
GetAnimaInfo | Returns information about the player's anima. · by wowlua(): (number, number) | guessed |
GetCurrentTalentTreeID | Returns the ID of the sanctum talent tree being shown. · by wowlua(): number? | guessed |
GetFeatures | Returns the covenant sanctum's features. · by wowlua(): CovenantSanctumFeatureInfo[] | guessed |
GetRenownLevel | Get Renown level for currently active covenant.(): number | guessed |
GetRenownLevels | Returns the renown levels of a covenant. · by wowlua(covenantID: number): CovenantSanctumRenownLevelInfo[] | guessed |
GetRenownRewardsForLevel | Returns the rewards of a covenant's renown level. · by wowlua(covenantID: number, renownLevel: number): CovenantSanctumRenownRewardInfo[] | guessed |
GetSanctumType | Returns the kind of sanctum feature being shown. · by wowlua(): GarrTalentFeatureSubtype? | guessed |
GetSoulCurrencies | Returns the IDs of the covenant's soul currencies. · by wowlua(): number[] | guessed |
HasMaximumRenown | Whether the player has reached the maximum renown. · by wowlua(): boolean | guessed |
IsPlayerInRenownCatchUpMode | Whether the player is catching up on renown. · by wowlua(): boolean | guessed |
IsWeeklyRenownCapped | Whether the player has reached this week's renown cap. · by wowlua(): boolean | guessed |
RequestCatchUpState | Requests the player's renown catch-up state from the server. · by wowlua() | 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 |
|---|---|---|
COVENANT_RENOWN_CATCH_UP_STATE_UPDATE | no payload | not implemented |
COVENANT_SANCTUM_RENOWN_LEVEL_CHANGED | newRenownLevel: number, oldRenownLevel: number | not implemented |
An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("COVENANT_RENOWN_CATCH_UP_STATE_UPDATE").
Structures
CovenantSanctumFeatureInfo· garrTalentTreeID, featureType, uiOrderCovenantSanctumRenownLevelInfo· level, locked, isMilestone, isCapstoneCovenantSanctumRenownRewardInfo· uiOrder, itemID?, spellID?, mountID?, transmogID?, transmogSetID?, titleMaskID?, garrFollowerID?, transmogIllusionSourceID?, icon?, name?, description?, toastDescription?
sources
Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (CovenantSanctumUI 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.