Back to Home

ESO Lua File v101044

publicallingames/promotionalevent/promotionaleventdata.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
-- Rewardable Data Base --
ZO_PromotionalEventRewardableData_Base = ZO_InitializingObject:Subclass()
ZO_PromotionalEventRewardableData_Base:MUST_IMPLEMENT("IsRewardClaimed")
ZO_PromotionalEventRewardableData_Base:MUST_IMPLEMENT("CanClaimReward")
ZO_PromotionalEventRewardableData_Base:MUST_IMPLEMENT("TryClaimReward")
ZO_PromotionalEventRewardableData_Base:MUST_IMPLEMENT("GetRewardData")
-- Activity Data --
ZO_PromotionalEventActivityData = ZO_PromotionalEventRewardableData_Base:Subclass()
function ZO_PromotionalEventActivityData:Initialize(campaignData, activityIndex)
    self.campaignData = campaignData
    self.activityIndex = activityIndex
    self.activityId, self.displayName, self.description, self.completionThreshold, self.rewardId, self.rewardQuantity = GetPromotionalEventCampaignActivityInfo(self:GetCampaignKey(), self.activityIndex)
    -- Allows us to use this object as an entry data in a list without issues with any lazy loading data
    self.dataContainer = {}
end
function ZO_PromotionalEventActivityData:GetCampaignData()
    return self.campaignData
end
function ZO_PromotionalEventActivityData:GetCampaignKey()
    return self.campaignData:GetKey()
end
function ZO_PromotionalEventActivityData:GetActivityIndex()
    return self.activityIndex
end
function ZO_PromotionalEventActivityData:GetId()
    return self.activityId
end
function ZO_PromotionalEventActivityData:GetDisplayName()
    return self.displayName
end
function ZO_PromotionalEventActivityData:GetDescription()
    return self.description
end
function ZO_PromotionalEventActivityData:GetCompletionThreshold()
    return self.completionThreshold
end
function ZO_PromotionalEventActivityData:GetProgress()
    local progress, isRewardClaimed = GetPromotionalEventCampaignActivityProgress(self:GetCampaignKey(), self.activityIndex)
    return progress, isRewardClaimed
end
function ZO_PromotionalEventActivityData:IsComplete()
    local progress = self:GetProgress()
    return progress == self.completionThreshold
end
function ZO_PromotionalEventActivityData:IsRewardClaimed()
    local _, isRewardClaimed = self:GetProgress()
    return isRewardClaimed
end
function ZO_PromotionalEventActivityData:CanClaimReward()
    local progress, isRewardClaimed = GetPromotionalEventCampaignActivityProgress(self:GetCampaignKey(), self.activityIndex)
    return not isRewardClaimed and progress == self.completionThreshold
end
function ZO_PromotionalEventActivityData:TryClaimReward()
end
function ZO_PromotionalEventActivityData:GetRewardData()
    local rewardData = self.dataContainer.rewardData
    if not rewardData then
        if self.rewardId ~= 0 then
            rewardData = REWARDS_MANAGER:GetInfoForReward(self.rewardId, self.rewardQuantity)
            self.dataContainer.rewardData = rewardData
        end
    end
    return rewardData
end
function ZO_PromotionalEventActivityData:IsTracked()
    local campaignKey, activityIndex = GetTrackedPromotionalEventActivityInfo()
    return campaignKey == self:GetCampaignKey() and activityIndex == self.activityIndex
end
function ZO_PromotionalEventActivityData:ToggleTracking(suppressSound)
    if self:IsTracked() then
        if not suppressSound then
            PlaySound(SOUNDS.PROMOTIONAL_EVENT_TRACK_ACTIVITY_UNCLICK)
        end
    else
        TrackPromotionalEventActivity(self:GetCampaignKey(), self.activityIndex)
        if not suppressSound then
            PlaySound(SOUNDS.PROMOTIONAL_EVENT_TRACK_ACTIVITY_CLICK)
        end
    end
end
function ZO_PromotionalEventActivityData:GetRequiredCollectibleId()
    local requiredCollectibleId = GetTimedActivityRequiredCollectible(self.activityId)
    return requiredCollectibleId
end
function ZO_PromotionalEventActivityData:GetRequiredCollectibleData()
    local requiredCollectibleId = self:GetRequiredCollectibleId()
    return ZO_COLLECTIBLE_DATA_MANAGER:GetCollectibleDataById(requiredCollectibleId)
end
function ZO_PromotionalEventActivityData:IsLocked()
    local requiredCollectibleData = self:GetRequiredCollectibleData()
    return requiredCollectibleData and requiredCollectibleData:IsLocked() or false
end
-- Milestone Data --
ZO_PromotionalEventMilestoneData = ZO_PromotionalEventRewardableData_Base:Subclass()
function ZO_PromotionalEventMilestoneData:Initialize(campaignData, milestoneIndex)
    self.campaignData = campaignData
    self.milestoneIndex = milestoneIndex
    self.completionThreshold, self.rewardId, self.rewardQuantity = GetPromotionalEventCampaignMilestoneInfo(self:GetCampaignKey(), self.milestoneIndex)
    -- Allows us to use this object as an entry data in a list without issues with any lazy loading data
    self.dataContainer = {}
end
function ZO_PromotionalEventMilestoneData:GetCampaignData()
    return self.campaignData
end
function ZO_PromotionalEventMilestoneData:GetCampaignKey()
    return self.campaignData:GetKey()
end
function ZO_PromotionalEventMilestoneData:GetMilestoneIndex()
    return self.milestoneIndex
end
function ZO_PromotionalEventMilestoneData:GetDisplayIndex()
    return self.displayIndex or self.milestoneIndex
end
function ZO_PromotionalEventMilestoneData:SetDisplayIndex(displayIndex)
    self.displayIndex = displayIndex
end
function ZO_PromotionalEventMilestoneData:GetCompletionThreshold()
    return self.completionThreshold
end
function ZO_PromotionalEventMilestoneData:HasReachedMilestone()
   return self.campaignData:GetNumActivitiesCompleted() >= self.completionThreshold
end
function ZO_PromotionalEventMilestoneData:IsRewardClaimed()
    local isRewardClaimed = IsPromotionalEventCampaignMilestoneRewardClaimed(self:GetCampaignKey(), self.milestoneIndex)
    return isRewardClaimed
end
function ZO_PromotionalEventMilestoneData:CanClaimReward()
    return self:HasReachedMilestone() and not self:IsRewardClaimed()
end
function ZO_PromotionalEventMilestoneData:TryClaimReward()
end
function ZO_PromotionalEventMilestoneData:GetRewardData()
    local rewardData = self.dataContainer.rewardData
    if not rewardData then
        if self.rewardId ~= 0 then
            rewardData = REWARDS_MANAGER:GetInfoForReward(self.rewardId, self.rewardQuantity)
            self.dataContainer.rewardData = rewardData
        end
    end
    return rewardData
end
-- Campaign Data --
ZO_PromotionalEventCampaignData = ZO_PromotionalEventRewardableData_Base:Subclass()
function ZO_PromotionalEventCampaignData:Initialize(campaignKey)
    self.campaignKey = campaignKey
    self.campaignId, self.numActivities, self.numMilestones, self.capstoneCompletionThreshold, self.capstoneRewardId, self.capstoneRewardQuantity = GetPromotionalEventCampaignInfo(self.campaignKey)
    -- Allows us to use this object as an entry data in a list without issues with any lazy loading data
    self.activities = {}
    self.milestones = {}
    self.dataContainer = {}
end
function ZO_PromotionalEventCampaignData:GetKey()
    return self.campaignKey
end
function ZO_PromotionalEventCampaignData:GetKeyString()
    return Id64ToString(self.campaignKey)
end
function ZO_PromotionalEventCampaignData:GetId()
    return self.campaignId
end
function ZO_PromotionalEventCampaignData:GetDisplayName()
    local displayName = GetPromotionalEventCampaignDisplayName(self.campaignId)
    return displayName
end
function ZO_PromotionalEventCampaignData:GetDescription()
    return description
end
function ZO_PromotionalEventCampaignData:GetLargeBackgroundFileIndex()
    local largeBackgroundFileIndex = GetPromotionalEventCampaignLargeBackgroundFileIndex(self.campaignId)
    return largeBackgroundFileIndex
end
function ZO_PromotionalEventCampaignData:GetAnnouncementBackgroundFileIndex()
    local announcementBackgroundFileIndex = GetPromotionalEventCampaignAnnouncementBackgroundFileIndex(self.campaignId)
    return announcementBackgroundFileIndex
end
function ZO_PromotionalEventCampaignData:GetAnnouncementBannerText()
    local announcementBannerText = GetPromotionalEventCampaignAnnouncementBannerText(self.campaignKey)
    return announcementBannerText
end
function ZO_PromotionalEventCampaignData:GetNumActivities()
    return self.numActivities
end
function ZO_PromotionalEventCampaignData:GetActivities()
    if #self.activities ~= self.numActivities then
        ZO_ClearNumericallyIndexedTable(self.activities)
        for activityIndex = 1, self.numActivities do
            table.insert(self.activities, ZO_PromotionalEventActivityData:New(self, activityIndex))
        end
    end
    return self.activities
end
function ZO_PromotionalEventCampaignData:GetActivityData(activityIndex)
    if activityIndex <= self.numActivities then
        local activities = self:GetActivities()
        return activities[activityIndex]
    end
    return nil
end
function ZO_PromotionalEventCampaignData:GetNumMilestones()
    return self.numMilestones
end
function ZO_PromotionalEventCampaignData:GetMilestones()
    if #self.milestones ~= self.numMilestones then
        ZO_ClearNumericallyIndexedTable(self.milestones)
        for milestoneIndex = 1, self.numMilestones do
            table.insert(self.milestones, ZO_PromotionalEventMilestoneData:New(self, milestoneIndex))
        end
        local function MilestoneComparator(milestone1, milestone2)
            return milestone1:GetCompletionThreshold() < milestone2:GetCompletionThreshold()
        end
        table.sort(self.milestones, MilestoneComparator)
        for displayIndex, milestoneData in ipairs(self.milestones) do
            milestoneData:SetDisplayIndex(displayIndex)
        end
    end
    return self.milestones
end
function ZO_PromotionalEventCampaignData:GetMilestoneData(milestoneIndex)
    if milestoneIndex <= self.numMilestones then
        local milestones = self:GetMilestones()
        for _, milestoneData in ipairs(self.milestones) do
            if milestoneData:GetMilestoneIndex() == milestoneIndex then
                return milestoneData
            end
        end
    end
    return nil
end
function ZO_PromotionalEventCampaignData:GetMilestoneDataByDisplayIndex(displayIndex)
    if milestoneIndex <= self.numMilestones then
        local milestones = self:GetMilestones()
        return milestones[displayIndex]
    end
    return nil
end
function ZO_PromotionalEventCampaignData:GetSecondsRemaining()
    local secondsRemaining = GetSecondsRemainingInPromotionalEventCampaign(self.campaignKey)
    return secondsRemaining
end
function ZO_PromotionalEventCampaignData:GetProgress()
    local numActivitiesCompleted, isCapstoneRewardClaimed = GetPromotionalEventCampaignProgress(self.campaignKey)
    return numActivitiesCompleted, isCapstoneRewardClaimed
end
function ZO_PromotionalEventCampaignData:GetNumActivitiesCompleted()
    local numActivitiesCompleted = self:GetProgress()
    return numActivitiesCompleted
end
function ZO_PromotionalEventCampaignData:GetCapstoneRewardThreshold()
    return self.capstoneCompletionThreshold
end
function ZO_PromotionalEventCampaignData:IsRewardClaimed()
    local _, isCapstoneRewardClaimed = self:GetProgress()
    return isCapstoneRewardClaimed
end
function ZO_PromotionalEventCampaignData:CanClaimReward()
    local numActivitiesCompleted, isCapstoneRewardClaimed = GetPromotionalEventCampaignProgress(self.campaignKey)
    return not isCapstoneRewardClaimed and numActivitiesCompleted >= self.capstoneCompletionThreshold
end
function ZO_PromotionalEventCampaignData:TryClaimReward()
end
function ZO_PromotionalEventCampaignData:GetRewardData()
    local capstoneRewardData = self.dataContainer.capstoneRewardData
    if not capstoneRewardData then
        if self.capstoneRewardId ~= 0 then
            capstoneRewardData = REWARDS_MANAGER:GetInfoForReward(self.capstoneRewardId, self.capstoneRewardQuantity)
            self.dataContainer.capstoneRewardData = capstoneRewardData
        end
    end
    return capstoneRewardData
end
function ZO_PromotionalEventCampaignData:IsAnyRewardClaimable()
    return IsAnyRewardClaimable
end
function ZO_PromotionalEventCampaignData:TryClaimAllAvailableRewards()
end
function ZO_PromotionalEventCampaignData:HasBeenSeen()
    return PROMOTIONAL_EVENT_MANAGER:HasCampaignBeenSeen(self)
end
function ZO_PromotionalEventCampaignData:SetSeen(seen)
    return PROMOTIONAL_EVENT_MANAGER:SetCampaignSeen(self, seen)
end