Back to Home

ESO Lua File v101050

ingame/campaign/keyboard/campaignoverview.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
ZO_CAMPAIGN_OVERVIEW_TYPE =
{
    SCORING = 1,
    BONUSES = 2,
    EMPEROR = 3,
    VENGEANCE = 4,
}
ZO_CAMPAIGN_OVERVIEW_TYPE_VENGEANCE =
{
    LOADOUTS = 1,
    PERKS = 2,
}
ZO_CAMPAIGN_OVERVIEW_TYPE_INFO =
{
    [ZO_CAMPAIGN_OVERVIEW_TYPE.SCORING] =
    {
        name = GetString(SI_CAMPAIGN_OVERVIEW_CATEGORY_SCORING),
        normalIcon = "EsoUI/Art/Campaign/overview_indexIcon_scoring_up.dds",
        pressedIcon = "EsoUI/Art/Campaign/overview_indexIcon_scoring_down.dds",
        mouseoverIcon = "EsoUI/Art/Campaign/overview_indexIcon_scoring_over.dds",
        priority = ZO_CAMPAIGN_OVERVIEW_TYPE.SCORING * 10,
        categoryFragmentFunction = function()
            CAMPAIGN_OVERVIEW:RemoveAllCategoryFragments()
            CAMPAIGN_OVERVIEW:ShowCampaignSelector()
            CAMPAIGN_OVERVIEW_SCENE:AddFragment(CAMPAIGN_SCORING_FRAGMENT)
        end,
    },
    [ZO_CAMPAIGN_OVERVIEW_TYPE.VENGEANCE] =
    {
        name = GetString(SI_CAMPAIGN_OVERVIEW_CATEGORY_VENGEANCE),
        normalIcon = "EsoUI/Art/Campaign/overview_indexIcon_vengeance_up.dds",
        pressedIcon = "EsoUI/Art/Campaign/overview_indexIcon_vengeance_down.dds",
        mouseoverIcon = "EsoUI/Art/Campaign/overview_indexIcon_vengeance_over.dds",
        priority = 12,
        children =
        {
            [ZO_CAMPAIGN_OVERVIEW_TYPE_VENGEANCE.LOADOUTS] =
            {
                name = GetString(SI_CAMPAIGN_OVERVIEW_SUBCATEGORY_LOADOUTS),
                categoryFragmentFunction = function()
                    CAMPAIGN_OVERVIEW:RemoveAllCategoryFragments()
                    CAMPAIGN_OVERVIEW:HideCampaignSelector()
                    CAMPAIGN_OVERVIEW_SCENE:AddFragment(VENGEANCE_LOADOUT_KEYBOARD_FRAGMENT)
                end,
            },
            [ZO_CAMPAIGN_OVERVIEW_TYPE_VENGEANCE.PERKS] =
            {
                name = GetString(SI_CAMPAIGN_OVERVIEW_SUBCATEGORY_PERKS),
                categoryFragmentFunction = function()
                    CAMPAIGN_OVERVIEW:RemoveAllCategoryFragments()
                    CAMPAIGN_OVERVIEW:HideCampaignSelector()
                    CAMPAIGN_OVERVIEW_SCENE:AddFragment(VENGEANCE_PERKS_KEYBOARD_FRAGMENT)
                end,
            }
        },
    },
    [ZO_CAMPAIGN_OVERVIEW_TYPE.BONUSES] =
    {
        name = GetString(SI_CAMPAIGN_OVERVIEW_CATEGORY_BONUSES),
        normalIcon = "EsoUI/Art/Campaign/overview_indexIcon_bonus_up.dds",
        pressedIcon = "EsoUI/Art/Campaign/overview_indexIcon_bonus_down.dds",
        mouseoverIcon = "EsoUI/Art/Campaign/overview_indexIcon_bonus_over.dds",
        priority = ZO_CAMPAIGN_OVERVIEW_TYPE.BONUSES * 10,
        categoryFragmentFunction = function()
            CAMPAIGN_OVERVIEW:RemoveAllCategoryFragments()
            CAMPAIGN_OVERVIEW:ShowCampaignSelector()
            CAMPAIGN_OVERVIEW_SCENE:AddFragment(CAMPAIGN_BONUSES_FRAGMENT)
        end,
        visible = function() return GetAssignedCampaignId() ~= 0 end,
    },
    [ZO_CAMPAIGN_OVERVIEW_TYPE.EMPEROR] =
    {
        name = GetString(SI_CAMPAIGN_OVERVIEW_CATEGORY_EMPERORSHIP),
        normalIcon = "EsoUI/Art/Campaign/overview_indexIcon_emperor_up.dds",
        pressedIcon = "EsoUI/Art/Campaign/overview_indexIcon_emperor_down.dds",
        mouseoverIcon = "EsoUI/Art/Campaign/overview_indexIcon_emperor_over.dds",
        priority = ZO_CAMPAIGN_OVERVIEW_TYPE.EMPEROR * 10,
        categoryFragmentFunction = function()
            CAMPAIGN_OVERVIEW:RemoveAllCategoryFragments()
            CAMPAIGN_OVERVIEW:ShowCampaignSelector()
            CAMPAIGN_OVERVIEW_SCENE:AddFragment(CAMPAIGN_EMPEROR_FRAGMENT)
        end,
    },
}
ZO_CampaignOverviewManager = ZO_InitializingObject:Subclass()
function ZO_CampaignOverviewManager:Initialize(control)
    self.control = control
    self.shouldShowVengeanceLoadouts = false
    local function OnStateChange(oldState, newState)
        if newState == ZO_STATE.SHOWING then
            if self.currentCategoryFragmentFunction then
                self.currentCategoryFragmentFunction()
            end
            if self.categoryFragmentToShow then
                self:SetCurrentCategory(self.categoryFragmentToShow)
                self.categoryFragmentToShow = nil
            end
            if self.categoryDataToShow then
                self:SetCurrentCategoryByData(self.categoryDataToShow)
                self.categoryDataToShow = nil
            end
        elseif newState == SCENE_HIDDEN then
            VETERANCY_KEYBOARD:SetPreviousCampaignScene("campaignOverview")
        end
    end
    CAMPAIGN_OVERVIEW_SCENE = ZO_Scene:New("campaignOverview", SCENE_MANAGER)
    CAMPAIGN_OVERVIEW_SCENE:RegisterCallback("StateChange", OnStateChange)
    self.campaignName = self.control:GetNamedChild("CampaignName")
    self.campaignDivider = self.control:GetNamedChild("TopDivider")
end
function ZO_CampaignOverviewManager:UpdateCampaignName(campaignId)
    local campaignName = GetCampaignName(campaignId)
    self.campaignName:SetText(campaignName)
end
function ZO_CampaignOverviewManager:SetCampaignAndQueryType(campaignId, queryType)
    self:UpdateCampaignName(campaignId)
end
function ZO_CampaignOverviewManager:InitializeCategories()
    self.navigationTree = ZO_Tree:New(self.control:GetNamedChild("Categories"), 60, -10, 280)
    self.categoryFragmentToNodeLookup = {}
    self.nodeList = {}
    local function RefreshNode(control, categoryData, open)
        if control.icon then
            local iconTexture = open and categoryData.pressedIcon or categoryData.normalIcon
            if type(iconTexture) == "function" then
                iconTexture = iconTexture()
            end
            control.icon:SetTexture(iconTexture)
            local mouseoverIcon = categoryData.mouseoverIcon
            if type(mouseoverIcon) == "function" then
                mouseoverIcon = mouseoverIcon()
            end
            control.iconHighlight:SetTexture(mouseoverIcon)
            local statusIcon = control.statusIcon or control:GetNamedChild("StatusIcon")
            control.statusIcon = statusIcon
            statusIcon:ClearIcons()
            if ZO_Eval(categoryData.isNew) then
                statusIcon:AddIcon(ZO_KEYBOARD_NEW_ICON)
            end
            statusIcon:Show()
            ZO_IconHeader_Setup(control, open)
        end
    end
    local function SetupNode(node, control, categoryData, open)
        control.text:SetText(categoryData.name)
        control.text:SetModifyTextType(MODIFY_TEXT_TYPE_UPPERCASE)
        local selected = node.selected or open
        RefreshNode(control, categoryData, selected)
    end
    local function SetupParentNode(node, control, categoryData, open, userRequested)
        SetupNode(node, control, categoryData, open)
        if open and userRequested then
            local selectedNode = self.navigationTree:GetSelectedNode()
            if not selectedNode or selectedNode.parentNode ~= node then
                self.navigationTree:SelectFirstChild(node)
            end
        end
        local statusIcon = control.statusIcon or control:GetNamedChild("StatusIcon")
        control.statusIcon = statusIcon
        statusIcon:ClearIcons()
        if ZO_Eval(categoryData.isNew) then
            statusIcon:AddIcon(ZO_KEYBOARD_NEW_ICON)
        end
        statusIcon:Show()
    end
    local function SetupChildNode(node, control, categoryData, open)
        local selected = node:IsSelected()
        control:SetSelected(selected)
        control:SetText(categoryData.name)
        if categoryData.onSetup then
            categoryData.onSetup(node, control, categoryData, open)
        end
    end
    local function OnNodeSelected(control, categoryData, selected, reselectingDuringRebuild)
        control:SetSelected(selected)
        if selected then
            if CAMPAIGN_OVERVIEW_SCENE:IsShowing() then
                -- Order matters:
                local hasCategoryChanged = self.currentCategoryFragmentFunction ~= categoryData.categoryFragmentFunction
                self.currentCategoryFragmentFunction = categoryData.categoryFragmentFunction
                if categoryData.onTreeEntrySelected then
                    categoryData.onTreeEntrySelected(categoryData)
                end
                if hasCategoryChanged and self.currentCategoryFragmentFunction then
                    self.currentCategoryFragmentFunction()
                end
            else
                -- Queue the category to show by category data,
                -- if possible, or by category fragment otherwise.
                if not self:SetCategoryOnShowByData(categoryData) then
                    self:SetCategoryOnShow(categoryData.categoryFragment)
                end
            end
        end
        RefreshNode(control, categoryData, selected)
    end
    local CHILD_SPACING = 0
    local NO_SELECTION_FUNCTION = nil
    local NO_EQUALITY_FUNCTION = nil
    local function EqualityFunction(left, right)
        if left.equalityFunction then
            return left:equalityFunction(right)
        elseif right.equalityFunction then
            return right:equalityFunction(left)
        end
        return left == right
    end
    self.navigationTree:AddTemplate("ZO_GroupMenuKeyboard_StatusIconHeader", SetupParentNode, NO_SELECTION_FUNCTION, NO_EQUALITY_FUNCTION, ZO_GROUP_MENU_KEYBOARD_TREE_SUBCATEGORY_INDENT, CHILD_SPACING)
    self.navigationTree:AddTemplate("ZO_GroupMenuKeyboard_StatusIconChildlessHeader", SetupNode, OnNodeSelected, EqualityFunction)
    self.navigationTree:AddTemplate("ZO_GroupMenuKeyboard_Subcategory", SetupChildNode, OnNodeSelected, EqualityFunction)
    self.navigationTree:SetExclusive(true)
    self.navigationTree:SetOpenAnimation("ZO_TreeOpenAnimation")
    local function OnPlayerActivated()
        self:RefreshCategories()
    end
    self.control:RegisterForEvent(EVENT_PLAYER_ACTIVATED, OnPlayerActivated)
end
function ZO_CampaignOverviewManager:GetTreeNodeByCategoryFragment(categoryFragment)
    local node = self.categoryFragmentToNodeLookup[categoryFragment]
    return node
end
function ZO_CampaignOverviewManager:GetTreeNodeByCategoryData(categoryData)
    local node = self.navigationTree:GetTreeNodeByData(categoryData)
    return node
end
-- Queue the specified category fragment to show.
function ZO_CampaignOverviewManager:SetCategoryOnShow(categoryFragment)
    if node then
        -- categoryDataToShow and categoryFragmentToShow are mutually exclusive.
        self.categoryFragmentToShow = categoryFragment
        self.categoryDataToShow = nil
        return true
    end
    return false
end
-- Queue the specified category data to show.
function ZO_CampaignOverviewManager:SetCategoryOnShowByData(categoryData)
    local node = self:GetTreeNodeByCategoryData(categoryData)
    if node then
        -- categoryDataToShow and categoryFragmentToShow are mutually exclusive.
        self.categoryDataToShow = categoryData
        self.categoryFragmentToShow = nil
        return true
    end
    return false
end
-- Show the specified category fragment, if the Campaign Overview is showing, or queue it to show.
function ZO_CampaignOverviewManager:SetCurrentCategory(categoryFragment)
    if CAMPAIGN_OVERVIEW_SCENE:IsShowing() then
        -- Look up the tree node associated with the queued category fragment and select it.
        local node = self:GetTreeNodeByCategoryFragment(categoryFragment)
        if node then
            self.navigationTree:SelectNode(node)
        end
    else
        -- Queue the category fragment to show.
    end
end
-- Show the specified category data, if the Campaign Overview is showing, or queue it to show.
function ZO_CampaignOverviewManager:SetCurrentCategoryByData(categoryData)
    if CAMPAIGN_OVERVIEW_SCENE:IsShowing() then
        -- Look up the tree node associated with the queued category data and select it.
        local node = self:GetTreeNodeByCategoryData(categoryData)
        if node then
            local nodeIsSelected = node == self.navigationTree:GetSelectedNode()
            if nodeIsSelected then
                if not self.currentCategoryFragment or self.currentCategoryFragment ~= categoryData.categoryFragment then
                    -- In this case the node was auto-selected while hidden or on selection
                    -- was not called before the screen was hidden we need to force the node's
                    -- selection function to run again so it runs it's on showing code.
                    node:OnSelected()
                end
            else
                self.navigationTree:SelectNode(node)
            end
        end
    else
        -- Queue the category data to show.
        self:SetCategoryOnShowByData(categoryData)
    end
end
do
    local function PrioritySort(item1, item2)
        local priority1, priority2 = item1.priority, item2.priority
        if priority1 == priority2 then
            return item1.name < item2.name
        elseif priority1 and priority2 then
            return priority1 < priority2
        else
            return priority1 ~= nil
        end
    end
    function ZO_CampaignOverviewManager:RefreshCategories()
        local selectedParentData = nil
        local selectedNode = self.navigationTree:GetSelectedNode()
        if selectedNode then
            local parentNode = selectedNode:GetParent()
            if parentNode then
                selectedParentData = parentNode:GetData()
            end
        end
        self.navigationTree:Reset()
        ZO_ClearTable(self.categoryFragmentToNodeLookup)
        self:AddCategoryTreeNodes(ZO_CAMPAIGN_OVERVIEW_TYPE_INFO)
        --Order matters: Do this after the category nodes have been added
        local nodeToSelect
        if selectedParentData then
            local parentNode = self.navigationTree:GetTreeNodeByData(selectedParentData)
            if parentNode then
                nodeToSelect = parentNode:GetChild(1)
            end
        end
        self.navigationTree:Commit(nodeToSelect)
    end
    function ZO_CampaignOverviewManager:AddCategoryTreeNodes(nodeDataList, parentNode)
        local sortedNodeDataList = ZO_CreateSortableTableFromValues(nodeDataList)
        table.sort(sortedNodeDataList, PrioritySort)
        for index, nodeData in ipairs(sortedNodeDataList) do
            local isVisible = true
            if nodeData.visible ~= nil then
                isVisible = nodeData.visible
                if type(isVisible) == "function" then
                    isVisible = isVisible()
                end
            end
            if isVisible then
                local node = self:AddCategoryTreeNode(nodeData, parentNode)
                local children = nodeData.children
                if nodeData.getChildrenFunction then
                    children = nodeData.getChildrenFunction()
                end
                if children and #children > 0 then
                    self:AddCategoryTreeNodes(children, node)
                end
            end
        end
    end
    function ZO_CampaignOverviewManager:AddCategoryTreeNode(nodeData, parentNode)
        local nodeTemplate
        if parentNode then
            nodeTemplate = "ZO_GroupMenuKeyboard_Subcategory"
        elseif nodeData.children or (nodeData.getChildrenFunction and #(nodeData.getChildrenFunction()) > 0) then
            nodeTemplate = "ZO_GroupMenuKeyboard_StatusIconHeader"
        else
            nodeTemplate = "ZO_GroupMenuKeyboard_StatusIconChildlessHeader"
        end
        local node = self.navigationTree:AddNode(nodeTemplate, nodeData, parentNode)
        if nodeData.categoryFragment then
            local existingFragmentNode = self.categoryFragmentToNodeLookup[nodeData.categoryFragment]
            if not existingFragmentNode or nodeData.priority < existingFragmentNode:GetData().priority then
                self.categoryFragmentToNodeLookup[nodeData.categoryFragment] = node
            end
        end
        if nodeData.getChildrenFunction then
            node.getChildrenFunction = nodeData.getChildrenFunction
        end
        return node
    end
end
function ZO_CampaignOverviewManager:RemoveAllCategoryFragments()
    CAMPAIGN_OVERVIEW_SCENE:RemoveFragment(CAMPAIGN_SCORING_FRAGMENT)
    CAMPAIGN_OVERVIEW_SCENE:RemoveFragment(CAMPAIGN_BONUSES_FRAGMENT)
    CAMPAIGN_OVERVIEW_SCENE:RemoveFragment(CAMPAIGN_EMPEROR_FRAGMENT)
    CAMPAIGN_OVERVIEW_SCENE:RemoveFragment(VENGEANCE_LOADOUT_KEYBOARD_FRAGMENT)
    CAMPAIGN_OVERVIEW_SCENE:RemoveFragment(VENGEANCE_PERKS_KEYBOARD_FRAGMENT)
end
function ZO_CampaignOverviewManager:ShowCampaignSelector()
    self.campaignName:SetHidden(false)
    self.campaignDivider:SetHidden(false)
    CAMPAIGN_OVERVIEW_SCENE:AddFragment(CAMPAIGN_SELECTOR_FRAGMENT)
end
function ZO_CampaignOverviewManager:HideCampaignSelector()
    self.campaignName:SetHidden(true)
    self.campaignDivider:SetHidden(true)
    CAMPAIGN_OVERVIEW_SCENE:RemoveFragment(CAMPAIGN_SELECTOR_FRAGMENT)
end
-----------------------------
-- Global XML Functions
-----------------------------
    CAMPAIGN_OVERVIEW = ZO_CampaignOverviewManager:New(self)
end