ESO Lua File v100015

ingame/collections/gamepad/collectionsbook_gamepad.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
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
ZO_DLC_BACKGROUND_TEXTURE_SQUARE_DIMENSION = 1024
ZO_DLC_BACKGROUND_TEXTURE_COORD_RIGHT = ZO_GAMEPAD_QUADRANT_2_3_CONTENT_BACKGROUND_WIDTH / ZO_DLC_BACKGROUND_TEXTURE_SQUARE_DIMENSION
local GAMEPAD_COLLECTIONS_ACTIONS_DIALOG_NAME = "GAMEPAD_COLLECTIONS_ACTIONS_DIALOG"
local GAMEPAD_COLLECTIONS_RENAME_COLLECTIBLE_DIALOG_NAME = "GAMEPAD_COLLECTIONS_INVENTORY_RENAME_COLLECTIBLE"
local NOTIFICATIONS_PROVIDER = GAMEPAD_NOTIFICATIONS:GetCollectionsProvider()
local TIME_NEW_PERSISTS_WHILE_SELECTED_MS = 200
local BLOCK_TABBAR_CALLBACK = true
local ZO_GamepadCollectionsBook = ZO_Gamepad_ParametricList_Screen:Subclass()
function ZO_GamepadCollectionsBook:New(...)
    return ZO_Gamepad_ParametricList_Screen.New(self, ...)
end
function ZO_GamepadCollectionsBook:Initialize(control)
    GAMEPAD_COLLECTIONS_BOOK_SCENE = ZO_Scene:New("gamepadCollectionsBook", SCENE_MANAGER)
    local ACTIVATE_ON_SHOW = true
    ZO_Gamepad_ParametricList_Screen.Initialize(self, control, ZO_GAMEPAD_HEADER_TABBAR_CREATE, ACTIVATE_ON_SHOW, GAMEPAD_COLLECTIONS_BOOK_SCENE)
    
    self.categoryList = {}
    self.categoryList.list = ZO_Gamepad_ParametricList_Screen.GetMainList(self)
    self.categoryList.fragment = self:GetListFragment(self.categoryList.list)
    self.categoryList.keybind = self.categoryKeybindStripDescriptor
    ZO_Gamepad_AddListTriggerKeybindDescriptors(self.categoryKeybindStripDescriptor , self.categoryList.list)
    self.categoryList.headerText = nil
    self.categoryList.titleText = GetString(SI_MAIN_MENU_COLLECTIONS)
    self.collectionList = {}
    self.collectionList.list = self:AddList("Collection")
    self.collectionList.fragment = self:CreateListFragment("Collection")
    self.collectionList.keybind = self.collectionKeybindStripDescriptor
    ZO_Gamepad_AddListTriggerKeybindDescriptors(self.collectionKeybindStripDescriptor, self.collectionList.list)
    self.collectionList.headerText = GetString(SI_MAIN_MENU_COLLECTIONS)
    self.collectionList.titleText = nil
    self.updateList = {}
    self.currentList = nil
    self.tabBarEntries = {}
    self.trySetClearNewFlagCallback = function(callId)
        self:TrySetClearNewFlag(callId)
    end
    self.headerData = {}
    self.control:RegisterForEvent(EVENT_VISUAL_LAYER_CHANGED, function()
                                                                    if GAMEPAD_COLLECTIONS_BOOK_SCENE:IsShowing() and self.collectionList.data.categoryIndex then
                                                                        self:UpdateCollectionListVisualLayer()
                                                                    end
                                                                end)
    SYSTEMS:RegisterGamepadObject(ZO_COLLECTIONS_SYSTEM_NAME, self)
    COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnCollectibleUpdated", function(...) self:OnCollectibleUpdated(...) end)
    COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnCollectionUpdated", function(...) self:OnCollectionUpdated(...) end)
    COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnCollectionNotificationRemoved", function(...) self:OnCollectionNotificationRemoved(...) end)
    COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnUpdateCooldowns", function(...) self:OnUpdateCooldowns(...) end)
    EVENT_MANAGER:RegisterForUpdate("ZO_GamepadCollectionsBook", 250, function() self:UpdateActiveCollectibleCooldownTimer() end)
end
function ZO_GamepadCollectionsBook:InitializeInfoPanel()
    local infoPanel = self.control:GetNamedChild("InfoPanel")
    infoPanel.backgroundControl = infoPanel:GetNamedChild("Background")
    local container = infoPanel:GetNamedChild("Container")
    infoPanel.unlockStatusControl = container:GetNamedChild("UnlockStatusLabel")
    infoPanel.nameControl = container:GetNamedChild("Name")
    infoPanel.questStatusControl = container:GetNamedChild("QuestStatusValue")
    local scrollContainer = container:GetNamedChild("ScrollSection"):GetNamedChild("ScrollChild")
    infoPanel.descriptionControl = scrollContainer:GetNamedChild("Description")
    infoPanel.questAcceptIndicator = scrollContainer:GetNamedChild("QuestAcceptIndicator")
    infoPanel.questAcceptDescription = scrollContainer:GetNamedChild("QuestAcceptDescription")
    self.infoPanelControl = infoPanel
end
function ZO_GamepadCollectionsBook:SetupList(list)
    local function CategoryEntrySetup(control, data, selected, reselectingDuringRebuild, enabled, active)
        ZO_SharedGamepadEntry_OnSetup(control, data, selected, reselectingDuringRebuild, enabled, active)
        local entryData = data.data
        if self:HasAnyNotifications(entryData.categoryIndex) or (COLLECTIONS_BOOK_SINGLETON:IsCategoryIndexDLC(entryData.categoryIndex) and COLLECTIONS_BOOK_SINGLETON:DoesAnyDLCHaveQuestPending()) then
            control.icon:ClearIcons()
            control.icon:AddIcon(entryData.icon)
            control.icon:AddIcon(ZO_GAMEPAD_NEW_ICON_64)
            control.icon:Show()
        end
    end
    list:AddDataTemplateWithHeader("ZO_GamepadMenuEntryTemplate", CategoryEntrySetup, ZO_GamepadMenuEntryTemplateParametricListFunction, nil, "ZO_GamepadMenuEntryHeaderTemplate")
    local function CollectibleEntrySetup(control, data, selected, reselectingDuringRebuild, enabled, active)
        data.brandNew = data.data.notificationId ~= nil or COLLECTIONS_BOOK_SINGLETON:IsDLCIdQuestPending(data.collectibleId)
        if not data.hasNameBeenFormatted then
            data:SetText(zo_strformat(SI_COLLECTIBLE_NAME_FORMATTER, data.name))
            data.hasNameBeenFormatted = true
        end
        ZO_SharedGamepadEntry_OnSetup(control, data, selected, reselectingDuringRebuild, enabled, active)
    end
    list:AddDataTemplateWithHeader("ZO_GamepadItemEntryTemplate", CollectibleEntrySetup, ZO_GamepadMenuEntryTemplateParametricListFunction, nil, "ZO_GamepadMenuEntryHeaderTemplate")
end
function ZO_GamepadCollectionsBook:OnShowing()
    ZO_Gamepad_ParametricList_Screen.OnShowing(self)
    
    self:ShowList(self.categoryList)
    if self.browseToCollectibleInfo then
        self:ViewCategory(self.browseToCollectibleInfo.categoryIndex)
        self:SelectCollectibleEntry(self.browseToCollectibleInfo.collectibleId)
        self.browseToCollectibleInfo = nil
    end
end
function ZO_GamepadCollectionsBook:OnHiding()
    ZO_Gamepad_ParametricList_Screen.OnHiding(self)
end
function ZO_GamepadCollectionsBook:OnHide()
end
function ZO_GamepadCollectionsBook:ActivateHeader()
end
function ZO_GamepadCollectionsBook:DeactivateHeader()
end
function ZO_GamepadCollectionsBook:RefreshHeader(blockCallback)
    ZO_GamepadGenericHeader_Refresh(self.header, self.headerData, blockCallback)
end
function ZO_GamepadCollectionsBook:InitializeKeybindStripDescriptors()
    -- Category Keybind
    self.categoryKeybindStripDescriptor =
    {
        alignment = KEYBIND_STRIP_ALIGN_LEFT,
        -- Select Category
        {
            name = GetString(SI_GAMEPAD_SELECT_OPTION),
            keybind = "UI_SHORTCUT_PRIMARY",
            callback = function()
                self:ViewCategory()
            end,
            visible = function()
                if self.currentList then
                    local entryData = self.currentList.list:GetTargetData()
                    return entryData ~= nil
                end
                return false
            end,
            sound = SOUNDS.GAMEPAD_MENU_FORWARD,
        },
    }
    ZO_Gamepad_AddBackNavigationKeybindDescriptors(self.categoryKeybindStripDescriptor, GAME_NAVIGATION_TYPE_BUTTON)
    -- Collection Keybind
    self.collectionKeybindStripDescriptor =
    {
        alignment = KEYBIND_STRIP_ALIGN_LEFT,
        -- Set Active or Put Away Collectible
        {
            name = function()
                local entryData = self.currentList.list:GetTargetData()
                local collectibleData = entryData.data
                local categoryType = collectibleData.categoryType
                local nameStringId
                if categoryType == COLLECTIBLE_CATEGORY_TYPE_DLC then
                    nameStringId = SI_DLC_BOOK_ACTION_ACCEPT_QUEST
                elseif categoryType == COLLECTIBLE_CATEGORY_TYPE_TROPHY then
                    nameStringId = SI_COLLECTIBLE_ACTION_USE
                elseif collectibleData.active then
                    if categoryType == COLLECTIBLE_CATEGORY_TYPE_ASSISTANT or categoryType == COLLECTIBLE_CATEGORY_TYPE_VANITY_PET then
                        nameStringId = SI_COLLECTIBLE_ACTION_DISMISS
                    else
                        nameStringId = SI_COLLECTIBLE_ACTION_PUT_AWAY
                    end
                else
                    nameStringId = SI_COLLECTIBLE_ACTION_SET_ACTIVE
                end
                return GetString(nameStringId)
            end,
            keybind = "UI_SHORTCUT_PRIMARY",
            callback = function()
                local entryData = self.currentList.list:GetTargetData()
                local collectibleData = entryData.data
                UseCollectible(collectibleData.collectibleId)
            end,
            visible = function()
                local entryData = self.currentList.list:GetTargetData()
                if entryData and entryData.data then
                    local collectibleData = entryData.data
                    return collectibleData.useable
                else
                    return false
                end
            end,
            sound = SOUNDS.DEFAULT_CLICK,
            enabled = function()
                local entryData = self.currentList.list:GetTargetData()
                if entryData and entryData.data and entryData.data.useable then
                    local remaining = GetCollectibleCooldownAndDuration(entryData.data.collectibleId)
                    if entryData.data.active then
                        return true
                    elseif remaining > 0 then
                        return false, GetString(SI_COLLECTIONS_COOLDOWN_ERROR)
                    elseif entryData.data.blocked then
                        return false, GetString(SI_COLLECTIONS_BLOCKED_ERROR)
                    else
                        return true
                    end
                end
                return false
            end  
        },
        --Assign to Quick Slot
        {
            name = GetString(SI_GAMEPAD_ITEM_ACTION_QUICKSLOT_ASSIGN),
            keybind = "UI_SHORTCUT_SECONDARY",
            callback = function()
                local entryData = self.currentList.list:GetTargetData()
                GAMEPAD_QUICKSLOT:SetCollectibleToQuickslot(entryData.data.collectibleId)
                SCENE_MANAGER:Push("gamepad_quickslot")
            end,
            visible = function()
                local entryData = self.currentList.list:GetTargetData()
                local categoryType = entryData.categoryType
                return entryData.data.unlocked and IsCollectibleCategorySlottable(categoryType)
            end,
            sound = SOUNDS.GAMEPAD_MENU_FORWARD,
        },
        -- Actions
        {
            -- If there is never going to be a "Link to chat" option then there will only ever be "rename." Since design considers an
            -- "action panel" with only one action silly, we want to just make "rename" the default keybind with no other action layer
            name = GetString(IsChatSystemAvailableForCurrentPlatform() and SI_GAMEPAD_INVENTORY_ACTION_LIST_KEYBIND or SI_COLLECTIBLE_ACTION_RENAME),
            keybind = "UI_SHORTCUT_TERTIARY",
            callback = function()
                local entryData = self.currentList.list:GetTargetData()
                local collectibleData = entryData.data
                if IsChatSystemAvailableForCurrentPlatform() then
                    local dialogData = 
                    {
                        collectibleId = collectibleData.collectibleId,
                        name = collectibleData.nickname,
                        active = collectibleData.active,
                    }
                    ZO_Dialogs_ShowGamepadDialog(GAMEPAD_COLLECTIONS_ACTIONS_DIALOG_NAME, dialogData)
                else
                    ZO_Dialogs_ShowGamepadDialog(GAMEPAD_COLLECTIONS_RENAME_COLLECTIBLE_DIALOG_NAME, { collectibleId = collectibleData.collectibleId, name = collectibleData.nickname })
                end
            end,
            visible = function()
                local entryData = self.currentList.list:GetTargetData()
                local collectibleData = entryData and entryData.data
                
                if collectibleData then
                    if IsChatSystemAvailableForCurrentPlatform() then --Every collectible can link to chat
                        return true
                    else
                        return IsCollectibleRenameable(collectibleData.collectibleId)
                    end
                else
                    return false
                end
            end,
        },
        --Subscribe
        {
            alignment = KEYBIND_STRIP_ALIGN_RIGHT,
            name = GetString(SI_DLC_BOOK_ACTION_GET_SUBSCRIPTION),
            keybind = "UI_SHORTCUT_RIGHT_STICK",
            callback = function()
                if GetUIPlatform() == UI_PLATFORM_PC then
                    ZO_Dialogs_ShowGamepadDialog("CONFIRM_OPEN_URL_BY_TYPE", { urlType = APPROVED_URL_ESO_ACCOUNT_SUBSCRIPTION }, { mainTextParams = { GetString(SI_ESO_PLUS_SUBSCRIPTION_LINK_TEXT), GetString(SI_URL_APPLICATION_WEB) } })
                else
                    ZO_Dialogs_ShowGamepadDialog("CONSOLE_BUY_ESO_PLUS")
                end
            end,
            visible = function()
                local entryData = self.currentList.list:GetTargetData()
                local collectibleData = entryData.data
                return collectibleData.categoryType == COLLECTIBLE_CATEGORY_TYPE_DLC and not IsESOPlusSubscriber()
            end,
        },
    }
    ZO_Gamepad_AddBackNavigationKeybindDescriptorsWithSound(self.collectionKeybindStripDescriptor, GAME_NAVIGATION_TYPE_BUTTON, function() self:ShowList(self.categoryList) end )
end
--Opens up the provided category, or the current category if no categoryIndex is provided
function ZO_GamepadCollectionsBook:ViewCategory(categoryIndex)
    if categoryIndex then
        self.categoryList.list:SetSelectedIndexWithoutAnimation(categoryIndex)
    end
    local entryData = self.categoryList.list:GetTargetData()
    self.collectionList.data = entryData.data
    local BUILD_SUBCATEGORY_TABS = true
    self:BuildCollectionList(nil, BUILD_SUBCATEGORY_TABS)
    self:ShowList(self.collectionList)
end
function ZO_GamepadCollectionsBook:SelectCollectibleEntry(collectibleId)
    if collectibleId then
        local list = self.collectionList.list
        for i = 1, list:GetNumItems() do
            local data = list:GetDataForDataIndex(i)
            if data.data.collectibleId == collectibleId then
                list:SetSelectedIndexWithoutAnimation(i)
                break
            end
        end
    end
end
function ZO_GamepadCollectionsBook:PerformUpdate()
end
function ZO_GamepadCollectionsBook:ShowList(list, dontUpdateTitle)
    if self.currentList == list then
        return
    end
    self.currentList = list
    if list then
        KEYBIND_STRIP:AddKeybindButtonGroup(self.currentList.keybind)
        SCENE_MANAGER:AddFragment(list.fragment)
        list.list:Activate()
    end
    if not dontUpdateTitle then
        self.headerData.titleText = zo_strformat(SI_COLLECTIBLE_NAME_FORMATTER, list.titleText)
        self:RefreshHeader(BLOCK_TABBAR_CALLBACK)
    end
    if self.currentList == self.collectionList then
        local targetData = self.collectionList.list:GetTargetData()
        self:RefreshTooltip(targetData)
        self.notificationIdToClear = targetData.data.notificationId
        if self.notificationIdToClear then
            self.clearNewStatusOnSelectionChanged = true
        end
        if self.headerData.tabBarEntries == nil and #self.tabBarEntries > 0 then
            self.headerData.tabBarEntries = self.tabBarEntries
            self:RefreshHeader()
            self:ActivateHeader()
        end
    else
        self.headerData.tabBarEntries = nil
        self:RefreshHeader(BLOCK_TABBAR_CALLBACK)
        self:DeactivateHeader()
    end
end
function ZO_GamepadCollectionsBook:HideCurrentList()
    if self.currentList == nil then
        return
    end
    if self.currentList == self.collectionList then
        if self.notificationIdToClear then
            RemoveCollectibleNotification(self.notificationIdToClear)
        end
        self.clearNewStatusOnSelectionChanged = false
        self.notificationIdToClear = nil
        self.clearNewStatusCallId = nil
    end
    KEYBIND_STRIP:RemoveKeybindButtonGroup(self.currentList.keybind)
    SCENE_MANAGER:RemoveFragment(self.currentList.fragment)
    self.currentList.list:Deactivate()
    self.currentList = nil
    self:RefreshTooltip(nil)
end
function ZO_GamepadCollectionsBook:OnCollectionUpdated()
    if not self.control:IsHidden() then
        if self.categoryList then
            self:BuildCategoryList()
        end
    end
end
function ZO_GamepadCollectionsBook:OnCollectibleUpdated(collectibleId)
    if not self.control:IsHidden() then
        if self.currentList == self.collectionList and self.collectionList then
            self:BuildCollectionList(self.currentSubCategoryIndex)
        end
        self.categoryList.list:RefreshVisible()
    end
end
function ZO_GamepadCollectionsBook:OnCollectionNotificationRemoved(notificationId, collectibleId)
    if not self.control:IsHidden() then
        if self.currentList == self.collectionList then
            self.currentList.list:RefreshVisible()
        end
        self.categoryList.list:RefreshVisible()
    end
end
function ZO_GamepadCollectionsBook:BuildCategoryList()
    self.categoryList.list:Clear()
    -- Add the categories entries
    for categoryIndex = 1, GetNumCollectibleCategories() do
        local categoryName, numSubCategories, numCollectibles, unlockedCollectibles, totalCollectibles, hidesUnearned = GetCollectibleCategoryInfo(categoryIndex)
        local gamepadIcon = GetCollectibleCategoryGamepadIcon(categoryIndex)
        categoryName = zo_strformat(SI_COLLECTIBLE_NAME_FORMATTER, categoryName)
        local entryData = ZO_GamepadEntryData:New(categoryName, gamepadIcon)
        entryData.data = {
            categoryIndex = categoryIndex,
            categoryName = categoryName,
            categoryType = categoryIndex,
            numCollectibles = numCollectibles,
            unlockedCollectibles = unlockedCollectibles,
            totalCollectibles = totalCollectibles,
            icon = gamepadIcon,
        }
        entryData:SetIconTintOnSelection(true)
        self.categoryList.list:AddEntry("ZO_GamepadMenuEntryTemplate", entryData)
    end
    self.categoryList.list:Commit()
    KEYBIND_STRIP:UpdateKeybindButtonGroup(self.categoryList.keybind)
end
function ZO_GamepadCollectionsBook:BuildCollectionList(subCategoryIndex, buildSubCategoryTabs)
    self.collectionList.list:Clear()
    self.collectionList.titleText = nil
    local data = self.collectionList.data
    local unlockedData = {}
    local lockedData = {}
    local categoryName, numSubCategories, numCollectibles = GetCollectibleCategoryInfo(data.categoryIndex)
    -- If there are subcategories, but the neutral category doesn't have anything in it, then choose the first subcategory
    if not subCategoryIndex and numCollectibles == 0 and numSubCategories > 0 then
        subCategoryIndex = 1
    end
    local function BuildCollectibleDataEntry(categoryIndex, subCategoryIndex, collectibleIndex)
        local entryData = self:BuildCollectibleData(categoryIndex, subCategoryIndex, collectibleIndex)
        if not entryData.data.isPlaceholder then
            if entryData.data.unlocked then
                table.insert(unlockedData, entryData)
            else
                table.insert(lockedData, entryData)
            end
        end
    end
    -- Looking at a subcategory
    if subCategoryIndex then
        local subCategoryName, subNumCollectibles = GetCollectibleSubCategoryInfo(data.categoryIndex, subCategoryIndex)
        for collectibleIndex = 1, subNumCollectibles do
            BuildCollectibleDataEntry(data.categoryIndex, subCategoryIndex, collectibleIndex)
        end
    else
        -- Add top level collectibles
        for collectibleIndex = 1, numCollectibles do
            BuildCollectibleDataEntry(data.categoryIndex, nil, collectibleIndex)
        end
        -- If there are any subcategories, then this is the general tab
        if numSubCategories == 0 then
            self.collectionList.titleText = data.categoryName
        end
    end
    self:BuildListFromTable(self.collectionList.list, unlockedData, GetString("SI_COLLECTIBLEUNLOCKSTATE", COLLECTIBLE_UNLOCK_STATE_UNLOCKED_OWNED))
    self:BuildListFromTable(self.collectionList.list, lockedData, GetString("SI_COLLECTIBLEUNLOCKSTATE", COLLECTIBLE_UNLOCK_STATE_LOCKED))
    self.collectionList.list:Commit()
    if buildSubCategoryTabs then
        self.tabBarEntries = {}
        local function ShowNewList(subCategoryIndex)
            if self.currentSubCategoryIndex ~= subCategoryIndex then
                self:BuildCollectionList(subCategoryIndex)
                self:HideCurrentList()
                self:ShowList(self.collectionList, true)
            end
        end
        if numSubCategories > 0 then
            -- Do we need a general tab?
            if numCollectibles > 0 then
                local generalTabData = {
                    text = GetString(SI_JOURNAL_PROGRESS_CATEGORY_GENERAL),
                    callback = function()
                        ShowNewList()
                    end,
                }
                table.insert(self.tabBarEntries, generalTabData)
            end
            for i = 1, numSubCategories do
                local subCategoryName = GetCollectibleSubCategoryInfo(data.categoryIndex, i)
                local tabData = {
                    text = subCategoryName,
                    callback = function()
                        ShowNewList(i)
                    end,
                }
                table.insert(self.tabBarEntries, tabData)
            end
        end
    end
    KEYBIND_STRIP:UpdateKeybindButtonGroup(self.collectionList.keybind)
    self:RefreshTooltip(self.collectionList.list:GetTargetData())
    self.currentSubCategoryIndex = subCategoryIndex
    self.updateList = unlockedData
end
function ZO_GamepadCollectionsBook:UpdateCollectionListVisualLayer()
    local list = self.collectionList.list
    for i = 1, list:GetNumItems() do
        local data = list:GetDataForDataIndex(i)
        local visualLayerHidden, highestPriorityVisualLayerThatIsShowing = WouldCollectibleBeHidden(data.collectibleId)
        data.visualLayerHidden = visualLayerHidden
        data.highestPriorityVisualLayerThatIsShowing = highestPriorityVisualLayerThatIsShowing
    end
    self:RefreshTooltip(self.collectionList.list:GetTargetData())
end
function ZO_GamepadCollectionsBook:BuildCollectibleData(categoryIndex, subCategoryIndex, collectibleIndex)
    local collectibleId = GetCollectibleId(categoryIndex, subCategoryIndex, collectibleIndex)
    local name, description, iconFile, lockedIconFile, unlocked, purchasable, active, categoryType, hint, isPlaceholder = GetCollectibleInfo(collectibleId)
    local unlockState = GetCollectibleUnlockStateById(collectibleId)
    iconFile = unlocked and iconFile or lockedIconFile
    local backgroundFile = GetCollectibleGamepadBackgroundImage(collectibleId)
    local useable = IsCollectibleUsable(collectibleId)
    local categoryBlocked = IsCollectibleCategoryBlocked(categoryType)
    local notificationId = self:GetNotificationIdForCollectible(collectibleId)
    local visualLayerHidden, highestPriorityVisualLayerThatIsShowing = WouldCollectibleBeHidden(collectibleId)
    if visualLayerHidden and not active then
        visualLayerHidden = false
    end
    local entryData = ZO_GamepadEntryData:New(name, iconFile)
    entryData.data = {
        collectibleId = collectibleId,
        name = name,
        nickname = GetCollectibleNickname(collectibleId),
        description = description,
        hint = hint,
        iconFile = iconFile,
        backgroundFile = backgroundFile,
        collectibleId = collectibleId,
        categoryType = categoryType,
        unlocked = unlocked,
        unlockState = unlockState,
        purchasable = purchasable,
        useable = useable,
        active = active,
        visualLayerHidden = visualLayerHidden,
        highestPriorityVisualLayerThatIsShowing = highestPriorityVisualLayerThatIsShowing,
        blocked = categoryBlocked,
        isPlaceholder = isPlaceholder,
        notificationId = notificationId,
        hasNameBeenFormatted = false,
    }
    entryData.isEquippedInCurrentCategory = active
    if visualLayerHidden then
        entryData:SetIsHiddenByWardrobe(true)
    end
    entryData:InitializeCollectibleVisualData(entryData.data)
    if categoryBlocked == true then
        entryData:SetIconDesaturation(1)
    else
        entryData:SetIconDesaturation(0)
    end
    local remainingMS, durationMS = GetCollectibleCooldownAndDuration(entryData.data.collectibleId)
    if remainingMS > 0 and durationMS > 0 then
        entryData:SetCooldown(remainingMS, durationMS)
    end
    return entryData
end
function ZO_GamepadCollectionsBook:BuildListFromTable(list, dataTable, header)
    if #dataTable >= 1 then
        for i,entryData in ipairs(dataTable) do
            if i == 1 then
                entryData:SetHeader(header)
                list:AddEntryWithHeader("ZO_GamepadItemEntryTemplate", entryData)
            else
                list:AddEntry("ZO_GamepadItemEntryTemplate", entryData)
            end
        end
    end
end
function ZO_GamepadCollectionsBook:OnSelectionChanged(list, selectedData, oldSelectedData)
    if self.currentList == self.collectionList then
        self:RefreshTooltip(selectedData)
        self.notificationIdToClear = nil
        self.clearNewStatusCallId = nil
        if oldSelectedData and oldSelectedData.data.notificationId then
            if self.clearNewStatusOnSelectionChanged then
                RemoveCollectibleNotification(oldSelectedData.data.notificationId)
                oldSelectedData.data.notificationId = nil
            end
        end
        self.clearNewStatusOnSelectionChanged = false
        if selectedData and selectedData.data.notificationId then
            self.notificationIdToClear = selectedData.data.notificationId
            self.clearNewStatusCallId = zo_callLater(self.trySetClearNewFlagCallback, TIME_NEW_PERSISTS_WHILE_SELECTED_MS)
        end
    end
    if self.currentList then
        KEYBIND_STRIP:UpdateKeybindButtonGroup(self.currentList.keybind)
    end
end
function ZO_GamepadCollectionsBook:TrySetClearNewFlag(callId)
    if self.clearNewStatusCallId == callId then
        self.clearNewStatusOnSelectionChanged = true
    end
end
function ZO_GamepadCollectionsBook:RefreshTooltip(entryData)
    if entryData and entryData.data then
        local categoryData = self.collectionList.data
        local collectibleData = entryData.data
        if collectibleData.categoryType == COLLECTIBLE_CATEGORY_TYPE_DLC then
            local infoPanel = self.infoPanelControl
            infoPanel.backgroundControl:SetTexture(collectibleData.backgroundFile)
            infoPanel.nameControl:SetText(zo_strformat(SI_COLLECTIBLE_NAME_FORMATTER, collectibleData.name))
            infoPanel.descriptionControl:SetText(collectibleData.description)
            infoPanel.unlockStatusControl:SetText(GetString("SI_COLLECTIBLEUNLOCKSTATE", collectibleData.unlockState))
            local questAcceptLabelStringId = collectibleData.active and SI_DLC_BOOK_QUEST_STATUS_ACCEPTED or SI_DLC_BOOK_QUEST_STATUS_NOT_ACCEPTED
            local questName = GetCollectibleQuestPreviewInfo(collectibleData.collectibleId)
            infoPanel.questStatusControl:SetText(zo_strformat(SI_GAMEPAD_DLC_BOOK_QUEST_STATUS_INFO, questName, GetString(questAcceptLabelStringId)))
            
            local showsQuest = not (collectibleData.active or collectibleData.unlockState == COLLECTIBLE_UNLOCK_STATE_LOCKED)
            local questAcceptIndicator = infoPanel.questAcceptIndicator
            local questAcceptDescription = infoPanel.questAcceptDescription
            if showsQuest then
                questAcceptIndicator:SetText(GetString(SI_COLLECTIONS_QUEST_AVAILABLE))
                questAcceptIndicator:SetHidden(false)
                
                local questDescription = select(2, GetCollectibleQuestPreviewInfo(collectibleData.collectibleId))
                questAcceptDescription:SetText(questDescription)
                questAcceptDescription:SetHidden(false)
            elseif collectibleData.unlockState == COLLECTIBLE_UNLOCK_STATE_LOCKED then
                questAcceptIndicator:SetText(GetString(SI_COLLECTIONS_QUEST_AVAILABLE_WITH_UNLOCK))
                questAcceptIndicator:SetHidden(false)
                questAcceptDescription:SetHidden(true)
            else
                questAcceptIndicator:SetHidden(true)
                questAcceptDescription:SetHidden(true)
            end
            SCENE_MANAGER:AddFragment(GAMEPAD_NAV_QUADRANT_2_3_BACKGROUND_FRAGMENT)
            SCENE_MANAGER:AddFragment(GAMEPAD_COLLECTIONS_BOOK_INFO_PANEL_FRAGMENT)
        else
            GAMEPAD_TOOLTIPS:ClearTooltip(GAMEPAD_LEFT_TOOLTIP, true)
            GAMEPAD_TOOLTIPS:SetBottomRailHidden(GAMEPAD_LEFT_TOOLTIP, true)
            local categoryName = categoryData.name
            local timeRemainingS = entryData:GetCooldownTimeRemainingMs() / 1000
            local usageBlockReason = collectibleData.blocked and GetCollectibleCategoryBlockReason(collectibleData.categoryType) or nil
            GAMEPAD_TOOLTIPS:LayoutCollectible(GAMEPAD_LEFT_TOOLTIP, categoryName, collectibleData.name, collectibleData.nickname, collectibleData.unlockState, collectibleData.purchasable, collectibleData.description, collectibleData.hint, collectibleData.isPlaceholder, collectibleData.highestPriorityVisualLayerThatIsShowing, collectibleData.visualLayerHidden, timeRemainingS, usageBlockReason)
        end
    else
        SCENE_MANAGER:RemoveFragment(GAMEPAD_NAV_QUADRANT_2_3_BACKGROUND_FRAGMENT)
        SCENE_MANAGER:RemoveFragment(GAMEPAD_COLLECTIONS_BOOK_INFO_PANEL_FRAGMENT)
        GAMEPAD_TOOLTIPS:ClearTooltip(GAMEPAD_LEFT_TOOLTIP)
    end
end
function ZO_GamepadCollectionsBook:BrowseToCollectible(collectibleId, categoryIndex, subcategoryIndex)
    self.browseToCollectibleInfo = 
    {
        categoryIndex = categoryIndex,
        collectibleId = collectibleId,
    }
    SCENE_MANAGER:CreateStackFromScratch("mainMenuGamepad", "gamepadCollectionsBook")
end
--[[Global functions]]--
------------------------
function ZO_GamepadCollectionsBook:InitializeActionsDialog()
    local parametricDialog = ZO_GenericGamepadDialog_GetControl(GAMEPAD_DIALOGS.PARAMETRIC)
    ZO_Dialogs_RegisterCustomDialog(GAMEPAD_COLLECTIONS_ACTIONS_DIALOG_NAME,
    {
        gamepadInfo = 
        {
            dialogType = GAMEPAD_DIALOGS.PARAMETRIC,
        },
        canQueue = true,
        setup = function(dialog)
            dialog:setupFunc()
        end,
        title =
        {
            text = SI_GAMEPAD_INVENTORY_ACTION_LIST_KEYBIND,
        },
        parametricList =
        {
            -- Link In Chat
            {
                template = "ZO_GamepadMenuEntryTemplate",
                templateData = {
                    text = GetString(SI_ITEM_ACTION_LINK_TO_CHAT),
                    setup = ZO_SharedGamepadEntry_OnSetup,
                    callback = function(dialog)
                        local link = ZO_LinkHandler_CreateChatLink(GetCollectibleLink, dialog.data.collectibleId)
                        ZO_LinkHandler_InsertLink(zo_strformat(SI_TOOLTIP_ITEM_NAME, link))
                        CHAT_SYSTEM:SubmitTextEntry()
                    end,
                },
            },
            -- Rename
            {
                template = "ZO_GamepadMenuEntryTemplate",
                templateData = {
                    text = GetString(SI_COLLECTIBLE_ACTION_RENAME),
                    setup = ZO_SharedGamepadEntry_OnSetup,
                    callback = function(dialog)
                       ZO_Dialogs_ShowGamepadDialog(GAMEPAD_COLLECTIONS_RENAME_COLLECTIBLE_DIALOG_NAME, { collectibleId = dialog.data.collectibleId, name = dialog.data.name })
                    end,
                    visible = function(dialog)
                        return IsCollectibleRenameable(parametricDialog.data.collectibleId)
                    end
                },
            },
            -- Unlock Permanently (Purchase)
            {
                template = "ZO_GamepadMenuEntryTemplate",
                templateData = {
                    text = GetString(SI_GAMEPAD_DLC_BOOK_ACTION_OPEN_CROWN_STORE),
                    setup = ZO_SharedGamepadEntry_OnSetup,
                    callback = function(dialog)
                        local entryData = self.currentList.list:GetTargetData()
                        local collectibleData = entryData.data
                        local searchTerm = zo_strformat(SI_CROWN_STORE_SEARCH_FORMAT_STRING, collectibleData.name)
                        ShowMarketAndSearch(searchTerm, MARKET_OPEN_OPERATION_COLLECTIONS_DLC)
                    end,
                    visible = function()
                        local entryData = self.currentList.list:GetTargetData()
                        local collectibleData = entryData.data
                        return collectibleData.purchasable and collectibleData.unlockState ~= COLLECTIBLE_UNLOCK_STATE_UNLOCKED_OWNED
                    end
                },
            },
        },
        buttons =
        {
            {
                keybind = "DIALOG_PRIMARY",
                text = SI_OK,
                callback =  function(dialog)
                    local data = dialog.entryList:GetTargetData()
                     data.callback(dialog)
                end,
            },
            {
                keybind = "DIALOG_NEGATIVE",
                text = SI_DIALOG_CANCEL,
            },
        }
    })
end
-------------------
-- Rename Collectible
-------------------
function ZO_GamepadCollectionsBook:InitializeRenameCollectibleDialog()
    local parametricDialog = ZO_GenericGamepadDialog_GetControl(GAMEPAD_DIALOGS.PARAMETRIC)
    local inputText = ""
    local dialogName = GAMEPAD_COLLECTIONS_RENAME_COLLECTIBLE_DIALOG_NAME
    local function ReleaseDialog()
        ZO_Dialogs_ReleaseDialogOnButtonPress(dialogName)
    end
    local function UpdateSelectedName(name)
        if(self.selectedName ~= name or not self.noViolations) then
            self.selectedName = name
            self.nameViolations = { IsValidCollectibleName(self.selectedName) }
            self.noViolations = #self.nameViolations == 0
            
            if(not self.noViolations) then
                local HIDE_UNVIOLATED_RULES = true
                local violationString = ZO_ValidNameInstructions_GetViolationString(self.selectedName, self.nameViolations, HIDE_UNVIOLATED_RULES)
            
                local headerData = 
                {
                    titleText = GetString(SI_INVALID_NAME_DIALOG_TITLE),
                    messageText = violationString,
                    messageTextAlignment = TEXT_ALIGN_LEFT,
                }
                GAMEPAD_TOOLTIPS:ShowGenericHeader(GAMEPAD_LEFT_DIALOG_TOOLTIP, headerData)
                ZO_GenericGamepadDialog_ShowTooltip(parametricDialog)
            else
                ZO_GenericGamepadDialog_HideTooltip(parametricDialog)
            end
        end
        KEYBIND_STRIP:UpdateCurrentKeybindButtonGroups()
    end
    
    local function SetActiveEdit(edit)
        local SAVE_EXISTING_TEXT = true
        edit:TakeFocus()
        UpdateSelectedName(inputText)
    end
    ZO_Dialogs_RegisterCustomDialog(dialogName,
    {
        canQueue = true,
        gamepadInfo = 
        {
            dialogType = GAMEPAD_DIALOGS.PARAMETRIC,
        },
        setup = function(dialog)
            dialog:setupFunc()
        end,
        title =
        {
            text = SI_COLLECTIONS_INVENTORY_DIALOG_RENAME_COLLECTIBLE_TITLE,
        },
        mainText = 
        {
            text = SI_COLLECTIONS_INVENTORY_DIALOG_RENAME_COLLECTIBLE_MAIN,
        },
        parametricList =
        {
            -- user name
            {
                template = "ZO_GamepadTextFieldItem",
                templateData = {
                    nameField = true,
                    textChangedCallback = function(control) 
                        inputText = control:GetText()
                        UpdateSelectedName(inputText)
                    end,
                    setup = function(control, data, selected, reselectingDuringRebuild, enabled, active)
                        control.editBoxControl.textChangedCallback = data.textChangedCallback
                        control.editBoxControl:SetMaxInputChars(COLLECTIBLE_NAME_MAX_LENGTH)
                        data.control = control
                        if parametricDialog.data then
                            control.editBoxControl:SetText(zo_strformat(SI_COLLECTIBLE_NAME_FORMATTER, parametricDialog.data.name))
                        else
                            ZO_EditDefaultText_Initialize(control.editBoxControl, "")
                        end
                    end, 
                },
                
            },
        },
        blockDialogReleaseOnPress = true,
        buttons =
        {
            {
                keybind = "DIALOG_PRIMARY",
                text = SI_GAMEPAD_SELECT_OPTION,
                callback =  function(dialog)
                    local data = dialog.entryList:GetTargetData()
                    SetActiveEdit(data.control.editBoxControl)
                end,
            },
            {
                keybind = "DIALOG_SECONDARY",
                text = SI_GAMEPAD_COLLECTIONS_SAVE_NAME_OPTION,
                callback =  function(dialog)
                                local collectibleId = dialog.data.collectibleId
                                RenameCollectible(collectibleId, inputText)
                                ReleaseDialog()
                end,
                visible = function()
                    return self.noViolations
                end,
                clickSound = SOUNDS.DIALOG_ACCEPT,
            },
            {
                keybind = "DIALOG_NEGATIVE",
                text = SI_DIALOG_CANCEL,
                callback =  function(dialog)
                    ReleaseDialog()
                end,
            },
        }
    })
end
function ZO_GamepadCollectionsBook:HasAnyNotifications(optionalCategoryIndexFilter, optionalSubcategoryIndexFilter)
    return NOTIFICATIONS_PROVIDER:HasAnyNotifications(optionalCategoryIndexFilter, optionalSubcategoryIndexFilter)
end
function ZO_GamepadCollectionsBook:GetNotificationIdForCollectible(collectibleId)
    return NOTIFICATIONS_PROVIDER:GetNotificationIdForCollectible(collectibleId)
end
function ZO_GamepadCollectionsBook:OnUpdateCooldowns()
    for i, entryData in ipairs(self.updateList) do
        local collectibleData = entryData.data
        local _, durationMs = GetCollectibleCooldownAndDuration(collectibleData.collectibleId)
        if durationMs ~= entryData:GetCooldownDurationMs() then
            self:OnCollectibleUpdated(collectibleData.collectibleId)
            return
        end
    end
end
function ZO_GamepadCollectionsBook:UpdateActiveCollectibleCooldownTimer()
    if not self.control:IsHidden() and self.currentList == self.collectionList and self.collectionList then
        local entryData = self.currentList.list:GetTargetData()
        if entryData and entryData:IsOnCooldown() then
            self:RefreshTooltip(entryData)
        end
    end
end
--[[Global functions]]--
------------------------
    GAMEPAD_COLLECTIONS_BOOK = ZO_GamepadCollectionsBook:New(control)
end