Back to Home

ESO Lua File v101041

ingame/leaderboards/leaderboards_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
ZO_LEADERBOARD_PLAYER_DATA = 1
PENDING_LEADERBOARD_DATA_TYPE =
{
    BATTLEGROUND = 1,
    CAMPAIGN = 2,
    RAID = 3,
    TRIBUTE = 4,
    ENDLESS_DUNGEON = 5,
}
-----------------
--Leaderboards Masterlist
-----------------
ZO_LeaderboardsListManager_Shared = ZO_InitializingCallbackObject:Subclass()
function ZO_LeaderboardsListManager_Shared:Initialize()
    self.masterList = {}
    self.pendingRequestData = {}
    EVENT_MANAGER:RegisterForEvent("LeaderboardsListManager", EVENT_RAID_LEADERBOARD_DATA_RECEIVED, function(_, ...) self:OnRaidLeaderboardDataReceived(...) end)
    EVENT_MANAGER:RegisterForEvent("LeaderboardsListManager", EVENT_BATTLEGROUND_LEADERBOARD_DATA_RECEIVED, function(_, ...) self:OnBattlegroundLeaderboardDataReceived(...) end)
    EVENT_MANAGER:RegisterForEvent("LeaderboardsListManager", EVENT_CAMPAIGN_LEADERBOARD_DATA_RECEIVED, function(_, ...) self:OnCampaignLeaderboardDataReceived(...) end)
    EVENT_MANAGER:RegisterForEvent("LeaderboardsListManager", EVENT_TRIBUTE_LEADERBOARD_DATA_RECEIVED, function(_, ...) self:OnTributeLeaderboardDataReceived(...) end)
    EVENT_MANAGER:RegisterForEvent("LeaderboardsListManager", EVENT_ENDLESS_DUNGEON_LEADERBOARD_DATA_RECEIVED, function(_, ...) self:OnEndlessDungeonLeaderboardDataReceived(...) end)
end
function ZO_LeaderboardsListManager_Shared:SetSelectedLeaderboard(data)
    self.subType = data.subType
    self.maxAllowedRankFunction = data.maxRankFunction
    if self.leaderboardRankType ~= data.leaderboardRankType then
        self.leaderboardRankType = data.leaderboardRankType
        self:FireCallbacks("LeaderboardRankTypeChanged")
    end
end
function ZO_LeaderboardsListManager_Shared:BuildMasterList()
    if not self.countFunction or not self.infoFunction then
        return
    end
    if self.playerInfoUpdateFunction then
        self.playerInfoUpdateFunction()
    end
    for i = 1, self.countFunction(self.subType) do
        local data = { index = i }
        self:SetupDataTable(data)
        self.masterList[#self.masterList + 1] = data
    end
    
    if self.maxAllowedRankFunction then
        self.maxAllowedRank = self.maxAllowedRankFunction()
    else
        self.maxAllowedRank = nil
    end
end
function ZO_LeaderboardsListManager_Shared:SetupDataTable(dataTable)
    if dataTable.index then
        local rank, playerDisplayName, characterName, points, class, alliance
        --Get and setup Leaderboard Type specific data
        if self.leaderboardRankType == LEADERBOARD_TYPE_ENDLESS_DUNGEON_OVERALL or self.leaderboardRankType == LEADERBOARD_TYPE_ENDLESS_DUNGEON_CLASS then
            local stage, cycle, arc
            rank, characterName, points, class, playerDisplayName, stage, cycle, arc = self.infoFunction(dataTable.index, self.subType)
            dataTable.stage = stage
            dataTable.cycle = cycle
            dataTable.arc = arc
        elseif self.leaderboardRankType == LEADERBOARD_TYPE_BATTLEGROUND or self.leaderboardRankType == LEADERBOARD_TYPE_TRIBUTE then
            rank, playerDisplayName, characterName, points = self.infoFunction(dataTable.index, self.subType)
        else
            rank, characterName, points, class, alliance, playerDisplayName = self.infoFunction(dataTable.index, self.subType)
        end
        --Setup common leaderboard data
        dataTable.characterName = characterName
        dataTable.displayName = playerDisplayName
        dataTable.type = ZO_GAMEPAD_INTERACTIVE_FILTER_LIST_SEARCH_TYPE_NAMES
        --This is the overall rank for the specific type of leaderboard you've requested.
        --The rank that is ultimately shown might be reshuffled based on the provided filters.
        dataTable.trueRank = rank
        dataTable.points = self.pointsFormatFunction and self.pointsFormatFunction(points) or points
        dataTable.class = class
        dataTable.alliance = alliance
        if alliance then
            dataTable.formattedAllianceName = ZO_CachedStrFormat(SI_ALLIANCE_NAME, GetAllianceName(alliance))
        end
    end
end
function ZO_LeaderboardsListManager_Shared:FilterScrollList(list, filteredClass, preAddCallback, searchCallback)
    local scrollData = ZO_ScrollList_GetDataList(list)
    ZO_ClearNumericallyIndexedTable(scrollData)
    local maxAllowedRank = self.maxAllowedRank
    local lastTrueRank = 0
    local currentRank = 0
    local filteredIndex = 1
    for _, data in ipairs(self:GetMasterList()) do
        if not filteredClass or data.class == filteredClass then
            --Re-rank based on class filtering
            if data.trueRank > lastTrueRank then
                lastTrueRank = data.trueRank
                currentRank = filteredIndex
            end
            --The list comes pre-sorted by rank, so all later entries don't matter
            if maxAllowedRank and currentRank > maxAllowedRank then
                break
            end
            data.rank = currentRank
            if not searchCallback or searchCallback(data) then
                if preAddCallback then
                    preAddCallback(data)
                    table.insert(scrollData, ZO_ScrollList_CreateDataEntry(ZO_LEADERBOARD_PLAYER_DATA, data))
                end
            end
            filteredIndex = filteredIndex + 1
        end
    end
end
function ZO_LeaderboardsListManager_Shared:GetConsoleIdRequestParams(index)
    return self.consoleIdRequestParamsFunction(index, self.subType)
end
function ZO_LeaderboardsListManager_Shared:GetMasterList()
    return self.masterList
end
function ZO_LeaderboardsListManager_Shared:QueryLeaderboardData(leaderboardType, queryData)
    self.pendingRequestType = leaderboardType
    self.pendingRequestData = queryData
    local readyState = LEADERBOARD_DATA_RESPONSE_PENDING
    if leaderboardType == PENDING_LEADERBOARD_DATA_TYPE.BATTLEGROUND then
        readyState = QueryBattlegroundLeaderboardData(queryData.battlegroundType)
        if readyState == LEADERBOARD_DATA_READY then
            self:OnBattlegroundLeaderboardDataReceived(queryData.battlegroundType)
        end
    elseif leaderboardType == PENDING_LEADERBOARD_DATA_TYPE.CAMPAIGN then
        readyState = QueryCampaignLeaderboardData(queryData.alliance)
        if readyState == LEADERBOARD_DATA_READY then
            self:OnCampaignLeaderboardDataReceived(queryData.campaignId, queryData.alliance)
        end
    elseif leaderboardType == PENDING_LEADERBOARD_DATA_TYPE.RAID then
        readyState = QueryRaidLeaderboardData(queryData.raidCategory, queryData.raidId, queryData.classId)
        if readyState == LEADERBOARD_DATA_READY then
            self:OnRaidLeaderboardDataReceived(queryData.raidCategory, queryData.raidId, queryData.classId)
        end
    elseif leaderboardType == PENDING_LEADERBOARD_DATA_TYPE.TRIBUTE then
        readyState = QueryTributeLeaderboardData(queryData.tributeType)
        if readyState == LEADERBOARD_DATA_READY then
            self:OnTributeLeaderboardDataReceived(queryData.tributeType)
        end
    elseif leaderboardType == PENDING_LEADERBOARD_DATA_TYPE.ENDLESS_DUNGEON then
        readyState = QueryEndlessDungeonLeaderboardData(queryData.endlessDungeonGroupType, queryData.endlessDungeonId, queryData.classId)
        if readyState == LEADERBOARD_DATA_READY then
            self:OnEndlessDungeonLeaderboardDataReceived(queryData.endlessDungeonGroupType, queryData.endlessDungeonId, queryData.classId)
        end
    end
    if readyState == LEADERBOARD_DATA_RESPONSE_PENDING then
        self:SetLoadingState(true)
    end
end
function ZO_LeaderboardsListManager_Shared:OnRaidLeaderboardDataReceived(raidCategory, raidId, classId)
    if self.pendingRequestType ~= PENDING_LEADERBOARD_DATA_TYPE.RAID then
        return
    end
    local passesCategoryCheck = self.pendingRequestData.raidCategory == raidCategory
    local passesIdCheck = self.pendingRequestData.raidId == raidId
    local passesClassCheck = raidCategory == RAID_CATEGORY_TRIAL or self.pendingRequestData.classId == classId
    if passesCategoryCheck and passesIdCheck and passesClassCheck then
        self:SetLoadingState(false)
    end
end
function ZO_LeaderboardsListManager_Shared:OnBattlegroundLeaderboardDataReceived(battlegroundType)
    if self.pendingRequestType ~= PENDING_LEADERBOARD_DATA_TYPE.BATTLEGROUND then
        return
    end
    if self.pendingRequestData.battlegroundType == battlegroundType then
        self:SetLoadingState(false)
    end
end
function ZO_LeaderboardsListManager_Shared:OnCampaignLeaderboardDataReceived(campaignId, alliance)
    if self.pendingRequestType ~= PENDING_LEADERBOARD_DATA_TYPE.CAMPAIGN then
        return
    end
    local passesAllianceCheck = self.pendingRequestData.alliance == alliance
    local passesCampaignCheck = self.pendingRequestData.campaignId == campaignId
    if passesAllianceCheck and passesCampaignCheck then
        self:SetLoadingState(false)
    end
end
function ZO_LeaderboardsListManager_Shared:OnTributeLeaderboardDataReceived(tributeType)
    if self.pendingRequestType ~= PENDING_LEADERBOARD_DATA_TYPE.TRIBUTE then
        return
    end
    if self.pendingRequestData.tributeType == tributeType then
        self:SetLoadingState(false)
    end
end
function ZO_LeaderboardsListManager_Shared:OnEndlessDungeonLeaderboardDataReceived(groupType, endlessDungeonId, classId)
    if self.pendingRequestType ~= PENDING_LEADERBOARD_DATA_TYPE.ENDLESS_DUNGEON then
        return
    end
    local passesGroupTypeCheck = self.pendingRequestData.endlessDungeonGroupType == groupType
    local passesIdCheck = self.pendingRequestData.endlessDungeonId == endlessDungeonId
    local passesClassCheck = groupType == ENDLESS_DUNGEON_GROUP_TYPE_DUO or self.pendingRequestData.classId == classId
    if passesGroupTypeCheck and passesIdCheck and passesClassCheck then
        self:SetLoadingState(false)
    end
end
function ZO_LeaderboardsListManager_Shared:SetLoadingState(isLoading)
    local leaderboard
    if IsInGamepadPreferredMode() then
        leaderboard = GAMEPAD_LEADERBOARDS
    else
        leaderboard = LEADERBOARDS
    end
    leaderboard:SetLoadingSpinnerVisibility(isLoading)
    if not isLoading then
        leaderboard:RefreshData()
    end
end
LEADERBOARD_LIST_MANAGER = ZO_LeaderboardsListManager_Shared:New()
-----------------
--Leaderboards Shared
-----------------
ZO_LeaderboardsManager_Shared = ZO_Object:Subclass()
function ZO_LeaderboardsManager_Shared:New(control, leaderboardControl)
    leaderboardControl = leaderboardControl or control
    local manager = ZO_Object.New(self)
    manager:Initialize(control, leaderboardControl)
    return manager
end
function ZO_LeaderboardsManager_Shared:Initialize(control, leaderboardControl)
    self.leaderboardDataMetatable = {__index = function(dataTable, key) self:IndexFunction(dataTable, key) end}
    LEADERBOARD_LIST_MANAGER:RegisterCallback("LeaderboardRankTypeChanged", function() self:RepopulateFilterDropdown() end)
    LEADERBOARD_LIST_MANAGER:RegisterCallback("OnLeaderboardMasterListUpdated", function()
        if self.scene:IsShowing() then
            self:OnLeaderboardDataChanged(self.leaderboardObject)
        end
    end)
end
function ZO_LeaderboardsManager_Shared:InitializeScenes(sceneName)
    self.scene = ZO_Scene:New(sceneName, SCENE_MANAGER)
end
function ZO_LeaderboardsManager_Shared:GetScene()
    return self.scene
end
function ZO_LeaderboardsManager_Shared:SetSelectedLeaderboardObject(leaderboardObject, subType)
    -- Should be overridden
end
function ZO_LeaderboardsManager_Shared:RefreshLeaderboardType(leaderboardType)
    -- Should be overridden
end
function ZO_LeaderboardsManager_Shared:RepopulateFilterDropdown()
    -- Should be overridden
end
function ZO_LeaderboardsManager_Shared:SetLoadingSpinnerVisibility(show)
    -- Should be overridden
end
function ZO_LeaderboardsManager_Shared:RefreshPointsHeader()
    -- Should be overridden
end
function ZO_LeaderboardsManager_Shared:GetLeaderboardTitleName(titleName, subType)
    return type(titleName) == "function" and titleName(subType) or titleName
end
function ZO_LeaderboardsManager_Shared:OnLeaderboardSelected(data)
    self:SetSelectedLeaderboardObject(data.leaderboardObject, data.subType)
    if self:GetScene():IsShowing() then
        LEADERBOARD_LIST_MANAGER:SetSelectedLeaderboard(data)
        data.leaderboardObject:SendLeaderboardQuery()
    end
    local titleName = self:GetLeaderboardTitleName(data.titleName, data.subType)
    self:RefreshLeaderboardType(data.leaderboardRankType)
    self.headerPointsText = data.pointsHeaderString or GetString(SI_LEADERBOARDS_HEADER_POINTS)
end
function ZO_LeaderboardsManager_Shared:OnLeaderboardDataChanged(leaderboardObject)
    if self.leaderboardObject == leaderboardObject then
        local data = self:GetSelectedLeaderboardData()
        if data then
            self:OnLeaderboardSelected(data)
        else
            self:RefreshData()
        end
    end
end
function ZO_LeaderboardsManager_Shared:SetupLeaderboardPlayerEntry(control, data)
    local leaderboardData = self:GetSelectedLeaderboardData()
    --Rank
    control.rankLabel:SetHidden(data.rank == 0)
    control.rankLabel:SetText(data.rank)
        
    --Name
    local safeDisplayName = data.displayName ~= "" and data.displayName or GetString(SI_LEADERBOARDS_STAT_NOT_AVAILABLE)
    local nameToUse = ZO_GetPlatformUserFacingName(data.characterName, safeDisplayName)
    control.nameLabel:SetText(nameToUse)
        
    --Class/Alliance/Progress
    local isEndlessDungeonLeaderboardType = leaderboardData.leaderboardRankType == LEADERBOARD_TYPE_ENDLESS_DUNGEON_OVERALL or leaderboardData.leaderboardRankType == LEADERBOARD_TYPE_ENDLESS_DUNGEON_CLASS
    local isBattlegroundLeaderboardType = leaderboardData.leaderboardRankType == LEADERBOARD_TYPE_BATTLEGROUND
    local isTributeLeaderboardType = self.leaderboardRankType == LEADERBOARD_TYPE_TRIBUTE
    local shouldShowClass = not isBattlegroundLeaderboardType and not isTributeLeaderboardType
    local shouldShowAlliance = not isEndlessDungeonLeaderboardType and not isBattlegroundLeaderboardType and not isTributeLeaderboardType
    if shouldShowClass then
        local classTexture = ZO_GetPlatformClassIcon(data.class)
        if(classTexture) then
            control.classIcon:SetHidden(false)
            control.classIcon:SetTexture(classTexture)
        else
            control.classIcon:SetHidden(true)
        end
    else
        control.classIcon:SetHidden(true)
    end
    if shouldShowAlliance then
        local allianceTexture = ZO_GetPlatformAllianceSymbolIcon(data.alliance)
        if(allianceTexture) then
            control.allianceIcon:SetHidden(false)
            control.allianceIcon:SetTexture(allianceTexture)
        else
            control.allianceIcon:SetHidden(true)
        end
    else
        control.allianceIcon:SetHidden(true)
    end
    if isEndlessDungeonLeaderboardType then
        control.progressLabel:SetHidden(false)
        local USE_THICK_OUTLINE = true
        local progressionString = ZO_EndlessDungeonManager.GetProgressionText(data.stage, data.cycle, data.arc, USE_THICK_OUTLINE)
        control.progressLabel:SetText(progressionString)
    else
        control.progressLabel:SetHidden(true)
    end
    --Points
    control.pointsLabel:SetText(data.points)
        
    --Background
    local bg = GetControl(control, "BG")
    if bg then
        local hidden = (data.index % 2) == 0
        bg:SetHidden(hidden)
    end
end
function ZO_LeaderboardsManager_Shared:CommitScrollList()
    ZO_SortFilterList.CommitScrollList(self)
end
do
    local INCLUDE_ALL_FILTER =
    {
        [LEADERBOARD_TYPE_OVERALL] = true,
        [LEADERBOARD_TYPE_ALLIANCE] = true,
        [LEADERBOARD_TYPE_BATTLEGROUND] = true,
        [LEADERBOARD_TYPE_TRIBUTE] = true,
        [LEADERBOARD_TYPE_ENDLESS_DUNGEON_OVERALL] = true,
    }
    local INCLUDE_CLASS_FILTERS =
    {
        [LEADERBOARD_TYPE_OVERALL] = true,
        [LEADERBOARD_TYPE_ALLIANCE] = true,
        [LEADERBOARD_TYPE_CLASS] = true,
        [LEADERBOARD_TYPE_ENDLESS_DUNGEON_OVERALL] = true,
        [LEADERBOARD_TYPE_ENDLESS_DUNGEON_CLASS] = true,
    }
    function ZO_Leaderboards_PopulateDropdownFilter(dropdown, changedCallback, leaderboardType)
        dropdown:ClearItems()
        local defaultIndex = 1
        local currentIndex = 0
        local includeAllFilter = INCLUDE_ALL_FILTER[leaderboardType]
        if includeAllFilter then
            local entry = dropdown:CreateItemEntry(GetString(SI_LEADERBOARDS_FILTER_ALL_CLASSES), changedCallback)
            dropdown:AddItem(entry, ZO_COMBOBOX_SUPPRESS_UPDATE)
            currentIndex = currentIndex + 1
        end
        if INCLUDE_CLASS_FILTERS[leaderboardType] then
            local desiredClass = not includeAllFilter and GetUnitClassId("player")
            for i = 1, GetNumClasses() do
                local classId = GetClassInfo(i)
                local className = zo_strformat(SI_CLASS_NAME, GetClassName(GENDER_MALE, classId))
                local entry = dropdown:CreateItemEntry(className, changedCallback)
                entry.classId = classId
                dropdown:AddItem(entry, ZO_COMBOBOX_SUPPRESS_UPDATE)
                currentIndex = currentIndex + 1
                if desiredClass and desiredClass == classId then
                    defaultIndex = currentIndex
                end
            end
        end
        local IGNORE_CALLBACK = true
        dropdown:SelectItemByIndex(defaultIndex, IGNORE_CALLBACK)
        dropdown:GetContainer():SetHidden(currentIndex == 1)
    end
end