Back to Home

ESO Lua File v100020

ingame/zo_loot/loothistory_shared.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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
LOOT_ENTRY_TYPE_EXPERIENCE = 1
LOOT_ENTRY_TYPE_CROWN_GEMS = 2
LOOT_ENTRY_TYPE_MONEY = 3
LOOT_ENTRY_TYPE_ITEM = 4
LOOT_ENTRY_TYPE_COLLECTIBLE = 5
LOOT_ENTRY_TYPE_MEDAL = 6
LOOT_ENTRY_TYPE_SCORE = 7
LOOT_ENTRY_TYPE_SKILL_EXPERIENCE = 8
--
--[[ ZO_LootHistory_Shared ]]--
--
ZO_LootHistory_Shared = ZO_Object:Subclass()
function ZO_LootHistory_Shared:New(...)
    local history = ZO_Object.New(self)
    history:Initialize(...)
    return history
end
function ZO_LootHistory_Shared:Initialize(control)
    self:InitializeFragment()
    self:SetEntryTemplate()
    self.fadeAnim = ZO_AlphaAnimation:New(control)
    self.fadeAnim:SetMinMaxAlpha(0.0, 1.0)
    self.lootQueue = {}
end
do
    local function SetupIconOverlayText(control, data)
        local overlayText = ZO_LootHistory_Shared.GetIconOverlayTextFromData(data)
        control.iconOverlayText:SetText(overlayText)
        local showOverlayText = ZO_LootHistory_Shared.GetShowIconOverlayTextFromData(data)
        control.iconOverlayText:SetHidden(not showOverlayText)
    end
    local function LootSetupFunction(control, data)
        control.label:SetText(data.text)
        control.label:SetColor(data.color:UnpackRGBA())
        control.icon:SetTexture(data.icon)
        SetupIconOverlayText(control, data)
        if data.statusIcon then
            control.statusIcon:SetTexture(data.statusIcon)
            control.statusIcon:SetHidden(false)
        else
            control.statusIcon:SetHidden(true)
        end
        if data.highlight then
            control.backgroundHighlight:SetTexture(data.highlight)
            control.backgroundHighlight:SetHidden(false)
        else
            control.backgroundHighlight:SetHidden(true)
        end
    end
    local function AreEntriesEqual(entry1, entry2)
        -- entry1 and entry2 are tables of one item
        local data1 = entry1[1]
        local data2 = entry2[1]
        local data1EntryType = data1.entryType
        local data2EntryType = data2.entryType
        if data1EntryType ~= data2EntryType then
            return false
        end
        if data1EntryType == LOOT_ENTRY_TYPE_MONEY then
            return data1.moneyType == data2.moneyType
        elseif data1EntryType == LOOT_ENTRY_TYPE_ITEM then
            return data1.itemId == data2.itemId and data1.quality == data2.quality and data1.isStolen == data2.isStolen
        elseif data1EntryType == LOOT_ENTRY_TYPE_COLLECTIBLE then
            return data1.collectibleId == data2.collectibleId
        elseif data1EntryType == LOOT_ENTRY_TYPE_MEDAL then
            return false -- Medals are always on their own line
        elseif data1EntryType == LOOT_ENTRY_TYPE_SCORE then
            return false -- scores are always on their own line (also expecting to only be showing one of these at a time)
        elseif data1EntryType == LOOT_ENTRY_TYPE_SKILL_EXPERIENCE then
            return data1.skillType == data2.skillType and data1.skillIndex == data2.skillIndex
        else
            return true
        end
    end
    --setup for a control when another control has been found to be equal to it
    local function EqualitySetup(fadingControlBuffer, currentEntry, newEntry)
        local currentEntryData = currentEntry.lines[1]
        local newEntryData = newEntry.lines[1]
        local control = currentEntryData.control
        if currentEntryData.entryType ~= LOOT_ENTRY_TYPE_MEDAL and currentEntryData.entryType ~= LOOT_ENTRY_TYPE_SCORE then
            currentEntryData.stackCount = currentEntryData.stackCount + newEntryData.stackCount
            if control and control.iconOverlayText then
                SetupIconOverlayText(control, currentEntryData)
                ZO_CraftingResults_Base_PlayPulse(control.iconOverlayText)
            end
        end
    end
    function ZO_LootHistory_Shared:CreateFadingStationaryControlBuffer(control, fadeLabelAnimationName, fadeIconAnimationName, fadeContainerAnimation, anchor, maxEntries, containerShowTime, containerType)
        lootStream = ZO_FadingStationaryControlBuffer:New(control, maxEntries, fadeLabelAnimationName,  fadeIconAnimationName, fadeContainerAnimation, anchor, containerType)
        lootStream:AddTemplate(self.entryTemplate, {setup = LootSetupFunction, equalityCheck = AreEntriesEqual, equalitySetup = EqualitySetup })
        lootStream:SetContainerShowTime(containerShowTime or 5000)
        return lootStream
    end
end
-- loot stream and queue functions
function ZO_LootHistory_Shared:CreateLootEntry(lootData)
    local lootEntry = {
            lines = { lootData, }
        }
    return lootEntry
end
function ZO_LootHistory_Shared:AddLootEntry(lootEntry)
    if lootEntry.isPersistent then
        self.lootStreamPersistent:AddEntry(self.entryTemplate, lootEntry)
    else
        self.lootStream:AddEntry(self.entryTemplate, lootEntry)
    end
end
function ZO_LootHistory_Shared:QueueLootEntry(lootEntry)
    table.insert(self.lootQueue, lootEntry)
end
function ZO_LootHistory_Shared:InsertOrQueue(lootEntry)
    if self.hidden then
        self:QueueLootEntry(lootEntry)
    else
        self:AddLootEntry(lootEntry)
    end
end
function ZO_LootHistory_Shared:DisplayLootQueue()
    if self.hidden then
        for i, lootEntry in ipairs(self.lootQueue) do
            self:AddLootEntry(lootEntry)
            self.lootQueue[i] = nil
        end
        self.hidden = false
    end
end
function ZO_LootHistory_Shared:HideLootQueue()
    if not self.hidden then
        self.lootStream:FadeAll()
        self.hidden = true
    end
end
do
    local CONTAINER_SHOW_TIME_MS = 3600
    local PERSISTENT_CONTAINER_SHOW_TIME_MS = 7000
    function ZO_LootHistory_Shared:GetContainerShowTime()
        return CONTAINER_SHOW_TIME_MS
    end
    function ZO_LootHistory_Shared:GetPersistentContainerShowTime()
        return PERSISTENT_CONTAINER_SHOW_TIME_MS
    end
end
-- event handlers
do
    local MONEY_TEXT = {
        [CURT_MONEY] = GetString(SI_CURRENCY_GOLD),
        [CURT_ALLIANCE_POINTS] = GetString(SI_CURRENCY_ALLIANCE_POINTS),
        [CURT_TELVAR_STONES] = GetString(SI_CURRENCY_TELVAR_STONES),
        [CURT_WRIT_VOUCHERS] = GetString(SI_CURRENCY_WRIT_VOUCHERS),
    }
    local MONEY_ICONS = {
        [CURT_MONEY] = LOOT_MONEY_ICON,
        [CURT_ALLIANCE_POINTS] = LOOT_ALLIANCE_POINT_ICON,
        [CURT_TELVAR_STONES] = LOOT_TELVAR_STONE_ICON,
        [CURT_WRIT_VOUCHERS] = LOOT_WRIT_VOUCHER_ICON,
    }
    function ZO_LootHistory_Shared:AddMoneyEntry(moneyAdded, moneyType)
        local lootData = {
                            text = MONEY_TEXT[moneyType],
                            icon = MONEY_ICONS[moneyType],
                            stackCount = moneyAdded,
                            color = ZO_SELECTED_TEXT,
                            moneyType = moneyType,
                            entryType = LOOT_ENTRY_TYPE_MONEY,
                            iconOverlayText = ZO_LootHistory_Shared.GetStackCountStringFromData,
                            showIconOverlayText = ZO_LootHistory_Shared.ShouldShowStackCountStringFromData
                        }
        local lootEntry = self:CreateLootEntry(lootData)
        lootEntry.isPersistent = true
        self:InsertOrQueue(lootEntry)
    end
end
function ZO_LootHistory_Shared:AddXpEntry(xpAdded)
    local lootData = {
                        text = GetString(SI_LOOT_HISTORY_EXPERIENCE_GAIN),
                        icon = LOOT_EXPERIENCE_ICON,
                        stackCount = xpAdded,
                        color = ZO_SELECTED_TEXT,
                        entryType = LOOT_ENTRY_TYPE_EXPERIENCE,
                        iconOverlayText = ZO_LootHistory_Shared.GetStackCountStringFromData,
                        showIconOverlayText = ZO_LootHistory_Shared.ShouldShowStackCountStringFromData
                    }
    local lootEntry = self:CreateLootEntry(lootData)
    lootEntry.isPersistent = true
    self:InsertOrQueue(lootEntry)
end
function ZO_LootHistory_Shared:AddGemEntry(gemsAdded)
    local lootData = {
                        text = GetString(SI_LOOT_HISTORY_CROWN_GEMS_GAIN),
                        icon = LOOT_GEMS_ICON,
                        stackCount = gemsAdded,
                        color = ZO_SELECTED_TEXT,
                        entryType = LOOT_ENTRY_TYPE_CROWN_GEMS,
                        iconOverlayText = ZO_LootHistory_Shared.GetStackCountStringFromData,
                        showIconOverlayText = ZO_LootHistory_Shared.ShouldShowStackCountStringFromData
                    }
    local lootEntry = self:CreateLootEntry(lootData)
    lootEntry.isPersistent = true
    self:InsertOrQueue(lootEntry)
end
function ZO_LootHistory_Shared:AddMedalEntry(medalId, name, icon, value)
    local lootData = {
                        text = zo_strformat(SI_LOOT_HISTORY_MEDAL_NAME_FORMATTER, name),
                        icon = icon,
                        value = value,
                        color = ZO_SELECTED_TEXT,
                        entryType = LOOT_ENTRY_TYPE_MEDAL,
                        iconOverlayText = ZO_LootHistory_Shared.GetMedalValueStringFromData,
                        showIconOverlayText = ZO_LootHistory_Shared.ShouldShowMedalValueStringFromData
                    }
    local lootEntry = self:CreateLootEntry(lootData)
    self:InsertOrQueue(lootEntry)
end
function ZO_LootHistory_Shared:AddScoreEntry(score)
    local lootData = {
                        text = GetString(SI_LOOT_HISTORY_LEADERBOARD_SCORE),
                        icon = LOOT_LEADERBOARD_SCORE_ICON,
                        value = score,
                        color = ZO_SELECTED_TEXT,
                        entryType = LOOT_ENTRY_TYPE_SCORE,
                        iconOverlayText = ZO_LootHistory_Shared.GetValueStringFromData,
                        showIconOverlayText = true
                    }
    local lootEntry = self:CreateLootEntry(lootData)
    lootEntry.isPersistent = true
    self:InsertOrQueue(lootEntry)
end
function ZO_LootHistory_Shared:AddSkillEntry(skillType, skillIndex, skillXpAdded)
    local skillName = GetSkillLineInfo(skillType, skillIndex)
    local announcementIcon = GetSkillLineAnnouncementIcon(skillType, skillIndex)
    local lootData = {
                        text = skillName,
                        icon = announcementIcon,
                        stackCount = skillXpAdded,
                        color = ZO_SELECTED_TEXT,
                        skillType = skillType,
                        skillIndex = skillIndex,
                        entryType = LOOT_ENTRY_TYPE_SKILL_EXPERIENCE,
                        iconOverlayText = ZO_LootHistory_Shared.GetStackCountStringFromData,
                        showIconOverlayText = ZO_LootHistory_Shared.ShouldShowStackCountStringFromData
                    }
    local lootEntry = self:CreateLootEntry(lootData)
    lootEntry.isPersistent = true
    self:InsertOrQueue(lootEntry)
end
function ZO_LootHistory_Shared:OnNewItemReceived(itemLinkOrName, stackCount, itemSound, lootType, questItemIcon, itemId, isVirtual, isStolen)
    if not self.hidden or self:CanShowItemsInHistory() then
        local itemName
        local icon
        local color
        local quality
        -- we already handle collectibles as collectibles,
        -- but if we get them as something like a quest reward, they need to be funneled properly
        if lootType == LOOT_TYPE_COLLECTIBLE then
            local collectibleId = GetCollectibleIdFromLink(itemLinkOrName)
            self:OnNewCollectibleReceived(collectibleId)
            return
        end
        if lootType == LOOT_TYPE_QUEST_ITEM then
            itemName = itemLinkOrName --quest items don't support item linking, this just returns their name.
            icon = questItemIcon
            color = ZO_ColorDef:New(GetInterfaceColor(INTERFACE_COLOR_TYPE_ITEM_TOOLTIP, ITEM_TOOLTIP_COLOR_QUEST_ITEM_NAME))
        else
            itemName = GetItemLinkName(itemLinkOrName)
            icon = GetItemLinkInfo(itemLinkOrName)
            quality = GetItemLinkQuality(itemLinkOrName)
            color = ZO_ColorDef:New(GetInterfaceColor(INTERFACE_COLOR_TYPE_ITEM_QUALITY_COLORS, quality))
        end
        local statusIcon
        local highlight
        if isVirtual then
            statusIcon = self:GetCraftBagIcon()
            highlight = self:GetCraftBagHighlight()
        elseif isStolen then
            statusIcon = self:GetStolenIcon()
            highlight = self:GetStolenHighlight()
        end
        local lootData = {
                            text = zo_strformat(SI_TOOLTIP_ITEM_NAME, itemName),
                            icon = icon,
                            stackCount = stackCount,
                            color = color,
                            itemId = itemId,
                            quality = quality,
                            isCraftBagItem = isVirtual,
                            isStolen = isStolen,
                            statusIcon = statusIcon,
                            highlight = highlight,
                            entryType = LOOT_ENTRY_TYPE_ITEM,
                            iconOverlayText = ZO_LootHistory_Shared.GetStackCountStringFromData,
                            showIconOverlayText = ZO_LootHistory_Shared.ShouldShowStackCountStringFromData
                        }
        local lootEntry = self:CreateLootEntry(lootData)
        self:InsertOrQueue(lootEntry)
    end
end
function ZO_LootHistory_Shared:OnNewCollectibleReceived(collectibleId)
    if not self.hidden or self:CanShowItemsInHistory() then
        local name, _, icon = GetCollectibleInfo(collectibleId)
        local QUALITY_NORMAL = 1
        local lootData = {
                            text = zo_strformat(SI_TOOLTIP_ITEM_NAME, name),
                            icon = icon,
                            stackCount = 1,
                            color = ZO_ColorDef:New(GetInterfaceColor(INTERFACE_COLOR_TYPE_ITEM_QUALITY_COLORS, QUALITY_NORMAL)),
                            collectibleId = collectibleId,
                            entryType = LOOT_ENTRY_TYPE_COLLECTIBLE,
                            iconOverlayText = ZO_LootHistory_Shared.GetStackCountStringFromData,
                            showIconOverlayText = ZO_LootHistory_Shared.ShouldShowStackCountStringFromData
                        }
        local lootEntry = self:CreateLootEntry(lootData)
        self:InsertOrQueue(lootEntry)
    end
end
function ZO_LootHistory_Shared:OnGoldUpdate(newGold, oldGold, reason)
    -- pickpocket is handled by OnGoldPickpocket
    if reason ~= CURRENCY_CHANGE_REASON_PICKPOCKET and reason ~= CURRENCY_CHANGE_REASON_PLAYER_INIT then
        local goldAdded = newGold - oldGold
        if goldAdded > 0 then
            self:AddMoneyEntry(goldAdded, CURT_MONEY)
        end
    end
end
function ZO_LootHistory_Shared:OnGoldPickpocket(goldAmount)
    self:AddMoneyEntry(goldAmount, CURT_MONEY)
end
function ZO_LootHistory_Shared:OnAlliancePointUpdate(currentAlliancePoints, playSound, difference)
    if difference > 0 then
        self:AddMoneyEntry(difference, CURT_ALLIANCE_POINTS)
    end
end
function ZO_LootHistory_Shared:OnTelvarStoneUpdate(newTelvarStones, oldTelvarStones, reason)
    if reason ~= CURRENCY_CHANGE_REASON_PLAYER_INIT then
        local tvStonesAdded = newTelvarStones - oldTelvarStones
        if tvStonesAdded > 0 then
            self:AddMoneyEntry(tvStonesAdded, CURT_TELVAR_STONES)
        end
    end
end
function ZO_LootHistory_Shared:OnWritVoucherUpdate(newWritVouchers, oldWritVouchers, reason)
    if reason == CURRENCY_CHANGE_REASON_LOOT or reason == CURRENCY_CHANGE_REASON_QUESTREWARD then
        local writVouchersAdded = newWritVouchers - oldWritVouchers
        if writVouchersAdded > 0 then
            self:AddMoneyEntry(writVouchersAdded, CURT_WRIT_VOUCHERS)
        end
    end
end
function ZO_LootHistory_Shared:OnExperienceGainUpdate(reason, level, previousExperience, currentExperience)
    local difference = currentExperience - previousExperience
    self:AddXpEntry(difference)
end
function ZO_LootHistory_Shared:OnCrownGemUpdate(totalGems, gemDifference)
    if gemDifference > 0 then
        self:AddGemEntry(gemDifference)
    end
end
function ZO_LootHistory_Shared:OnMedalAwarded(medalId, name, icon, value)
    self:AddMedalEntry(medalId, name, icon, value)
end
function ZO_LootHistory_Shared:OnBattlegroundScoreboardUpdated()
    local playerIndex = GetScoreboardPlayerEntryIndex()
    self:AddScoreEntry(GetScoreboardEntryScoreByType(playerIndex, SCORE_TRACKER_TYPE_SCORE))
end
do
    local ALLOWED_SKILL_TYPES = 
    {
        [SKILL_TYPE_GUILD] = true
    }
    function ZO_LootHistory_Shared:OnSkillExperienceUpdated(skillType, skillIndex, reason, rank, previousXP, currentXP)
        local delta = currentXP - previousXP
        if delta > 0 and ALLOWED_SKILL_TYPES[skillType] then
            self:AddSkillEntry(skillType, skillIndex, delta)
        end
    end
end
do
    local USE_LOWERCASE_NUMBER_SUFFIXES = false
    function ZO_LootHistory_Shared.GetStackCountStringFromData(data)
        return ZO_AbbreviateNumber(data.stackCount, NUMBER_ABBREVIATION_PRECISION_TENTHS, USE_LOWERCASE_NUMBER_SUFFIXES)
    end
    function ZO_LootHistory_Shared.GetValueStringFromData(data)
        return ZO_AbbreviateNumber(data.value, NUMBER_ABBREVIATION_PRECISION_TENTHS, USE_LOWERCASE_NUMBER_SUFFIXES)
    end
end
function ZO_LootHistory_Shared.ShouldShowStackCountStringFromData(data)
    return data.stackCount > 1
end
function ZO_LootHistory_Shared.GetMedalValueStringFromData(data)
    return zo_strformat(SI_LOOT_HISTORY_MEDAL_VALUE_FORMATTER, data.value)
end
function ZO_LootHistory_Shared.ShouldShowMedalValueStringFromData(data)
    return data.value > 0
end
function ZO_LootHistory_Shared.GetIconOverlayTextFromData(data)
    local overlayText = data.iconOverlayText
    if type(overlayText) == "function" then
        overlayText = overlayText(data)
    end
    return overlayText
end
function ZO_LootHistory_Shared.GetShowIconOverlayTextFromData(data)
    local showOverlayText = data.showIconOverlayText
    if type(showOverlayText) == "function" then
        showOverlayText = showOverlayText(data)
    end
    return showOverlayText
end
-- functions to be overridden
function ZO_LootHistory_Shared:SetEntryTemplate()
    assert(false)
end
function ZO_LootHistory_Shared:InitializeFragment()
    -- To be overridden
end
function ZO_LootHistory_Shared:InitializeFadingControlBuffer(control)
    -- To be overridden
end
function ZO_LootHistory_Shared:CanShowItemsInHistory()
    return false -- default value
end
function ZO_LootHistory_Shared:GetCraftBagIcon()
    -- To be overridden
end
function ZO_LootHistory_Shared:GetStolenIcon()
    -- To be overridden
end
function ZO_LootHistory_Shared:GetCraftBagHighlight()
    -- To be overridden
end
function ZO_LootHistory_Shared:GetStolenHighlight()
    -- To be overridden
end
-- global functions
    control.icon = control:GetNamedChild("Icon")
    control.iconOverlayText = control.icon:GetNamedChild("OverlayText")
    control.label = control:GetNamedChild("Label")
    control.background = control:GetNamedChild("Bg")
    control.statusIcon = control.icon:GetNamedChild("StatusIcon")
    control.backgroundHighlight = control.background:GetNamedChild("Highlight")
end