Back to Home

ESO Lua File v100032

publicallingames/rewards/rewards_manager.lua

[◄ back to folders ]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
ZO_RewardData = ZO_Object:Subclass()
function ZO_RewardData:New(...)
    local object = ZO_Object.New(self)
    object:Initialize(...)
    return object
end
function ZO_RewardData:Initialize(rewardId, parentChoice)
    self.rewardId = rewardId
    self.parentChoice = parentChoice
end
function ZO_RewardData:SetQuantity(quantity)
    self.quantity = quantity
end
function ZO_RewardData:SetIcon(icon, gamepadIcon)
    self.icon = icon
    self.gamepadIcon = gamepadIcon
end
function ZO_RewardData:SetFormattedName(formattedName)
    self.formattedName = formattedName
end
function ZO_RewardData:SetFormattedNameWithStack(keyboardName, gamepadName)
    self.formattedNameWithStackKeyboard = keyboardName
    self.formattedNameWithStackGamepad = gamepadName
end
function ZO_RewardData:SetChoiceIndex(choiceIndex)
    self.choiceIndex = choiceIndex
end
function ZO_RewardData:SetItemFunctionalQuality(itemFunctionalQuality)
    self.functionalQuality = itemFunctionalQuality
end
function ZO_RewardData:SetItemDisplayQuality(itemDisplayQuality)
    self.displayQuality = itemDisplayQuality
    -- self.quality is deprecated, included here for addon backwards compatibility
    self.quality = itemDisplayQuality
end
function ZO_RewardData:SetCurrencyInfo(currencyType)
    self.currencyType = currencyType
end
function ZO_RewardData:SetEquipSlot(equipSlot)
    self.equipSlot = equipSlot
end
function ZO_RewardData:SetChoices(rewardChoices)
    self.choices = rewardChoices
end
function ZO_RewardData:SetRewardType(rewardType)
    self.rewardType = rewardType
end
function ZO_RewardData:SetValidationFunction(validationFunction)
end
function ZO_RewardData:SetIsSelectedChoice(isSelectedChoice)
    if self:GetParentChoice() then
        self.isSelectedChoice = isSelectedChoice
    end
end
function ZO_RewardData:SetAnnouncementBackground(announcementBackground)
    self.announcementBackground = announcementBackground
end
function ZO_RewardData:GetEquipSlot()
    return self.equipSlot
end
function ZO_RewardData:GetCurrencyType()
    return self.currencyType
end
function ZO_RewardData:GetItemFunctionalQuality()
    -- self.quality is deprecated, included here for addon backwards compatibility
    return self.functionalQuality or self.quality or ITEM_FUNCTIONAL_QUALITY_NORMAL
end
function ZO_RewardData:GetItemDisplayQuality()
    -- self.quality is deprecated, included here for addon backwards compatibility
    return self.displayQuality or self.quality or ITEM_DISPLAY_QUALITY_NORMAL
end
function ZO_RewardData:GetKeyboardIcon()
    return self.icon
end
function ZO_RewardData:GetGamepadIcon()
    -- if no gamepadIcon is used, icon is used for both
    return self.gamepadIcon or self.icon
end
function ZO_RewardData:GetQuantity()
    return self.quantity or 1
end
function ZO_RewardData:GetRewardId()
    return self.rewardId
end
function ZO_RewardData:GetParentChoice()
    return self.parentChoice
end
function ZO_RewardData:GetFormattedName()
    return self.formattedName
end
function ZO_RewardData:GetFormattedNameWithStack()
    return self.formattedNameWithStackKeyboard
end
function ZO_RewardData:GetFormattedNameWithStackGamepad()
    -- if there is no gamepad name, the keyboard name is used for both
    return self.formattedNameWithStackGamepad or self.formattedNameWithStackKeyboard
end
function ZO_RewardData:GetChoices()
    return self.choices
end
function ZO_RewardData:GetRewardType()
    return self.rewardType
end
function ZO_RewardData:IsValidReward()
    return not self.validationFunction or self.validationFunction() == true
end
function ZO_RewardData:GetAnnouncementBackground()
    return self.announcementBackground
end
---------------------
-- Rewards Manager
---------------------
ZO_RewardsManager = ZO_CallbackObject:Subclass()
function ZO_RewardsManager:New(...)
    local rewards = ZO_CallbackObject.New(self)
    rewards:Initialize(...)
    return rewards
end
function ZO_RewardsManager:Initialize()
    
end
do
    local PARENT_CHOICE = nil
    local VALIDATION_FUNCTION = nil
    local SELECTED_CHOICE_FUNCTION = nil
    function ZO_RewardsManager:GetInfoForDailyLoginReward(rewardId, quantity)
        return self:GetInfoForReward(rewardId, quantity, PARENT_CHOICE, VALIDATION_FUNCTION, SELECTED_CHOICE_FUNCTION)
    end
end
function ZO_RewardsManager:GetAllRewardInfoForRewardList(rewardListId, parentChoice, validationFunction, isSelectedChoiceFunction)
    local rewardListInfo = {}
    local numRewards = GetNumRewardListEntries(rewardListId)
    for rewardIndex = 1, numRewards do
        local rewardId, entryType, quantity = GetRewardListEntryInfo(rewardListId, rewardIndex)
        local rewardData = self:GetInfoForReward(rewardId, quantity, parentChoice, validationFunction, isSelectedChoiceFunction)
        if rewardData then
            rewardData:SetChoiceIndex(rewardIndex)
            table.insert(rewardListInfo, rewardData)
        end
    end
    return rewardListInfo
end
function ZO_RewardsManager:GetInfoForReward(rewardId, quantity, parentChoice, validationFunction, isSelectedChoiceFunction)
    local entryType = GetRewardType(rewardId)
    local rewardData
    if entryType == REWARD_ENTRY_TYPE_ADD_CURRENCY then
        rewardData = self:GetCurrencyEntryInfo(rewardId, quantity, parentChoice)
    elseif entryType == REWARD_ENTRY_TYPE_COLLECTIBLE then
        rewardData = self:GetCollectibleEntryInfo(rewardId, parentChoice)
    elseif entryType == REWARD_ENTRY_TYPE_ITEM then
        rewardData = self:GetItemEntryInfo(rewardId, quantity, parentChoice)
    elseif entryType == REWARD_ENTRY_TYPE_LOOT_CRATE then
        rewardData = self:GetCrownCrateEntryInfo(rewardId, quantity, parentChoice)
    elseif entryType == REWARD_ENTRY_TYPE_CHOICE then
        rewardData = self:GetChoiceEntryInfo(rewardId, parentChoice, validationFunction, isSelectedChoiceFunction)
    elseif entryType == REWARD_ENTRY_TYPE_INSTANT_UNLOCK then
        rewardData = self:GetInstantUnlockEntryInfo(rewardId, parentChoice)
    end
    if rewardData then
        rewardData:SetRewardType(entryType)
        if validationFunction then
            rewardData:SetValidationFunction(function() return validationFunction(rewardId) end)
        end
        if parentChoice then
            rewardData:SetIsSelectedChoice(isSelectedChoiceFunction and isSelectedChoiceFunction(parentChoice.rewardId, rewardData.rewardId))
        end
    end
    return rewardData
end
function ZO_RewardsManager:GetChoiceEntryInfo(rewardId, parentChoice, validationFunction, isSelectedChoiceFunction)
    local choiceListId = GetChoiceRewardListId(rewardId)
    local rewardData = ZO_RewardData:New(rewardId, parentChoice)
    rewardData:SetFormattedName(GetChoiceRewardDisplayName(rewardId))
    rewardData:SetIcon(GetChoiceRewardIcon(rewardId))
    local choices = self:GetAllRewardInfoForRewardList(choiceListId, rewardData, validationFunction, isSelectedChoiceFunction)
    table.sort(choices, function(...) return self:SortChoiceRewardEntries(...) end)
    rewardData:SetChoices(choices)
    return rewardData
end
function ZO_RewardsManager:GetCurrencyEntryInfo(rewardId, quantity, parentChoice)
    local currencyType = GetAddCurrencyRewardInfo(rewardId)
    local IS_PLURAL = false
    local IS_UPPER = false
    local formattedName = zo_strformat(SI_CURRENCY_NAME_FORMAT, GetCurrencyName(currencyType, IS_PLURAL, IS_UPPER))
    local formattedNameWithStackKeyboard = zo_strformat(SI_NUMBER_FORMAT, ZO_Currency_FormatKeyboard(currencyType, quantity, ZO_CURRENCY_FORMAT_AMOUNT_NAME))
    local formattedNameWithStackGamepad = zo_strformat(SI_NUMBER_FORMAT, ZO_Currency_FormatGamepad(currencyType, quantity, ZO_CURRENCY_FORMAT_AMOUNT_NAME))
    local rewardData = ZO_RewardData:New(rewardId, parentChoice)
    rewardData:SetFormattedName(formattedName)
    rewardData:SetIcon(GetCurrencyLootKeyboardIcon(currencyType), GetCurrencyLootGamepadIcon(currencyType))
    rewardData:SetFormattedNameWithStack(formattedNameWithStackKeyboard, formattedNameWithStackGamepad)
    rewardData:SetQuantity(quantity)
    rewardData:SetCurrencyInfo(currencyType)
    return rewardData
end
function ZO_RewardsManager:GetItemEntryInfo(rewardId, quantity, parentChoice)
    local itemLink = GetItemRewardItemLink(rewardId, quantity)
    local displayName = GetItemLinkName(itemLink)
    local itemFunctionalQuality = GetItemLinkFunctionalQuality(itemLink)
    local itemDisplayQuality = GetItemLinkDisplayQuality(itemLink)
    local icon = GetItemLinkIcon(itemLink)
    local equipType = GetItemLinkEquipType(itemLink)
    local equipSlot = ZO_Character_GetEquipSlotForEquipType(equipType)
    local rewardData = ZO_RewardData:New(rewardId, parentChoice)
    rewardData:SetFormattedName(zo_strformat(SI_TOOLTIP_ITEM_NAME, displayName))
    rewardData:SetIcon(icon)
    rewardData:SetItemFunctionalQuality(itemFunctionalQuality)
    rewardData:SetItemDisplayQuality(itemDisplayQuality)
    rewardData:SetEquipSlot(equipSlot)
    rewardData:SetQuantity(quantity)
    rewardData:SetFormattedNameWithStack(zo_strformat(SI_REWARDS_FORMAT_REWARD_WITH_AMOUNT, displayName, ZO_SELECTED_TEXT:Colorize(quantity)))
    return rewardData
end
function ZO_RewardsManager:GetCrownCrateEntryInfo(rewardId, quantity, parentChoice)
    local crateId = GetCrownCrateRewardCrateId(rewardId)
    local icon = GetCrownCrateIcon(crateId)
    local displayName = GetCrownCrateName(crateId)
    local formattedDisplayName = zo_strformat(SI_TOOLTIP_ITEM_NAME, displayName)
    local formattedNameWithStack = zo_strformat(SI_REWARDS_FORMAT_REWARD_WITH_AMOUNT, displayName, ZO_SELECTED_TEXT:Colorize(quantity))
    
    local rewardData = ZO_RewardData:New(rewardId, parentChoice)
    rewardData:SetFormattedName(formattedDisplayName)
    rewardData:SetFormattedNameWithStack(formattedNameWithStack)
    rewardData:SetIcon(icon)
    rewardData:SetQuantity(quantity)
    return rewardData
end
function ZO_RewardsManager:GetInstantUnlockEntryInfo(rewardId, parentChoice)
    local instantUnlockId = GetInstantUnlockRewardInstantUnlockId(rewardId)
    local icon = GetInstantUnlockRewardIcon(instantUnlockId)
    local displayName = GetInstantUnlockRewardDisplayName(instantUnlockId)
    local formattedDisplayName = zo_strformat(SI_TOOLTIP_ITEM_NAME, displayName)
    
    local rewardData = ZO_RewardData:New(rewardId, parentChoice)
    rewardData:SetFormattedName(formattedDisplayName)
    rewardData:SetIcon(icon)
    
    return rewardData
end
function ZO_RewardsManager:SortChoiceRewardEntries(data1, data2)
    return data1.choiceIndex < data2.choiceIndex
end
function ZO_RewardsManager:GetCollectibleEntryInfo(rewardId, parentChoice)
    assert(false) -- must be implemented on specific gui version of this manager
end
function ZO_RewardsManager:GetRewardContextualTypeString(rewardId, parentChoice)
    local entryType = GetRewardType(rewardId)
    -- COLLECTIBLE is implemented on specific gui version of this manager
    if entryType == REWARD_ENTRY_TYPE_ADD_CURRENCY then
        local currencyType = GetAddCurrencyRewardInfo(rewardId)
        local IS_PLURAL = false
        local IS_UPPER = false
        return GetCurrencyName(currencyType, IS_PLURAL, IS_UPPER)
    elseif entryType == REWARD_ENTRY_TYPE_ITEM then
        local QUANTITY = 1
        local itemLink = GetItemRewardItemLink(rewardId, QUANTITY)
        local itemType, specializedItemType = GetItemLinkItemType(itemLink)
        if itemType ~= ITEMTYPE_NONE then
            local equipType = GetItemLinkEquipType(itemLink)
            if equipType ~= EQUIP_TYPE_INVALID then
                return GetString("SI_EQUIPTYPE", equipType)
            else
                return ZO_GetSpecializedItemTypeText(itemType, specializedItemType)
            end
        end
    end
    return nil
end
------------------
-- XML Functions
------------------
function ZO_Rewards_Shared_OnMouseEnter(control, anchorPoint, anchorPointRelativeTo, anchorOffsetX, anchorOffsetY)
    local rewardData = control.GetRewardData and control.GetRewardData() or control.data
    if rewardData then
        local rewardType = rewardData:GetRewardType()
        if rewardType and rewardType ~= REWARD_ENTRY_TYPE_CHOICE then
            anchorPoint = anchorPoint or LEFT
            anchorPointRelativeTo = anchorPointRelativeTo or RIGHT
            anchorOffsetX = anchorOffsetX or 0
            anchorOffsetY = anchorOffsetY or 0
            local rewardId = rewardData:GetRewardId()
            local quantity = rewardData:GetQuantity()
            InitializeTooltip(ItemTooltip, control, anchorPoint, anchorOffsetX, anchorOffsetY, anchorPointRelativeTo)
            ItemTooltip:SetReward(rewardId, quantity)
            if rewardType == REWARD_ENTRY_TYPE_ITEM then
                ItemTooltip:ShowComparativeTooltips()
                ZO_PlayShowAnimationOnComparisonTooltip(ComparativeTooltip1)
                ZO_PlayShowAnimationOnComparisonTooltip(ComparativeTooltip2)
                ZO_Tooltips_SetupDynamicTooltipAnchors(ItemTooltip, control, ComparativeTooltip1, ComparativeTooltip2)
            end
        end
    end
end
    ClearTooltip(ItemTooltip)
    ItemTooltip:HideComparativeTooltips()
end