C_WeeklyRewards

namespaceavailable in: camelot

Status in wowlua

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

Functions

function	what it does	status
`AreRewardsForCurrentRewardPeriod`	Whether the Great Vault rewards belong to the current reward period. · by wowlua `(): boolean`	guessed
`CanClaimRewards`	Whether the player can claim a Great Vault reward. · by wowlua `(): boolean`	guessed
`ClaimReward`	Claims a Great Vault reward. · by wowlua `(id: number)`	guessed
`CloseInteraction`	Closes the interaction with the Great Vault. · by wowlua `()`	guessed
`GetActivities`	Returns the Great Vault activities and their progress. · by wowlua `(type: WeeklyRewardChestThresholdType?): WeeklyRewardActivityInfo[]`	guessed
`GetActivityEncounterInfo`	Returns the encounters that count toward a Great Vault activity. · by wowlua `(type: WeeklyRewardChestThresholdType, index: number): WeeklyRewardActivityEncounterInfo[]?`	guessed
`GetConquestWeeklyProgress`	Returns the player's weekly Conquest progress. · by wowlua `(): ConquestWeeklyProgress`	guessed
`GetDifficultyIDForActivityTier`	Returns the difficulty ID of a Great Vault activity tier. · by wowlua `(activityTierID: number): number?`	guessed
`GetExampleRewardItemHyperlinks`	Returns example item links for a Great Vault reward and its upgraded version. · by wowlua `(id: number): (string?, string?)`	guessed
`GetItemHyperlink`	Returns the item link of a Great Vault reward item. · by wowlua `(itemDBID: WeeklyRewardItemDBID): string?`	guessed
`GetNextActivitiesIncrease`	Returns what is needed for the next improvement of a Great Vault activity's reward. · by wowlua `(activityTierID: number, level: number): (boolean, number?, number?, number?)`	guessed
`GetNextMythicPlusIncrease`	Returns what Mythic+ level improves the Great Vault reward next. · by wowlua `(mythicPlusLevel: number): (boolean, number?, number?)`	guessed
`GetNumCompletedDungeonRuns`	Returns the numbers of dungeon runs the player completed this week, by difficulty. · by wowlua `(): (number, number, number)`	guessed
`GetSortedProgressForActivity`	Returns a Great Vault activity's progress by tier, sorted. · by wowlua `(type: WeeklyRewardChestThresholdType, combineSharedDifficulty: boolean): WeeklyRewardActivityTierProgress[]`	guessed
`HasAvailableRewards`	Whether the Great Vault has rewards to claim. · by wowlua `(): boolean`	guessed
`HasGeneratedRewards`	Whether the Great Vault rewards have been generated. · by wowlua `(): boolean`	guessed
`HasInteraction`	Whether the player is interacting with the Great Vault. · by wowlua `(): boolean`	guessed
`IsWeeklyChestRetired`	Whether the Great Vault is retired. · by wowlua `(): boolean`	guessed
`OnUIInteract`	Tells the game that the player interacted with the Great Vault UI. · by wowlua `()`	guessed
`ShouldShowFinalRetirementMessage`	Whether to show the final message about the Great Vault's retirement. · by wowlua `(): boolean`	guessed
`ShouldShowRetirementMessage`	Whether to show the message about the Great Vault's retirement. · by wowlua `(): boolean`	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
`WEEKLY_REWARDS_ITEM_CHANGED`	`no payload`	not implemented
`WEEKLY_REWARDS_UPDATE`	`no payload`	implemented

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

Structures

ConquestWeeklyProgress · progress, maxProgress, displayType, unlocksCompleted, maxUnlocks, sampleItemHyperlink
WeeklyRewardActivityEncounterInfo · encounterID, bestDifficulty, uiOrder, instanceID
WeeklyRewardActivityInfo · type, index, threshold, progress, id, activityTierID, level, claimID?, raidString?, rewards
WeeklyRewardActivityRewardInfo · type, id, quantity, itemDBID?
WeeklyRewardActivityTierProgress · activityTierID, difficulty, numPoints

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (WeeklyRewards system, camelot 1.60.1). Descriptions: written by wowlua where no documentation describes the entry.