Back to Home

ESO Lua File v101050

publicallingames/promotionalevent/promotionalevent_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
-------------------------------
-- Promotional Event Manager --
-------------------------------
ZO_PromotionalEvent_Manager = ZO_InitializingCallbackObject:Subclass()
function ZO_PromotionalEvent_Manager:Initialize()
    self.syncObject = GetOrCreateSynchronizingObject("PromotionalEventManager")
    local isInGameUI = ZO_IsIngameUI()
    if isInGameUI then
        EVENT_MANAGER:RegisterForEvent("PromotionalEventManager", EVENT_PROMOTIONAL_EVENTS_ACTIVITY_PROGRESS_UPDATED, ZO_GetEventForwardingFunction(self, self.OnActivityProgressUpdated))
        self.syncObject:SetHandler("OnBroadcast", function(_, message)
            local campaignKey = StringToId64(message)
            local campaignData = self:GetCampaignDataByKey(campaignKey)
            local DONT_SCROLL_TO_REWARD = false
            self:ShowPromotionalEventScene(DONT_SCROLL_TO_REWARD, campaignData)
        end)
    end
    local function OnCampaignsUpdated()
        local FORCE_CLEAN_SEEN = true
        self:RefreshCampaignData(FORCE_CLEAN_SEEN)
        if isInGameUI and not IsActiveWorldStarterWorld() then
        end
    end
    EVENT_MANAGER:RegisterForEvent("PromotionalEventManager", EVENT_PROMOTIONAL_EVENTS_CAMPAIGNS_UPDATED, OnCampaignsUpdated)
    EVENT_MANAGER:RegisterForEvent("PromotionalEventManager", EVENT_PROMOTIONAL_EVENTS_REWARDS_CLAIMED, ZO_GetEventForwardingFunction(self, self.OnRewardsClaimed))
    local function OnAddOnLoaded(_, name)
        if name == "ZO_Ingame" then
            local defaults =
            {
                seenCampaignKeys = {}
            }
            self.savedVars = ZO_SavedVars:NewAccountWide("ZO_Ingame_SavedVariables", 1, "PromotionalEvents", defaults)
            if #self.activeCampaignDataList > 0 then
                self:CleanupSeenCampaigns()
            end
            EVENT_MANAGER:UnregisterForEvent("PromotionalEventManager", EVENT_ADD_ON_LOADED)
        end
    end
    EVENT_MANAGER:RegisterForEvent("PromotionalEventManager", EVENT_ADD_ON_LOADED, OnAddOnLoaded)
end
function ZO_PromotionalEvent_Manager:RefreshCampaignData(forceCleanSeen)
    if self.activeCampaignDataList then
        ZO_ClearNumericallyIndexedTable(self.activeCampaignDataList)
    else
        self.activeCampaignDataList = {}
    end
    for i = 1, GetNumActivePromotionalEventCampaigns() do
        local campaignKey = GetActivePromotionalEventCampaignKey(i)
        local campaignData = ZO_PromotionalEventCampaignData:New(campaignKey)
        table.insert(self.activeCampaignDataList, campaignData)
    end
    table.sort(self.activeCampaignDataList, ZO_PromotionalEventCampaignData.CompareTo)
    if forceCleanSeen or #self.activeCampaignDataList > 0 then
        -- If there are no campaigns, we might not have received the info from the server yet
        -- so we can't be sure we have accurate data yet. So only clean up if we know there are campaigns
        -- Or we're receiving an event about the campaigns
        self:CleanupSeenCampaigns()
    end
    self:FireCallbacks("CampaignsUpdated")
end
function ZO_PromotionalEvent_Manager:CleanupSeenCampaigns()
    if self.savedVars then
        local seenCampaignKeys = {}
        for _, campaignData in ipairs(self.activeCampaignDataList) do
            local key = campaignData:GetKeyString()
            if self.savedVars.seenCampaignKeys[key] then
                seenCampaignKeys[key] = true
            end
        end
        self.savedVars.seenCampaignKeys = seenCampaignKeys
    end
end
if ZO_IsIngameUI() then
    function ZO_PromotionalEvent_Manager:ShowPromotionalEventScene(scrollToFirstClaimableReward, campaignData)
        local numActiveCampaigns = PROMOTIONAL_EVENT_MANAGER:GetNumActiveCampaigns()
        local showRoot = numActiveCampaigns == 1 -- TODO Promotional Events: WB will have a rule to create a sub list even if there's only 1 campaign visible, so adjust this logic too
        local systemObject
        if IsInGamepadPreferredMode() then
            ZO_ACTIVITY_FINDER_ROOT_GAMEPAD:ShowCategory(PROMOTIONAL_EVENTS_GAMEPAD:GetCategoryData())
            if not showRoot then
                PROMOTIONAL_EVENTS_LIST_GAMEPAD:SelectCampaign(campaignData)
            end
            systemObject = PROMOTIONAL_EVENTS_GAMEPAD
        else
            if showRoot then
                GROUP_MENU_KEYBOARD:ShowCategory(PROMOTIONAL_EVENTS_KEYBOARD.fragment)
            else
                GROUP_MENU_KEYBOARD:ShowCategoryByData(campaignData)
            end
            systemObject = PROMOTIONAL_EVENTS_KEYBOARD
        end
        if scrollToFirstClaimableReward then
            systemObject:ScrollToFirstClaimableReward()
        end
    end
else
    function ZO_PromotionalEvent_Manager:ShowPromotionalEventScene(campaignData)
        local campaignKey = campaignData and campaignData:GetKeyString() or nil
        self.syncObject:Broadcast(campaignKey)
    end
end
function ZO_PromotionalEvent_Manager:OnActivityProgressUpdated(campaignKey, activityIndex, previousProgress, newProgress, rewardFlags)
    local campaignData = self:GetCampaignDataByKey(campaignKey)
    if campaignData then
        local activityData = campaignData:GetActivityData(activityIndex)
        if activityData then
            campaignData:OnActivityProgressUpdated(activityData, previousProgress, newProgress, rewardFlags)
            self:FireCallbacks("ActivityProgressUpdated", activityData, previousProgress, newProgress, rewardFlags)
        end
    end
end
function ZO_PromotionalEvent_Manager:OnRewardsClaimed(campaignKey)
    local campaignData = self:GetCampaignDataByKey(campaignKey)
    if campaignData then
        campaignData:OnRewardsClaimed()
        local isInGameUI = ZO_IsIngameUI()
        if isInGameUI then
            local rewardKeys = { GetRecentlyClaimedPromotionalEventRewards(campaignKey) }
            local rewards = {}
            local hasCapstoneReward = false
            for i = 1, #rewardKeys, 2 do
                local reward =
                {
                    type = rewardKeys[i],
                    index = rewardKeys[i + 1],
                }
                local rewardableEventData
                if reward.type == PROMOTIONAL_EVENTS_COMPONENT_TYPE_SCHEDULE then
                    rewardableEventData = campaignData
                    hasCapstoneReward = true
                elseif reward.type == PROMOTIONAL_EVENTS_COMPONENT_TYPE_MILESTONE_REWARD then
                    rewardableEventData = campaignData:GetMilestoneData(reward.index)
                elseif reward.type == PROMOTIONAL_EVENTS_COMPONENT_TYPE_ACTIVITY then
                    rewardableEventData = campaignData:GetActivityData(reward.index)
                end
                reward.rewardableEventData = rewardableEventData
                table.insert(rewards, reward)
            end
            self:FireCallbacks("RewardsClaimed", campaignData, rewards, hasCapstoneReward)
        else
            -- Internal doesn't need to know about the actual rewards, only the AreAllRewardsClaimed function
            self:FireCallbacks("RewardsClaimed", campaignData)
        end
    end
end
function ZO_PromotionalEvent_Manager:HasActiveCampaign()
    return #self.activeCampaignDataList > 0
end
function ZO_PromotionalEvent_Manager:GetNumActiveCampaigns()
    return #self.activeCampaignDataList
end
function ZO_PromotionalEvent_Manager:GetCampaignDataByIndex(campaignIndex)
    return self.activeCampaignDataList[campaignIndex]
end
function ZO_PromotionalEvent_Manager:CampaignIterator(campaignFilterFunctions)
    return ZO_FilteredNumericallyIndexedTableIterator(self.activeCampaignDataList, campaignFilterFunctions)
end
function ZO_PromotionalEvent_Manager:GetCampaignDataByKey(campaignKey)
    if not IsId64EqualToNumber(campaignKey, 0) then
        for _, campaignData in ipairs(self.activeCampaignDataList) do
            if AreId64sEqual(campaignKey, campaignData:GetKey()) then
                return campaignData
            end
        end
    end
    return nil
end
function ZO_PromotionalEvent_Manager:HasCampaignBeenSeen(campaignData)
    if self.savedVars then
        local keyString = campaignData:GetKeyString()
        return self.savedVars.seenCampaignKeys[keyString] == true
    end
    return false
end
function ZO_PromotionalEvent_Manager:SetCampaignSeen(campaignData, seen)
    if self.savedVars then
        seen = seen ~= false -- nil => true
        local keyString = campaignData:GetKeyString()
        if self.savedVars.seenCampaignKeys[keyString] ~= seen then
            self.savedVars.seenCampaignKeys[keyString] = seen
            self:FireCallbacks("CampaignSeenStateChanged", campaignData)
        end
    end
end
function ZO_PromotionalEvent_Manager:OnCapstoneDialogClosed()
    self:FireCallbacks("CapstoneDialogClosed")
end
function ZO_PromotionalEvent_Manager:AreAnyReturningPlayerCampaignsIncomplete()
    if self:HasActiveCampaign() then
        for _, campaign in ipairs(self.activeCampaignDataList) do
            if campaign:IsReturningPlayerCampaign() and not campaign:AreAllRewardsClaimed() then
                return true
            end
        end
    end
    return false
end
function ZO_PromotionalEvent_Manager:DoesAnyCampaignHaveCallout()
    if not IsPromotionalEventSystemLocked() then
        for _, campaignData in ipairs(self.activeCampaignDataList) do
            if campaignData:ShouldCampaignBeVisible() and (not campaignData:HasBeenSeen() or campaignData:IsAnyRewardClaimable()) then
                return true
            end
        end
    end
    return false
end
function ZO_PromotionalEvent_Manager:IsAnyRewardClaimable()
    if not IsPromotionalEventSystemLocked() then
        for _, campaignData in ipairs(self.activeCampaignDataList) do
            if campaignData:IsAnyRewardClaimable() then
                local firstCampaignWithClaimableReward = campaignData
                return true, firstCampaignWithClaimableReward
            end
        end
    end
    return false
end
function ZO_PromotionalEvent_Manager:AreAllRewardsClaimed()
    if not IsPromotionalEventSystemLocked() then
        for _, campaignData in ipairs(self.activeCampaignDataList) do
            if not campaignData:AreAllRewardsClaimed() then
                return false
            end
        end
        return true
    end
    return false
end
-- Distinct from IsAnyRewardClaimable, this includes rewards you haven't earned yet
function ZO_PromotionalEvent_Manager:HasAnyUnclaimedRewards()
    if not IsPromotionalEventSystemLocked() then
        for _, campaignData in ipairs(self.activeCampaignDataList) do
            if campaignData:HasAnyUnclaimedRewards() then
                return true
            end
        end
    end
    return false
end
function ZO_PromotionalEvent_Manager:GetPromotionalEventsColorizedDisplayName()
    return ZO_PROMOTIONAL_EVENT_SELECTED_COLOR:Colorize(GetString(SI_ACTIVITY_FINDER_CATEGORY_PROMOTIONAL_EVENTS))
end
function ZO_PromotionalEvent_Manager:IsShowingCapstoneDialog()
    if ZO_DIALOG_SYNC_OBJECT:IsShown() then
        local shownDialog = ZO_DIALOG_SYNC_OBJECT:GetState()
        return shownDialog == "PROMOTIONAL_EVENT_CAPSTONE_KEYBOARD" or shownDialog == "PROMOTIONAL_EVENT_CAPSTONE_GAMEPAD"
    end
    return false
end
PROMOTIONAL_EVENT_MANAGER = ZO_PromotionalEvent_Manager:New()