Back to Home

ESO Lua File v101050

ingame/giftinventory/giftinventory_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
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
ZO_Gift_Base = ZO_Object:Subclass()
--Gift Base
function ZO_Gift_Base:New(...)
    local object = ZO_Object.New(self)
    object:Initialize(...)
    return object
end
function ZO_Gift_Base:Initialize(giftId, state, seen, marketProductId, senderName, recipientName, expirationTimeStampS, note, quantity)
    self.giftId = giftId
    self.state = state
    self.seen = seen
    self.marketProductId = marketProductId
    self.quantity = quantity
    self:SetPlayerName(senderName, recipientName)
    self.expirationTimeStampS = expirationTimeStampS
    self.note = note
    local description
    self.name, description, self.icon = GetMarketProductInfo(marketProductId)
    self.stackCount = GetMarketProductStackCount(marketProductId)
    self.qualityColor = GetItemQualityColor(GetMarketProductDisplayQuality(marketProductId))
    local color = GetItemQualityColor(GetMarketProductDisplayQuality(marketProductId))
    local houseId = GetMarketProductHouseId(marketProductId)
    if houseId > 0 then
        local houseCollectibleId = GetCollectibleIdForHouse(houseId)
        local houseDisplayName = GetCollectibleName(houseCollectibleId)
        self.formattedName = self.qualityColor:Colorize(ZO_CachedStrFormat(SI_MARKET_PRODUCT_HOUSE_NAME_FORMATTER, houseDisplayName, self.name))
    else
        self.formattedName = ZO_CachedStrFormat(SI_MARKET_PRODUCT_NAME_FORMATTER, self.qualityColor:Colorize(self.name))
    end
end
function ZO_Gift_Base:GetGiftId()
    return self.giftId
end
function ZO_Gift_Base:GetMarketProductId()
    return self.marketProductId
end
function ZO_Gift_Base:GetQuantity()
    return self.quantity
end
function ZO_Gift_Base:GetClaimQuantity()
    return GetGiftClaimableQuantity(self.giftId)
end
function ZO_Gift_Base:GetQualityColor()
    return self.qualityColor
end
function ZO_Gift_Base:GetName()
    return self.name
end
function ZO_Gift_Base:GetFormattedName()
    return self.formattedName
end
function ZO_Gift_Base:GetIcon()
    return self.icon
end
function ZO_Gift_Base:GetStackCount()
    return self.stackCount
end
function ZO_Gift_Base:SetPlayerName(senderName, recipientName)
    assert(false) -- Must be overriden
end
function ZO_Gift_Base:GetPlayerName()
    return self.playerName
end
function ZO_Gift_Base:GetUserFacingPlayerName()
    return ZO_FormatUserFacingDisplayName(self.playerName)
end
function ZO_Gift_Base:GetState()
    return self.state
end
function ZO_Gift_Base:IsState(state)
    return self.state == state
end
function ZO_Gift_Base:HasBeenSeen()
    return self.seen
end
function ZO_Gift_Base:GetNote()
    return self.note
end
function ZO_Gift_Base:AreGiftIdsEqual(gift)
    return AreId64sEqual(self.giftId, gift.giftId)
end
function ZO_Gift_Base:GetSecondsUntilExpiration()
    return zo_max(0, self.expirationTimeStampS - os.time())
end
function ZO_Gift_Base:View()
    ViewGifts(self.giftId)
end
function ZO_Gift_Base:CanMarkViewedFromList()
    -- Some gifts can be considered viewed simply by seeing/selecting them in a list, without requiring any kind of interaction
    return not self:HasBeenSeen()
end
--Received Gift
ZO_ReceivedGift = ZO_Gift_Base:Subclass()
function ZO_ReceivedGift:New(...)
    return ZO_Gift_Base.New(self, ...)
end
function ZO_ReceivedGift:TakeGift(note)
    TakeGift(self.giftId, note)
end
function ZO_ReceivedGift:ReturnGift(note)
    ReturnGift(self.giftId, note)
end
function ZO_ReceivedGift:GetGiftBoxIcon()
    -- Leaving this as a function in case we add "dynamic" gift icons in the future
    return "EsoUI/Art/Icons/Gift_Box_003.dds"
end
function ZO_ReceivedGift:SetPlayerName(senderName, recipientName)
    self.playerName = senderName
end
function ZO_ReceivedGift:CanMarkViewedFromList()
    return false
end
--Returned Gift
ZO_ReturnedGift = ZO_Gift_Base:Subclass()
function ZO_ReturnedGift:New(...)
    return ZO_Gift_Base.New(self, ...)
end
function ZO_ReturnedGift:RequestResendGift()
    RequestResendGift(self.giftId)
end
function ZO_ReturnedGift:SetPlayerName(senderName, recipientName)
    self.playerName = recipientName
end
--Thanked Gift
ZO_ThankedGift = ZO_Gift_Base:Subclass()
function ZO_ThankedGift:New(...)
    return ZO_Gift_Base.New(self, ...)
end
function ZO_ThankedGift:DeleteGift()
    DeleteGift(self.giftId)
end
function ZO_ThankedGift:SetPlayerName(senderName, recipientName)
    self.playerName = recipientName
end
function ZO_ThankedGift:CanMarkViewedFromList()
    if self:GetNote() == "" then
        return ZO_Gift_Base.CanMarkViewedFromList(self)
    end
    return false
end
--Sent Gift
ZO_SentGift = ZO_Gift_Base:Subclass()
function ZO_SentGift:New(...)
    return ZO_Gift_Base.New(self, ...)
end
function ZO_SentGift:SetPlayerName(senderName, recipientName)
    self.playerName = recipientName
end
function ZO_SentGift:CanMarkViewedFromList()
    -- Sent gifts are never unseen
    return false
end
--Gift Manager
--These change types are ordered. A higher number includes the possibility of a lower number change as well.
--Gifts were added to or removed from a list
ZO_GIFT_LIST_CHANGE_TYPE_LIST = 2
--Gifts in a list changed seen state
ZO_GIFT_LIST_CHANGE_TYPE_SEEN = 1
function ZO_GetNextGiftIdIter(state, var1)
    return GetNextGiftId(var1)
end
ZO_GiftInventory_Manager = ZO_CallbackObject:Subclass()
function ZO_GiftInventory_Manager:New()
    local object = ZO_CallbackObject.New(self)
    object:Initialize()
    return object
end
function ZO_GiftInventory_Manager:Initialize()
    self.giftsByState = {}
    for state = GIFT_STATE_ITERATION_BEGIN, GIFT_STATE_ITERATION_END do
        self.giftsByState[state] = {}
    end
    EVENT_MANAGER:RegisterForEvent("GiftInventoryManager", EVENT_GIFTS_UPDATED, function() self:OnGiftsUpdated() end)
    EVENT_MANAGER:RegisterForEvent("GiftInventoryManager", EVENT_GIFT_ACTION_RESULT, function(eventId, ...) self:OnGiftActionResult(...) end)
    EVENT_MANAGER:RegisterForEvent("GiftInventoryManager", EVENT_REQUEST_SHOW_GIFT_INVENTORY, function(eventId, ...) self.ShowGiftInventory(...) end)
end
-- ... are gift states that you care about
function ZO_GiftInventory_Manager:GetHighestChangeType(changedLists, ...)
    local highestChangeType
    for i = 1, select("#", ...) do
        local state = select(i, ...)
        local changeType = changedLists[state]
        if changeType then
            if not highestChangeType then
                highestChangeType = changeType
            else
                highestChangeType = zo_max(changeType, highestChangeType)
            end
        end
    end
    return highestChangeType
end
function ZO_GiftInventory_Manager:GetGiftList(state)
    return self.giftsByState[state]
end
function ZO_GiftInventory_Manager:CreateGiftObject(giftId)
    local state, seen, marketProductId, senderName, recipientName, expirationTimeStampS, note, quantity = GetGiftInfo(giftId)
    local class
    if state == GIFT_STATE_RECEIVED then
        class = ZO_ReceivedGift
    elseif state == GIFT_STATE_RETURNED then
        class = ZO_ReturnedGift
    elseif state == GIFT_STATE_THANKED then
        class = ZO_ThankedGift
    elseif state == GIFT_STATE_SENT then
        class = ZO_SentGift
    end
    return class:New(giftId, state, seen, marketProductId, senderName, recipientName, expirationTimeStampS, note, quantity)
end
function ZO_GiftInventory_Manager:AddGiftToTemporaryUpdatedGiftList(temporaryUpdatedGiftsByState, giftId)
    local gift = self:CreateGiftObject(giftId)
    local state = gift:GetState()
    local temporaryUpdatedGiftsList = temporaryUpdatedGiftsByState[state]
    table.insert(temporaryUpdatedGiftsList, gift)
end
function ZO_GiftInventory_Manager:UpdateGiftListByState(state, temporaryUpdatedGiftsList)
    local oldGiftsList = self.giftsByState[state]
    local listChangeType
    if #oldGiftsList ~= #temporaryUpdatedGiftsList then
        listChangeType = ZO_GIFT_LIST_CHANGE_TYPE_LIST
    else
        for _, oldGift in ipairs(oldGiftsList) do
            local foundUpdatedGiftInOldGifts = false
            for _, updatedGift in ipairs(temporaryUpdatedGiftsList) do
                if oldGift:AreGiftIdsEqual(updatedGift) then
                    foundUpdatedGiftInOldGifts = true
                    if oldGift:HasBeenSeen() ~= updatedGift:HasBeenSeen() then
                        listChangeType = ZO_GIFT_LIST_CHANGE_TYPE_SEEN
                        oldGift.seen = updatedGift.seen
                    end
                    break
                end
            end
            if not foundUpdatedGiftInOldGifts then
                listChangeType = ZO_GIFT_LIST_CHANGE_TYPE_LIST
                break
            end
        end
    end
    if listChangeType == ZO_GIFT_LIST_CHANGE_TYPE_LIST then
        self.giftsByState[state] = temporaryUpdatedGiftsList
    end
    return listChangeType
end
function ZO_GiftInventory_Manager:OnGiftsUpdated()
    local temporaryUpdatedGiftsByState = {}
    for state = GIFT_STATE_ITERATION_BEGIN, GIFT_STATE_ITERATION_END do
        temporaryUpdatedGiftsByState[state] = {}
    end
    for giftId in ZO_GetNextGiftIdIter do
        self:AddGiftToTemporaryUpdatedGiftList(temporaryUpdatedGiftsByState, giftId)
    end
    local changedLists = {}
    local hasAtLeastOneChangedList = false
    for state, temporaryUpdatedGiftsList in pairs(temporaryUpdatedGiftsByState) do
        local listChangeType = self:UpdateGiftListByState(state, temporaryUpdatedGiftsList)
        if listChangeType then
            hasAtLeastOneChangedList = true
            changedLists[state] = listChangeType
        end
    end
    if hasAtLeastOneChangedList then
        self:FireCallbacks("GiftListsChanged", changedLists)
    end
end
function ZO_GiftInventory_Manager:OnGiftActionResult(giftAction, result, giftId)
    self:FireCallbacks("GiftActionResult", giftAction, result, giftId)
end
function ZO_GiftInventory_Manager:HasAnyUnseenGiftsByState(state)
    local gifts = self.giftsByState[state]
    if gifts then
        for _, gift in ipairs(gifts) do
            if not gift:HasBeenSeen() then
                return true
            end
        end
    end
    return false
end
function ZO_GiftInventory_Manager:HasAnyUnseenGifts()
    for state = GIFT_STATE_ITERATION_BEGIN, GIFT_STATE_ITERATION_END do
        if self:HasAnyUnseenGiftsByState(state) then
            return true
        end
    end
    return false
end
--Comparators
do
    local SORTS =
    {
        ["seen"] =
        {
            ["seen"] = { tiebreaker = "expirationTimeStampS" },
            ["expirationTimeStampS"] = { tiebreaker = "giftId" },
            ["giftId"] = { isId64 = true },
        },
        ["playerName"] =
        {
            ["playerName"] = { tiebreaker = "seen", tieBreakerSortOrder = ZO_SORT_ORDER_UP },
            ["seen"] = { tiebreaker = "giftId" },
            ["giftId"] = { isId64 = true },
        },
        ["expirationTimeStampS"] =
        {
            ["expirationTimeStampS"] = { tiebreaker = "giftId" },
            ["giftId"] = { isId64 = true },
        },
    }
    function ZO_GiftInventory_Manager.CompareReceived(leftGift, rightGift, sortKey, sortOrder)
        return ZO_TableOrderingFunction(leftGift, rightGift, sortKey, SORTS[sortKey], sortOrder)
    end
end
do
    local SORTS =
    {
        ["seen"] =
        {
            ["seen"] = { tiebreaker = "expirationTimeStampS" },
            ["expirationTimeStampS"] = { tiebreaker = "giftId" },
            ["giftId"] = { isId64 = true },
        },
        ["playerName"] =
        {
            ["playerName"] = { tiebreaker = "seen", tieBreakerSortOrder = ZO_SORT_ORDER_UP },
            ["seen"] = { tiebreaker = "giftId" },
            ["giftId"] = { isId64 = true },
        },
        ["name"] =
        {
            ["name"] = { tiebreaker = "seen", tieBreakerSortOrder = ZO_SORT_ORDER_UP },
            ["seen"] = { tiebreaker = "giftId" },
            ["giftId"] = { isId64 = true },
        },
        ["expirationTimeStampS"] =
        {
            ["expirationTimeStampS"] = { tiebreaker = "giftId" },
            ["giftId"] = { isId64 = true },
        },
        ["state"] =
        {
            ["state"] = { tiebreaker = "expirationTimeStampS" },
            ["expirationTimeStampS"] = { tiebreaker = "giftId", tieBreakerSortOrder = ZO_SORT_ORDER_UP },
            ["giftId"] = { isId64 = true },
        },
    }
    function ZO_GiftInventory_Manager.CompareSent(leftGift, rightGift, sortKey, sortOrder)
        return ZO_TableOrderingFunction(leftGift, rightGift, sortKey, SORTS[sortKey], sortOrder)
    end
end
do
    local SORTS =
    {
        ["seen"] =
        {
            ["seen"] = { tiebreaker = "giftId" },
            ["giftId"] = { isId64 = true },
        },
        ["playerName"] =
        {
            ["playerName"] = { tiebreaker = "seen", tieBreakerSortOrder = ZO_SORT_ORDER_UP },
            ["seen"] = { tiebreaker = "giftId" },
            ["giftId"] = { isId64 = true },
        },
        ["name"] =
        {
            ["name"] = { tiebreaker = "seen", tieBreakerSortOrder = ZO_SORT_ORDER_UP },
            ["seen"] = { tiebreaker = "giftId" },
            ["giftId"] = { isId64 = true },
        },
    }
    function ZO_GiftInventory_Manager.CompareReturned(leftGift, rightGift, sortKey, sortOrder)
        return ZO_TableOrderingFunction(leftGift, rightGift, sortKey, SORTS[sortKey], sortOrder)
    end
end
function ZO_GiftInventory_Manager.ShowGiftInventory(giftState)
    local mainMenu = SYSTEMS:GetObject("mainMenu")
    if IsInGamepadPreferredMode() then
        GIFT_INVENTORY_GAMEPAD:SetSelectedCategoryByGiftState(giftState)
        mainMenu:ShowCategory(MENU_CATEGORY_GIFT_INVENTORY)
    else
        GIFT_INVENTORY_KEYBOARD:SetSelectedCategoryByGiftState(giftState)
        mainMenu:ShowSceneGroup("marketSceneGroup", "giftInventoryKeyboard")
    end
end
GIFT_INVENTORY_MANAGER = ZO_GiftInventory_Manager:New()