Back to Home

ESO Lua File v101049

ingame/timedactivities/timedactivities_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
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
523
524
local PRIMARY_SYSTEM_CURRENCY = CURT_SEALS
-- Timed Activity Data --
ZO_TimedActivityData = ZO_InitializingObject:Subclass()
function ZO_TimedActivityData:Initialize(index)
    self.index = index
    -- For troubleshooting purposes only
    self.timedActivityId = GetTimedActivityId(index)
    self.encodedId = GetTimedActivityEncodedId(index)
end
function ZO_TimedActivityData:GetIndex()
    return self.index
end
function ZO_TimedActivityData:GetId()
    return self.timedActivityId
end
function ZO_TimedActivityData:GetEncodedId()
    return self.encodedId
end
function ZO_TimedActivityData:GetName()
    return GetTimedActivityName(self.index)
end
function ZO_TimedActivityData:GetDescription()
    return GetTimedActivityDescription(self.index)
end
function ZO_TimedActivityData:GetType()
    return GetTimedActivityType(self.index)
end
function ZO_TimedActivityData:IsDailyActivity()
    return self:GetType() == TIMED_ACTIVITY_TYPE_DAILY
end
function ZO_TimedActivityData:IsWeeklyActivity()
    return self:GetType() == TIMED_ACTIVITY_TYPE_WEEKLY
end
function ZO_TimedActivityData:IsSeasonalActivity()
    return self:GetType() == TIMED_ACTIVITY_TYPE_SEASONAL
end
function ZO_TimedActivityData:GetDifficulty()
    return GetTimedActivityDifficulty(self.index)
end
function ZO_TimedActivityData:GetNumRewards()
    return GetNumTimedActivityRewards(self.index)
end
function ZO_TimedActivityData:GetRewardInfo(rewardIndex)
    local rewardId, rewardQuantity = GetTimedActivityRewardInfo(self.index, rewardIndex)
    return rewardId, rewardQuantity
end
function ZO_TimedActivityData:GetCurrencyRewardInfo()
    local rewardCurrency, rewardCurrencyAmount = GetTimedActivityCurrencyRewardInfo(self.index)
    return rewardCurrency, rewardCurrencyAmount
end
function ZO_TimedActivityData:GetProgress()
    return GetTimedActivityProgress(self.index)
end
function ZO_TimedActivityData:GetMaxProgress()
    return GetTimedActivityMaxProgress(self.index)
end
function ZO_TimedActivityData:IsCompleted()
    -- IsCompleted here means that the current progress is at maximum. It may or may not also be claimable (CanClaim) or fully claimed (IsFullyClaimed).
    -- This definition of complete differs from the backend, which considers fully claimed activities to be "complete".
    return self:GetProgress() >= self:GetMaxProgress()
end
function ZO_TimedActivityData:GetEndTimeS()
    return GetTimedActivityEndTimeS(self.index)
end
function ZO_TimedActivityData:GetTimeRemainingS()
    local activeSeasonEndTimeS = TIMED_ACTIVITIES_MANAGER:GetActiveSeasonEndTimeS()
    if activeSeasonEndTimeS then
        local endTimeS = self:GetEndTimeS()
        -- Any activity that ends when the season ends we don't want to show the time for
        if endTimeS > 0 and endTimeS ~= activeSeasonEndTimeS then
            return zo_max(0, endTimeS - GetTimeStamp())
        end
    end
    return nil -- No end time, so time remaining is infinite
end
function ZO_TimedActivityData:IsExpired()
    local timeRemainingS = self:GetTimeRemainingS()
    -- nil time remaining never expires
    return timeRemainingS == 0
end
do
    local function TimedActivityRewardComparator(left, right)
        local leftRewardId = left:GetRewardId()
        local rightRewardId = right:GetRewardId()
        local leftQuanitity = left:GetQuantity()
        local rightQuanitity = right:GetQuantity()
        if leftRewardId == rightRewardId then
            -- Same rewards fall back to quantity (shouldn't happen)
            return leftQuanitity > rightQuanitity
        end
        local leftRewardType = left:GetRewardType()
        local rightRewardType = right:GetRewardType()
        if leftRewardType ~= rightRewardType then
            if leftRewardType == REWARD_ENTRY_TYPE_ADD_CURRENCY then
                -- Currency reward before non-currnecy reward
                return true
            elseif rightRewardType == REWARD_ENTRY_TYPE_ADD_CURRENCY then
                -- Non-currency reward after currency rewards
                return false
            else
                -- Order non-currencies by reward type
                return leftRewardType < rightRewardType
            end
        end
        -- Same type of reward
        if leftRewardType == REWARD_ENTRY_TYPE_ADD_CURRENCY then
            local leftCurrencyType = left:GetCurrencyType()
            local rightCurrencyType = right:GetCurrencyType()
            if leftCurrencyType ~= rightCurrencyType then
                if leftCurrencyType == PRIMARY_SYSTEM_CURRENCY then
                    -- The system's primary currency before secondary currencies
                    return true
                elseif rightCurrencyType == PRIMARY_SYSTEM_CURRENCY then
                    -- Secondary currencies after the system's primary currency
                    return false
                else
                    -- Fall back to currency type order
                    return leftCurrencyType < rightCurrencyType
                end
            end
            -- Fall back to default behavior (shouldn't happen)
        elseif leftRewardType == REWARD_ENTRY_TYPE_SKILL_LINE_EXPERIENCE then
            local leftSkillLineId = left:GetSkillLineId()
            local rightSkillLineId = right:GetSkillLineId()
            if leftSkillLineId ~= rightSkillLineId then
                -- Order by skill line id
                return leftSkillLineId < rightSkillLineId
            end
            -- Fall back to default behavior (shouldn't happen)
        elseif leftRewardType == REWARD_ENTRY_TYPE_EXPERIENCE then
            -- Fall back to default behavior (shouldn't happen)
        else
            -- Report unsupported type, fall back to default behavior
            internalassert(false, string.format("Unsupported reward type %d for Timed Activities", leftRewardType))
        end
        -- Default behavior
        if leftQuanitity == rightQuanitity then
            -- Ultimate fall back to reward id
            return leftRewardId > rightRewardId
        else
            -- Fall back to quantity
            return leftQuanitity > rightQuanitity
        end
    end
    function ZO_TimedActivityData:GetRewardList()
        if not self.rewardList then
            self.rewardList = {}
            local numRewards = self:GetNumRewards()
            if numRewards > 0 then
                for rewardIndex = 1, numRewards do
                    local rewardId, quantity = self:GetRewardInfo(rewardIndex)
                    local rewardData = REWARDS_MANAGER:GetInfoForReward(rewardId, quantity)
                    table.insert(self.rewardList, rewardData)
                end
                table.sort(self.rewardList, TimedActivityRewardComparator)
            end
        end
        return self.rewardList
    end
end
function ZO_TimedActivityData:GetTotalNumTimesClaimable()
end
function ZO_TimedActivityData:GetNumTimesClaimed()
    return GetTimedActivityNumTimesClaimed(self.index)
end
function ZO_TimedActivityData:IsFullyClaimed()
    local totalNumTimesClaimable = self:GetTotalNumTimesClaimable()
    if totalNumTimesClaimable > 0 then
        return self:GetNumTimesClaimed() == totalNumTimesClaimable
    else
        return false
    end
end
function ZO_TimedActivityData:IsFullyClaimedOrExpired()
    return self:IsFullyClaimed() or self:IsExpired()
end
function ZO_TimedActivityData:CanClaim()
    return not self:IsFullyClaimed() and self:IsCompleted()
end
function ZO_TimedActivityData:Claim()
end
function ZO_TimedActivityData:CanReroll()
    return self:GetNumTimesClaimed() == 0 and not self:IsSeasonalActivity()
end
function ZO_TimedActivityData:Reroll()
    local result = RerollTimedActivity(self.index)
    return result
end
function ZO_TimedActivityData:CanTrack()
    local numTimesClaimed = self:GetNumTimesClaimed()
    local numTimesClaimable = self:GetTotalNumTimesClaimable()
    local numClaimsRemaining = numTimesClaimable - numTimesClaimed
    if numClaimsRemaining > 1 then
        return true
    elseif numClaimsRemaining == 1 then
        return not self:IsCompleted()
    end
    return false
end
function ZO_TimedActivityData:IsTracked()
    local index = GetTrackedTimedActivityInfo()
    return self.index == index
end
function ZO_TimedActivityData:ToggleTracking(suppressSound)
    if self:IsTracked() then
        ClearTrackedTimedActivity()
        if not suppressSound then
            PlaySound(SOUNDS.TRACK_TIMED_ACTIVITY_UNCLICK)
        end
    else
        TrackTimedActivity(self.index)
        if not suppressSound then
            PlaySound(SOUNDS.TRACK_TIMED_ACTIVITY_CLICK)
        end
    end
end
function ZO_TimedActivityData:Equals(otherData)
    return AreId64sEqual(self:GetEncodedId(), otherData:GetEncodedId())
end
-- Timed Activities Manager --
ZO_TimedActivities_Manager = ZO_InitializingCallbackObject:Subclass()
function ZO_TimedActivities_Manager:Initialize()
    self.availableActivityTypes = {}
    self.activitiesData = {}
    self.seenActivityEncodedIds = SAVED_KEYS:GetOrCreateSavedKeys("SeenActivityEncodedIds")
    local function OnSeenActivitiesUpdated()
        self:RefreshMainMenu()
        self:FireCallbacks("SeenActivitiesUpdated")
    end
    self.seenActivityEncodedIds:RegisterCallback("AddedKeys", OnSeenActivitiesUpdated)
    self.seenActivityEncodedIds:RegisterCallback("RemovedKeys", OnSeenActivitiesUpdated)
end
function ZO_TimedActivities_Manager:RefreshMainMenu()
    MAIN_MENU_GAMEPAD:RefreshLists()
    if not ZO_IsConsoleOrGameCoreUI() then
        MAIN_MENU_KEYBOARD:RefreshCategoryBar()
    end
end
function ZO_TimedActivities_Manager:RefreshAvailability()
    local isSystemAvailable = IsTimedActivitySystemAvailable()
    for activityType = TIMED_ACTIVITY_TYPE_MIN_VALUE, TIMED_ACTIVITY_TYPE_MAX_VALUE do
        self.availableActivityTypes[activityType] = isSystemAvailable and self:GetNumTimedActivities(activityType) > 0
    end
    self:FireCallbacks("OnRefreshAvailability", self.availableActivityTypes)
end
function ZO_TimedActivities_Manager:GetAvailableActivityTypes()
    return self.availableActivityTypes
end
function ZO_TimedActivities_Manager:RefreshMasterList()
    ZO_ClearNumericallyIndexedTable(self.activitiesData)
    local numTimedActivities = GetNumTimedActivities()
    for index = 1, numTimedActivities do
        local timedActivityData = ZO_TimedActivityData:New(index)
        table.insert(self.activitiesData, timedActivityData)
    end
    self:FireCallbacks("OnActivitiesUpdated")
end
function ZO_TimedActivities_Manager:RefreshSingleMasterListItem(index)
    self.activitiesData[index] = ZO_TimedActivityData:New(index)
    self:FireCallbacks("OnActivityUpdated", index)
end
function ZO_TimedActivities_Manager:RegisterEvents()
    local function OnActivitiesUpdated()
        self:RefreshMasterList()
    end
    local function OnActivityUpdated(_, index)
        self:RefreshSingleMasterListItem(index)
    end
    local function OnSystemStatusUpdated()
        self:RefreshAvailability()
    end
    local function UpdateSeasonEndTime()
        local endTimeS = GetActiveTamrielTomeSeasonEndTimeS()
        self.activeSeasonEndTimeS = endTimeS > 0 and endTimeS or nil
    end
    local function OnPlayerActivated()
        self:RefreshMasterList()
        UpdateSeasonEndTime()
    end
    EVENT_MANAGER:RegisterForEvent("TimedActivitiesManager", EVENT_PLAYER_ACTIVATED, OnPlayerActivated)
    EVENT_MANAGER:RegisterForEvent("TimedActivitiesManager", EVENT_TIMED_ACTIVITIES_UPDATED, OnActivitiesUpdated)
    EVENT_MANAGER:RegisterForEvent("TimedActivitiesManager", EVENT_TIMED_ACTIVITY_TRACKING_UPDATED, OnActivitiesUpdated)
    EVENT_MANAGER:RegisterForEvent("TimedActivitiesManager", EVENT_TIMED_ACTIVITY_PROGRESS_UPDATED, OnActivityUpdated)
    EVENT_MANAGER:RegisterForEvent("TimedActivitiesManager", EVENT_TIMED_ACTIVITY_SYSTEM_STATUS_UPDATED, OnSystemStatusUpdated)
    EVENT_MANAGER:RegisterForEvent("TimedActivitiesManager", EVENT_OPEN_TIMED_ACTIVITIES, ZO_ShowTimedActivities)
    EVENT_MANAGER:RegisterForEvent("TimedActivitiesManager", EVENT_HOLIDAYS_CHANGED, UpdateSeasonEndTime)
end
function ZO_TimedActivities_Manager:ActivitiesIterator(filterFunctions)
    return ZO_FilteredNumericallyIndexedTableIterator(self.activitiesData, filterFunctions)
end
function ZO_TimedActivities_Manager:GetActivityDatasByFilter(filterFunctions)
    local activityDatas = {}
    for index, activityData in self:ActivitiesIterator(filterFunctions) do
        table.insert(activityDatas, activityData)
    end
    return activityDatas
end
function ZO_TimedActivities_Manager:GetFirstActivityDataByFilter(filterFunctions)
    for index, activityData in self:ActivitiesIterator(filterFunctions) do
        return activityData
    end
    return nil
end
function ZO_TimedActivities_Manager:GetActivityDataByTypeAndId(timedActivityType, timedActivityId)
    local function ActivityMatches(activityData)
        return activityData:GetType() == timedActivityType and activityData:GetId() == timedActivityId
    end
end
function ZO_TimedActivities_Manager:GetActivityDatasByType(timedActivityType)
    local function ActivityMatches(activityData)
        return activityData:GetType() == timedActivityType
    end
end
function ZO_TimedActivities_Manager:GetClaimableActivityDatasByActivityType(timedActivityType)
    local ActivityMatches
    if timedActivityType then
        ActivityMatches = function(activityData)
            return activityData:CanClaim() and activityData:GetType() == timedActivityType
        end
    else
        ActivityMatches = function(activityData)
            return activityData:CanClaim()
        end
    end
end
function ZO_TimedActivities_Manager:GetActivityDatasByEncodedIds(timedActivityEncodedIds)
    local function ActivityMatches(activityData)
        return ZO_IsElementInNumericallyIndexedTable(timedActivityEncodedIds, activityData:GetEncodedId())
    end
end
function ZO_TimedActivities_Manager:GetActivityDataByEncodedId(timedActivityEncodedId)
    local function ActivityMatches(activityData)
        return activityData:GetEncodedId() == timedActivityEncodedId
    end
end
function ZO_TimedActivities_Manager:GetActivityDataByIndex(activityIndex)
    return self.activitiesData[activityIndex]
end
function ZO_TimedActivities_Manager:GetEncodedIdsForActivityDatas(activityDatas)
    local timedActivityEncodedIds = {}
    for activityIndex, activityData in ipairs(activityDatas) do
        table.insert(timedActivityEncodedIds, activityData:GetEncodedId())
    end
    return timedActivityEncodedIds
end
function ZO_TimedActivities_Manager.GetPrimaryTimedActivitiesCurrencyType()
    return PRIMARY_SYSTEM_CURRENCY
end
function ZO_TimedActivities_Manager:GetTimedActivityTypeTimeRemainingSeconds(timedActivityType)
    local endTimeS = GetTimedActivityTypeResetTimeS(timedActivityType)
    return zo_max(0, endTimeS - GetTimeStamp())
end
function ZO_TimedActivities_Manager:GetNumTimedActivities(activityType)
    local numActivities = 0
    for _, timedActivity in self:ActivitiesIterator() do
        if timedActivity:GetType() == activityType then
            numActivities = numActivities + 1
        end
    end
    return numActivities
end
function ZO_TimedActivities_Manager.GetNumRemainingRerollAttempts()
    local currencyAmount = GetPlayerStoredCurrencyAmount(CURT_TOME_CHALLENGE_REROLLS)
    return currencyAmount
end
function ZO_TimedActivities_Manager:GetActiveSeasonEndTimeS()
    return self.activeSeasonEndTimeS
end
function ZO_TimedActivities_Manager:GetNewTimedActivityEncodedIds(activityDatas)
    if not self.seenActivityEncodedIds:IsInitialized() then
        return {}
    end
    local allEncodedIds = zo_id64ToString(self:GetEncodedIdsForActivityDatas(activityDatas or self.activitiesData))
    local foundEncodedIds, missingEncodedIds = self.seenActivityEncodedIds:FindKeys(allEncodedIds)
    return zo_stringToId64(missingEncodedIds)
end
function ZO_TimedActivities_Manager:IsNewTimedActivity(activityData)
    return self.seenActivityEncodedIds:IsInitialized() and
        not self.seenActivityEncodedIds:HasKey(Id64ToString(activityData:GetEncodedId()))
end
function ZO_TimedActivities_Manager:HasNewTimedActivities(timedActivityType)
    -- Get the encoded ids of any activities that have not been seen yet.
    local newActivityEncodedIds = self:GetNewTimedActivityEncodedIds(self.activitiesData)
    if timedActivityType == nil then
        -- Check if there is at least one new activity.
        return next(newActivityEncodedIds) ~= nil
    end
    -- Check if there is at least one new activity of the specified type.
    for _, encodedId in ipairs(newActivityEncodedIds) do
        local activityData = self:GetActivityDataByEncodedId(encodedId)
        if activityData and activityData:GetType() == timedActivityType then
            return true
        end
    end
    return false
end
function ZO_TimedActivities_Manager:HasClaimableTimedActivities(timedActivityType)
    local claimableActivityDatas = self:GetClaimableActivityDatasByActivityType(timedActivityType)
    return next(claimableActivityDatas) ~= nil
end
function ZO_TimedActivities_Manager:MarkTimedActivitiesAsSeen(activityDatas)
    local encodedIds = {}
    for _, activityData in ipairs(activityDatas) do
        table.insert(encodedIds, Id64ToString(activityData:GetEncodedId()))
    end
    self.seenActivityEncodedIds:AddKeys(unpack(encodedIds))
end
    local scene = IsInGamepadPreferredMode() and "TimedActivitiesGamepad" or "TimedActivitiesKeyboard"
    SCENE_MANAGER:Push(scene)
end
function ZO_ShowSealStore()
    if IsInGamepadPreferredMode() then
        SYSTEMS:GetObject("mainMenu"):SelectMenuEntryAndSubEntry(ZO_MENU_MAIN_ENTRIES.CROWN_STORE, ZO_MENU_CROWN_STORE_ENTRIES.ENDEAVOR_SEAL_STORE, "gamepad_endeavor_seal_market_pre_scene")
    else
        SYSTEMS:GetObject("mainMenu"):ShowSceneGroup("marketSceneGroup", "endeavorSealStoreSceneKeyboard")
    end
end
TIMED_ACTIVITIES_MANAGER = ZO_TimedActivities_Manager:New()