355 lines
8.3 KiB
Lua
355 lines
8.3 KiB
Lua
local WeeklyRewards =
|
|
{
|
|
Name = "WeeklyRewards",
|
|
Type = "System",
|
|
Namespace = "C_WeeklyRewards",
|
|
Environment = "All",
|
|
|
|
Functions =
|
|
{
|
|
{
|
|
Name = "AreRewardsForCurrentRewardPeriod",
|
|
Type = "Function",
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "isCurrentPeriod", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "CanClaimRewards",
|
|
Type = "Function",
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "canClaimRewards", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "ClaimReward",
|
|
Type = "Function",
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "id", Type = "number", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "CloseInteraction",
|
|
Type = "Function",
|
|
},
|
|
{
|
|
Name = "GetActivities",
|
|
Type = "Function",
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "type", Type = "WeeklyRewardChestThresholdType", Nilable = true },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "activities", Type = "table", InnerType = "WeeklyRewardActivityInfo", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetActivityEncounterInfo",
|
|
Type = "Function",
|
|
MayReturnNothing = true,
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "type", Type = "WeeklyRewardChestThresholdType", Nilable = false },
|
|
{ Name = "index", Type = "luaIndex", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "info", Type = "table", InnerType = "WeeklyRewardActivityEncounterInfo", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetConquestWeeklyProgress",
|
|
Type = "Function",
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "weeklyProgress", Type = "ConquestWeeklyProgress", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetDifficultyIDForActivityTier",
|
|
Type = "Function",
|
|
MayReturnNothing = true,
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "activityTierID", Type = "number", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "difficultyID", Type = "number", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetExampleRewardItemHyperlinks",
|
|
Type = "Function",
|
|
MayReturnNothing = true,
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "id", Type = "number", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "hyperlink", Type = "string", Nilable = false },
|
|
{ Name = "upgradeHyperlink", Type = "string", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetItemHyperlink",
|
|
Type = "Function",
|
|
MayReturnNothing = true,
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "itemDBID", Type = "WeeklyRewardItemDBID", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "hyperlink", Type = "cstring", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetNextActivitiesIncrease",
|
|
Type = "Function",
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "activityTierID", Type = "number", Nilable = false },
|
|
{ Name = "level", Type = "number", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "hasSeasonData", Type = "bool", Nilable = false },
|
|
{ Name = "nextActivityTierID", Type = "number", Nilable = true },
|
|
{ Name = "nextLevel", Type = "number", Nilable = true },
|
|
{ Name = "itemLevel", Type = "number", Nilable = true },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetNextMythicPlusIncrease",
|
|
Type = "Function",
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "mythicPlusLevel", Type = "number", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "hasSeasonData", Type = "bool", Nilable = false },
|
|
{ Name = "nextMythicPlusLevel", Type = "number", Nilable = true },
|
|
{ Name = "itemLevel", Type = "number", Nilable = true },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetNumCompletedDungeonRuns",
|
|
Type = "Function",
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "numHeroic", Type = "number", Nilable = false },
|
|
{ Name = "numMythic", Type = "number", Nilable = false },
|
|
{ Name = "numMythicPlus", Type = "number", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "GetSortedProgressForActivity",
|
|
Type = "Function",
|
|
SecretArguments = "AllowedWhenUntainted",
|
|
|
|
Arguments =
|
|
{
|
|
{ Name = "type", Type = "WeeklyRewardChestThresholdType", Nilable = false },
|
|
{ Name = "combineSharedDifficulty", Type = "bool", Nilable = false },
|
|
},
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "progress", Type = "table", InnerType = "WeeklyRewardActivityTierProgress", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "HasAvailableRewards",
|
|
Type = "Function",
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "hasAvailableRewards", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "HasGeneratedRewards",
|
|
Type = "Function",
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "hasGeneratedRewards", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "HasInteraction",
|
|
Type = "Function",
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "isInteracting", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "IsWeeklyChestRetired",
|
|
Type = "Function",
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "isRetired", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "OnUIInteract",
|
|
Type = "Function",
|
|
},
|
|
{
|
|
Name = "ShouldShowFinalRetirementMessage",
|
|
Type = "Function",
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "showRetirementMessage", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "ShouldShowRetirementMessage",
|
|
Type = "Function",
|
|
|
|
Returns =
|
|
{
|
|
{ Name = "showRetirementMessage", Type = "bool", Nilable = false },
|
|
},
|
|
},
|
|
},
|
|
|
|
Events =
|
|
{
|
|
{
|
|
Name = "WeeklyRewardsItemChanged",
|
|
Type = "Event",
|
|
LiteralName = "WEEKLY_REWARDS_ITEM_CHANGED",
|
|
SynchronousEvent = true,
|
|
},
|
|
{
|
|
Name = "WeeklyRewardsUpdate",
|
|
Type = "Event",
|
|
LiteralName = "WEEKLY_REWARDS_UPDATE",
|
|
SynchronousEvent = true,
|
|
},
|
|
},
|
|
|
|
Tables =
|
|
{
|
|
{
|
|
Name = "ConquestProgressBarDisplayType",
|
|
Type = "Enumeration",
|
|
NumValues = 3,
|
|
MinValue = 0,
|
|
MaxValue = 2,
|
|
Fields =
|
|
{
|
|
{ Name = "FirstChest", Type = "ConquestProgressBarDisplayType", EnumValue = 0 },
|
|
{ Name = "AdditionalChest", Type = "ConquestProgressBarDisplayType", EnumValue = 1 },
|
|
{ Name = "Seasonal", Type = "ConquestProgressBarDisplayType", EnumValue = 2 },
|
|
},
|
|
},
|
|
{
|
|
Name = "ConquestWeeklyProgress",
|
|
Type = "Structure",
|
|
Fields =
|
|
{
|
|
{ Name = "progress", Type = "number", Nilable = false },
|
|
{ Name = "maxProgress", Type = "number", Nilable = false },
|
|
{ Name = "displayType", Type = "ConquestProgressBarDisplayType", Nilable = false },
|
|
{ Name = "unlocksCompleted", Type = "number", Nilable = false },
|
|
{ Name = "maxUnlocks", Type = "number", Nilable = false },
|
|
{ Name = "sampleItemHyperlink", Type = "string", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "WeeklyRewardActivityEncounterInfo",
|
|
Type = "Structure",
|
|
Fields =
|
|
{
|
|
{ Name = "encounterID", Type = "number", Nilable = false },
|
|
{ Name = "bestDifficulty", Type = "number", Nilable = false },
|
|
{ Name = "uiOrder", Type = "number", Nilable = false },
|
|
{ Name = "instanceID", Type = "number", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "WeeklyRewardActivityInfo",
|
|
Type = "Structure",
|
|
Fields =
|
|
{
|
|
{ Name = "type", Type = "WeeklyRewardChestThresholdType", Nilable = false },
|
|
{ Name = "index", Type = "luaIndex", Nilable = false },
|
|
{ Name = "threshold", Type = "number", Nilable = false },
|
|
{ Name = "progress", Type = "number", Nilable = false },
|
|
{ Name = "id", Type = "number", Nilable = false },
|
|
{ Name = "activityTierID", Type = "number", Nilable = false },
|
|
{ Name = "level", Type = "number", Nilable = false },
|
|
{ Name = "claimID", Type = "number", Nilable = true },
|
|
{ Name = "raidString", Type = "cstring", Nilable = true },
|
|
{ Name = "rewards", Type = "table", InnerType = "WeeklyRewardActivityRewardInfo", Nilable = false },
|
|
},
|
|
},
|
|
{
|
|
Name = "WeeklyRewardActivityRewardInfo",
|
|
Type = "Structure",
|
|
Fields =
|
|
{
|
|
{ Name = "type", Type = "CachedRewardType", Nilable = false },
|
|
{ Name = "id", Type = "number", Nilable = false },
|
|
{ Name = "quantity", Type = "number", Nilable = false },
|
|
{ Name = "itemDBID", Type = "WeeklyRewardItemDBID", Nilable = true },
|
|
},
|
|
},
|
|
{
|
|
Name = "WeeklyRewardActivityTierProgress",
|
|
Type = "Structure",
|
|
Fields =
|
|
{
|
|
{ Name = "activityTierID", Type = "number", Nilable = false },
|
|
{ Name = "difficulty", Type = "number", Nilable = false },
|
|
{ Name = "numPoints", Type = "number", Nilable = false },
|
|
},
|
|
},
|
|
},
|
|
|
|
Predicates =
|
|
{
|
|
},
|
|
};
|
|
|
|
APIDocumentation:AddDocumentationTable(WeeklyRewards); |