Back to Home

ESO Lua File v101036

ingame/companion/gamepad/companioncollectionbook_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
-----------------------------
-- Companion Collection Book
-----------------------------
local GAMEPAD_COMPANION_COLLECTIONS_ACTIONS_DIALOG_NAME = "GAMEPAD_COMPANION_COLLECTIONS_ACTIONS_DIALOG"
ZO_CompanionCollectionBook_Gamepad = ZO_Gamepad_ParametricList_Screen:Subclass()
function ZO_CompanionCollectionBook_Gamepad:Initialize(control)
    COMPANION_COLLECTION_BOOK_GAMEPAD_FRAGMENT = ZO_FadeSceneFragment:New(control)
    COMPANION_COLLECTION_BOOK_GAMEPAD_SCENE = ZO_InteractScene:New("companionCollectionBookGamepad", SCENE_MANAGER, ZO_COMPANION_MANAGER:GetInteraction())
    COMPANION_COLLECTION_BOOK_GAMEPAD_SCENE:AddFragment(COMPANION_COLLECTION_BOOK_GAMEPAD_FRAGMENT)
    local ACTIVATE_ON_SHOW = true
    ZO_Gamepad_ParametricList_Screen.Initialize(self, control, ZO_GAMEPAD_HEADER_TABBAR_DONT_CREATE, ACTIVATE_ON_SHOW, COMPANION_COLLECTION_BOOK_GAMEPAD_SCENE)
    self.currentSlotPreviews = {}
    self.trySetClearNewFlagCallback = function(callId)
        self:TrySetClearNewFlag(callId)
    end
    local function OnVisualLayerChanged()
        if COMPANION_COLLECTION_BOOK_GAMEPAD_SCENE:IsShowing() and self:IsViewingCollectionsList() then
            self:UpdateCollectionListVisualLayer()
        end
    end
    self.control:RegisterForEvent(EVENT_VISUAL_LAYER_CHANGED, OnVisualLayerChanged)
    SYSTEMS:RegisterGamepadObject(ZO_COLLECTIONS_SYSTEM_NAME, self)
    local function OnCollectibleUpdated()
        self:OnCollectibleUpdated()
    end
    ZO_COLLECTIBLE_DATA_MANAGER:RegisterCallback("OnCollectibleUpdated", OnCollectibleUpdated)
    ZO_COLLECTIBLE_DATA_MANAGER:RegisterCallback("OnCollectionUpdated", function(...) self:OnCollectionUpdated(...) end)
    ZO_COLLECTIBLE_DATA_MANAGER:RegisterCallback("OnCollectibleNewStatusCleared", function(...) self:OnCollectibleNewStatusCleared(...) end)
    ZO_COLLECTIBLE_DATA_MANAGER:RegisterCallback("OnCollectibleNotificationRemoved", function(...) self:OnCollectibleNotificationRemoved(...) end)
    COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnUpdateCooldowns", function(...) self:OnUpdateCooldowns(...) end)
    EVENT_MANAGER:RegisterForUpdate("ZO_GamepadCompanionCollectionsBook", 250, function() self:UpdateActiveCollectibleCooldownTimer() end)
    self.control:SetHandler("OnUpdate", function()
        -- TODO: For companion previewable
        local isPreviewingAvailable = IsCharacterPreviewingAvailable()
        if self.isPreviewAvailable ~= isPreviewingAvailable then
            self.isPreviewAvailable = isPreviewingAvailable
            KEYBIND_STRIP:UpdateKeybindButtonGroup(self.subcategoryKeybindStripDescriptor)
        end
    end)
end
function ZO_CompanionCollectionBook_Gamepad:InitializeHeader()
    self.headerData =
    {
        titleText = GetString(SI_COMPANION_MENU_COLLECTIONS_TITLE),
    }
end
function ZO_CompanionCollectionBook_Gamepad:InitializeCategoryLists()
    self.isPreviewAvailable = true
    self.categoryList =
    {
        list = self:GetMainList(),
        keybind = self.categoryKeybindStripDescriptor,
        titleText = GetString(SI_MAIN_MENU_COLLECTIONS),
    }
    self.subcategoryList =
    {
        list = self:AddList("SubCategory"),
        keybind = self.subcategoryKeybindStripDescriptor,
        -- The title text will be updated to the name of the collections category
    }
    self.collectionList =
    {
        list = self:AddList("Collection"),
        keybind = self.collectionKeybindStripDescriptor,
        -- The title text will be updated to the name of the collections category/subcategory
    }
    self.updateList = {}
    self.currentList = nil
end
function ZO_CompanionCollectionBook_Gamepad: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)
    local function ClearPreviewList()
        KEYBIND_STRIP:UpdateKeybindButtonGroup(self.subcategoryKeybindStripDescriptor)
    end
    -- Subcategory Keybind
    self.subcategoryKeybindStripDescriptor =
    {
        alignment = KEYBIND_STRIP_ALIGN_LEFT,
        -- Select Subcategory
        {
            name = GetString(SI_GAMEPAD_SELECT_OPTION),
            keybind = "UI_SHORTCUT_PRIMARY",
            callback = function()
                self:ViewSubcategory()
            end,
            visible = function()
                local entryData = self.currentList.list:GetTargetData()
                return entryData ~= nil
            end,
            sound = SOUNDS.GAMEPAD_MENU_FORWARD,
        },
    }
    ZO_Gamepad_AddBackNavigationKeybindDescriptors(self.subcategoryKeybindStripDescriptor, GAME_NAVIGATION_TYPE_BUTTON, function()
        self:ShowList(self.categoryList)
    end)
    -- Collection Keybind
    self.collectionKeybindStripDescriptor =
    {
        alignment = KEYBIND_STRIP_ALIGN_LEFT,
        -- Set Active or Put Away Collectible
        {
            name = function()
                local collectibleData = self:GetCurrentTargetData()
                local nameStringId = collectibleData:GetPrimaryInteractionStringId(GAMEPLAY_ACTOR_CATEGORY_COMPANION)
                return GetString(nameStringId)
            end,
            keybind = "UI_SHORTCUT_PRIMARY",
            callback = function()
                local collectibleData = self:GetCurrentTargetData()
                collectibleData:Use(GAMEPLAY_ACTOR_CATEGORY_COMPANION)
            end,
            sound = SOUNDS.DEFAULT_CLICK,
            visible = function()
                local collectibleData = self:GetCurrentTargetData()
                if collectibleData then
                    if collectibleData:IsInstanceOf(ZO_SetDefaultCollectibleData) then
                        --This is a set default data entry, not a regular ZO_CollectibleData
                        return not collectibleData:IsActive(GAMEPLAY_ACTOR_CATEGORY_COMPANION)
                    else
                        return collectibleData:IsUsable(GAMEPLAY_ACTOR_CATEGORY_COMPANION)
                    end
                else
                    return false
                end
            end,
            enabled = function()
                local collectibleData = self:GetCurrentTargetData()
                if collectibleData:IsInstanceOf(ZO_SetDefaultCollectibleData) then
                    --This is a set default data entry, not a regular ZO_CollectibleData
                    return true
                else
                    local remainingMs = GetCollectibleCooldownAndDuration(collectibleData:GetId())
                    if collectibleData:IsActive(GAMEPLAY_ACTOR_CATEGORY_COMPANION) then
                        return true
                    elseif remainingMs > 0 then
                        return false, GetString(SI_COLLECTIONS_COOLDOWN_ERROR)
                    elseif collectibleData:IsBlocked() then
                        -- TODO: Determine if companion collectible actions can be blocked
                        return false, GetString(SI_COLLECTIONS_BLOCKED_ERROR)
                    else
                        return true
                    end
                end
            end
        },
        -- Actions
        {
            name = GetString(SI_GAMEPAD_INVENTORY_ACTION_LIST_KEYBIND),
            keybind = "UI_SHORTCUT_TERTIARY",
            callback = function()
                local collectibleData = self:GetCurrentTargetCollectibleData()
                local dialogData =
                {
                    collectibleId = collectibleData:GetId(),
                    name = collectibleData:GetNickname(),
                    active = collectibleData:IsActive(GAMEPLAY_ACTOR_CATEGORY_COMPANION),
                }
                ZO_Dialogs_ShowGamepadDialog(GAMEPAD_COMPANION_COLLECTIONS_ACTIONS_DIALOG_NAME, dialogData)
            end,
            visible = function()
                local collectibleData = self:GetCurrentTargetCollectibleData()
                if collectibleData then
                    return IsChatSystemAvailableForCurrentPlatform() or collectibleData:IsRenameable() or self:CanPurchaseCurrentTarget()
                else
                    return false
                end
            end,
        },
    }
    local function OnCollectionListBack()
        if self.subcategoryList.list:IsEmpty() then
            self:ShowList(self.categoryList)
        else
            self:ShowList(self.subcategoryList)
        end
    end
    ZO_Gamepad_AddBackNavigationKeybindDescriptorsWithSound(self.collectionKeybindStripDescriptor, GAME_NAVIGATION_TYPE_BUTTON, OnCollectionListBack)
end
function ZO_CompanionCollectionBook_Gamepad:PerformUpdate()
   self.dirty = false
end
function ZO_CompanionCollectionBook_Gamepad:SetupList(list)
    local function CategoryEntrySetup(control, data, selected, reselectingDuringRebuild, enabled, active)
        ZO_SharedGamepadEntry_OnSetup(control, data, selected, reselectingDuringRebuild, enabled, active)
        if data:HasAnyNewCollectibles() then
            control.icon:ClearIcons()
            if data:IsTopLevelCategory() then
                control.icon:AddIcon(data:GetGamepadIcon())
            end
            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)
        if not data:IsInstanceOf(ZO_SetDefaultCollectibleData) then
            local collectibleData = data.dataSource
            data:SetNew(collectibleData:IsNew())
            data:SetEnabled(not collectibleData:IsBlocked())
            ZO_SetDefaultIconSilhouette(control.icon, collectibleData:IsLocked())
        end
        ZO_SharedGamepadEntry_OnSetup(control, data, selected, reselectingDuringRebuild, enabled, active)
    end
    list:AddDataTemplateWithHeader("ZO_GamepadCompanionCollectible", CollectibleEntrySetup, ZO_GamepadMenuEntryTemplateParametricListFunction, nil, "ZO_GamepadMenuEntryHeaderTemplate")
end
function ZO_CompanionCollectionBook_Gamepad:OnShowing()
    ZO_Gamepad_ParametricList_Screen.OnShowing(self)
    self:ShowList(self.categoryList)
    local browseInfo = self.browseToCollectibleInfo
    if browseInfo ~= nil then
        local collectibleData = ZO_COLLECTIBLE_DATA_MANAGER:GetCollectibleDataById(browseInfo.collectibleId)
        local categoryData = collectibleData:GetCategoryData()
        if categoryData:IsSubcategory() then
            self:ViewSubcategory(categoryData)
        else
            self:ViewCategory(categoryData)
        end
        self:SelectCollectibleEntry(browseInfo.collectibleId)
        self.browseToCollectibleInfo = nil
    end
end
function ZO_CompanionCollectionBook_Gamepad:OnHide()
end
function ZO_CompanionCollectionBook_Gamepad:RefreshHeader()
end
--Opens up the provided category, or the current category if no categoryData is provided
function ZO_CompanionCollectionBook_Gamepad:ViewCategory(categoryData)
    if categoryData then
        for index = 1, self.categoryList.list:GetNumEntries() do
            local entryData = self.categoryList.list:GetEntryData(index)
            if entryData.dataSource == categoryData then
                self.categoryList.list:SetSelectedIndexWithoutAnimation(index)
            end
        end
    end
    categoryData = self.categoryList.list:GetTargetData()
    self:BuildSubcategoryList(categoryData)
    if self.subcategoryList.list:IsEmpty() then
        local RESET_SELECTION_TO_TOP = true
        self:BuildCollectionList(categoryData, RESET_SELECTION_TO_TOP)
        self:ShowList(self.collectionList)
    else
        self:ShowList(self.subcategoryList)
    end
end
function ZO_CompanionCollectionBook_Gamepad:SelectSubCategoryData(subcategoryData)
    for index = 1, self.subcategoryList.list:GetNumEntries() do
        local entryData = self.subcategoryList.list:GetEntryData(index)
        if entryData.dataSource == subcategoryData then
            self.subcategoryList.list:SetSelectedIndexWithoutAnimation(index)
        end
    end
end
--Opens up the provided subcategory, or the current subcategory if no subcategoryData is provided
function ZO_CompanionCollectionBook_Gamepad:ViewSubcategory(subcategoryData)
    if subcategoryData and subcategoryData:IsSubcategory() then
        self:ViewCategory(subcategoryData:GetParentData())
        self:SelectSubCategoryData(subcategoryData)
    end
    subcategoryData = self.subcategoryList.list:GetTargetData()
    local RESET_SELECTION_TO_TOP = true
    self:BuildCollectionList(subcategoryData, RESET_SELECTION_TO_TOP)
    self:ShowList(self.collectionList)
end
function ZO_CompanionCollectionBook_Gamepad:SelectCollectibleEntry(collectibleId)
    if collectibleId then
        local list = self.collectionList.list
        for i = 1, list:GetNumItems() do
            local collectibleData = list:GetDataForDataIndex(i)
            if collectibleData:GetId() == collectibleId then
                list:SetSelectedIndexWithoutAnimation(i)
                break
            end
        end
    end
end
function ZO_CompanionCollectionBook_Gamepad:ShowList(list, dontUpdateTitle)
    if self.currentList == list then
        return
    end
    self.currentList = list
    if list then
        local listObject = list.list
        KEYBIND_STRIP:AddKeybindButtonGroup(self.currentList.keybind)
        self:SetCurrentList(listObject)
        local targetData = listObject:GetTargetData()
        self:RefreshRightPanel(targetData)
        if list == self.subcategoryList then
            self:StartPreviewFromBase()
        else
            ApplyChangesToPreviewCollectionShown()
        end
    end
    if not dontUpdateTitle then
        self.headerData.titleText = list.titleText
        self:RefreshHeader()
    end
    if self:IsViewingCollectionsList() then
        local collectibleData = self:GetCurrentTargetCollectibleData()
        if collectibleData then
            self.notificationIdToClear = collectibleData.notificationId
            if self.notificationIdToClear or collectibleData:IsNew() then
                self.clearNewStatusOnSelectionChanged = true
            end
        end
    else
        self:RefreshHeader()
    end
end
function ZO_CompanionCollectionBook_Gamepad:HideCurrentList()
    if self.currentList == nil then
        return
    end
    if self:IsViewingCollectionsList() then
        if self.notificationIdToClear then
            RemoveCollectibleNotification(self.notificationIdToClear)
        end
        local collectibleData = self:GetCurrentTargetCollectibleData()
        if collectibleData and collectibleData:IsNew() then
            ClearCollectibleNewStatus(collectibleData:GetId())
        end
        self.clearNewStatusOnSelectionChanged = false
        self.notificationIdToClear = nil
        self.clearNewStatusCallId = nil
    end
    KEYBIND_STRIP:RemoveKeybindButtonGroup(self.currentList.keybind)
    self.currentList = nil
end
function ZO_CompanionCollectionBook_Gamepad:OnCollectionUpdated()
    if not self.control:IsHidden() then
        if self.categoryList then
            self:ShowList(self.categoryList)
            self.categoryList.list:SetSelectedIndex(1)
            self:BuildCategoryList()
        end
    end
end
function ZO_CompanionCollectionBook_Gamepad:OnCollectibleUpdated()
    if not self.control:IsHidden() then
        self:BuildCategoryList()
        local currentCategoryData = self.currentCategoryData
        if currentCategoryData then
            if currentCategoryData:IsSubcategory() then
                self:BuildSubcategoryList(currentCategoryData:GetParentData())
                self.currentCategoryData = currentCategoryData -- Rebuilding the subcategory resets the current category to the parent, so we need to set it back
            elseif currentCategoryData:GetNumSubcategories() > 0 then
                self:BuildSubcategoryList(currentCategoryData)
            end
            if self:IsViewingCollectionsList() then
                local DONT_RESET_SELECTION_TO_TOP = false
                self:BuildCollectionList(currentCategoryData, DONT_RESET_SELECTION_TO_TOP)
            end
        end
    end
end
function ZO_CompanionCollectionBook_Gamepad:OnCollectibleStatusUpdated()
    if not self.control:IsHidden() then
        if self:IsViewingCollectionsList() then
            self.currentList.list:RefreshVisible()
        end
        self.categoryList.list:RefreshVisible()
        self.subcategoryList.list:RefreshVisible()
    end
end
function ZO_CompanionCollectionBook_Gamepad:OnCollectibleNotificationRemoved(notificationId, collectibleId)
end
function ZO_CompanionCollectionBook_Gamepad:OnCollectibleNewStatusCleared(collectibleId)
end
function ZO_CompanionCollectionBook_Gamepad:BuildCategoryList()
    self.categoryList.list:Clear()
    -- Add the categories entries
    for categoryIndex, categoryData in ZO_COLLECTIBLE_DATA_MANAGER:CategoryIterator({ ZO_CollectibleCategoryData.IsStandardCategory, ZO_CollectibleCategoryData.HasShownCollectiblesInCollection, ZO_CollectibleCategoryData.HasAnyCompanionUsableCollectibles }) do
        local formattedCategoryName = categoryData:GetFormattedName()
        local gamepadIcon = categoryData:GetGamepadIcon()
        local entryData = ZO_GamepadEntryData:New(formattedCategoryName, gamepadIcon)
        entryData:SetDataSource(categoryData)
        entryData:SetIconTintOnSelection(true)
        self.categoryList.list:AddEntry("ZO_GamepadMenuEntryTemplate", entryData)
    end
    self.categoryList.list:Commit()
    KEYBIND_STRIP:UpdateKeybindButtonGroup(self.categoryList.keybind)
end
function ZO_CompanionCollectionBook_Gamepad:BuildSubcategoryList(categoryData)
    local subcategoryListInfo = self.subcategoryList
    local subcategoryList = subcategoryListInfo.list
    subcategoryList:Clear()
    subcategoryListInfo.titleText = categoryData:GetFormattedName()
    -- Add the categories entries
    for subcategoryIndex, subcategoryData in categoryData:SubcategoryIterator({ ZO_CollectibleCategoryData.HasShownCollectiblesInCollection, ZO_CollectibleCategoryData.HasAnyCompanionUsableCollectibles }) do
        local formattedSubcategoryName = subcategoryData:GetFormattedName()
        
        local entryData = ZO_GamepadEntryData:New(formattedSubcategoryName)
        entryData:SetDataSource(subcategoryData)
        entryData:SetIconTintOnSelection(true)
        subcategoryList:AddEntry("ZO_GamepadMenuEntryTemplate", entryData)
    end
    subcategoryList:Commit()
    KEYBIND_STRIP:UpdateKeybindButtonGroup(subcategoryListInfo.keybind)
    self.currentCategoryData = categoryData
end
function ZO_CompanionCollectionBook_Gamepad:BuildCollectionList(categoryData, resetSelectionToTop)
    local collectionListInfo = self.collectionList
    local collectionList = collectionListInfo.list
    collectionList:Clear()
    collectionListInfo.titleText = nil
    local unlockedData = {}
    local lockedData = {}
    
    for _, collectibleData in categoryData:SortedCollectibleIterator({ ZO_CollectibleData.IsShownInCollection, ZO_CollectibleData.IsCollectibleCategoryCompanionUsable, ZO_CollectibleData.IsCollectibleAvailableToCompanion }) do
        local entryData = self:BuildCollectibleData(collectibleData)
        if collectibleData:IsUnlocked() then
            table.insert(unlockedData, entryData)
        else
            table.insert(lockedData, entryData)
        end
    end
    collectionListInfo.titleText = categoryData:GetFormattedName()
    if #unlockedData > 0 or #lockedData > 0 then
        -- Add defaults
        local collectibleCategoryTypesInCategory = categoryData:GetCollectibleCategoryTypesInCategory()
        for categoryType in pairs(collectibleCategoryTypesInCategory) do
            local setDefaultCollectibleData = ZO_COLLECTIBLE_DATA_MANAGER:GetSetDefaultCollectibleData(categoryType, GAMEPLAY_ACTOR_CATEGORY_COMPANION)
            if setDefaultCollectibleData then
                local defaultEntryData = self:BuildCollectibleCategorySetDefaultData(setDefaultCollectibleData)
                collectionList:AddEntry("ZO_GamepadCompanionCollectible", defaultEntryData)
            end
        end
    end
    self:BuildListFromTable(collectionList, unlockedData, GetString("SI_COLLECTIBLEUNLOCKSTATE", COLLECTIBLE_UNLOCK_STATE_UNLOCKED_OWNED))
    self:BuildListFromTable(collectionList, lockedData, GetString("SI_COLLECTIBLEUNLOCKSTATE", COLLECTIBLE_UNLOCK_STATE_LOCKED))
    collectionList:Commit(resetSelectionToTop)
    KEYBIND_STRIP:UpdateKeybindButtonGroup(collectionListInfo.keybind)
    self.currentCategoryData = categoryData
    self.updateList = unlockedData
end
function ZO_CompanionCollectionBook_Gamepad:UpdateCollectionListVisualLayer()
    local list = self.collectionList.list
    for i = 1, list:GetNumItems() do
        local collectibleData = list:GetDataForDataIndex(i)
        -- ESO-725038: ZO_SetDefaultCollectibleData doesn't implement IsVisualLayerHidden
        -- so if the visual layer updates while a collectibleData of this type is show we don't
        -- want to attempt to show it. Should we run into other instanciations of ZO_SetDefaultCollectibleData
        -- besides "Default Mount" that have a visual layer we should implement the function on that class.
        -- An example of this happening is when werewolf ends while viewing the
        -- companion mount subcategory which has a default collectible entry of "Default Mount"
        if collectibleData:IsInstanceOf(ZO_CollectibleData) then
            collectibleData:SetIsHiddenByWardrobe(collectibleData:IsVisualLayerHidden(GAMEPLAY_ACTOR_CATEGORY_COMPANION))
        end
    end
    self:RefreshRightPanel(self.collectionList.list:GetTargetData())
end
function ZO_CompanionCollectionBook_Gamepad:BuildCollectibleCategorySetDefaultData(setDefaultCollectibleData)
    local entryData = ZO_GamepadEntryData:New(setDefaultCollectibleData:GetName(), setDefaultCollectibleData:GetIcon())
    entryData:SetDataSource(setDefaultCollectibleData)
    entryData.actorCategory = GAMEPLAY_ACTOR_CATEGORY_COMPANION
    entryData.isEquippedInCurrentCategory = setDefaultCollectibleData:IsActive(GAMEPLAY_ACTOR_CATEGORY_COMPANION)
    return entryData
end
function ZO_CompanionCollectionBook_Gamepad:BuildCollectibleData(collectibleData)
    local collectibleId = collectibleData:GetId()
    local entryData = ZO_GamepadEntryData:New(collectibleData:GetFormattedName(), collectibleData:GetIcon())
    entryData:SetDataSource(collectibleData)
    entryData:SetCooldownIcon(collectibleData:GetIcon())
    entryData.actorCategory = GAMEPLAY_ACTOR_CATEGORY_COMPANION
    entryData.isEquippedInCurrentCategory = collectibleData:IsActive(GAMEPLAY_ACTOR_CATEGORY_COMPANION)
    entryData:SetIsHiddenByWardrobe(collectibleData:IsVisualLayerHidden(GAMEPLAY_ACTOR_CATEGORY_COMPANION))
    local remainingMs, durationMs = GetCollectibleCooldownAndDuration(collectibleId)
    if remainingMs > 0 and durationMs > 0 then
        entryData:SetCooldown(remainingMs, durationMs)
        entryData.refreshWhenFinished = true
    end
    return entryData
end
function ZO_CompanionCollectionBook_Gamepad: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_GamepadCompanionCollectible", entryData)
            else
                list:AddEntry("ZO_GamepadCompanionCollectible", entryData)
            end
        end
    end
end
function ZO_CompanionCollectionBook_Gamepad:OnSelectionChanged(list, selectedData, oldSelectedData)
    if list == self.collectionList.list then
        self.notificationIdToClear = nil
        self.clearNewStatusCallId = nil
        if oldSelectedData then
            if self.clearNewStatusOnSelectionChanged then
                if oldSelectedData.notificationId ~= nil then
                    RemoveCollectibleNotification(oldSelectedData.notificationId)
                    oldSelectedData.notificationId = nil
                end
                ClearCollectibleNewStatus(oldSelectedData:GetId())
            end
        end
        self.clearNewStatusOnSelectionChanged = false
        if selectedData then
            self.notificationIdToClear = selectedData.notificationId
            if selectedData:IsNew() or self.notificationIdToClear ~= nil then
                self.clearNewStatusCallId = zo_callLater(self.trySetClearNewFlagCallback, TIME_NEW_PERSISTS_WHILE_SELECTED_MS)
            end
        end
    end
    
    if self.currentList and list == self.currentList.list then
        self:RefreshRightPanel(selectedData)
        KEYBIND_STRIP:UpdateKeybindButtonGroup(self.currentList.keybind)
    end
end
function ZO_CompanionCollectionBook_Gamepad:TrySetClearNewFlag(callId)
    if self.clearNewStatusCallId == callId then
        self.clearNewStatusOnSelectionChanged = true
    end
end
function ZO_CompanionCollectionBook_Gamepad:RefreshRightPanel(entryData)
    if self:IsViewingCollectionsList() then
        if entryData then
            self:RefreshStandardTooltip(entryData)
        else
            GAMEPAD_TOOLTIPS:ClearTooltip(GAMEPAD_LEFT_TOOLTIP)
        end
    else
        GAMEPAD_TOOLTIPS:ClearTooltip(GAMEPAD_LEFT_TOOLTIP)
    end
end
function ZO_CompanionCollectionBook_Gamepad:RefreshStandardTooltip(collectibleData)
    GAMEPAD_TOOLTIPS:ClearTooltip(GAMEPAD_LEFT_TOOLTIP, true)
    if collectibleData:IsInstanceOf(ZO_SetDefaultCollectibleData) then
        GAMEPAD_TOOLTIPS:LayoutSetDefaultCollectibleFromData(GAMEPAD_LEFT_TOOLTIP, collectibleData, GAMEPLAY_ACTOR_CATEGORY_COMPANION)
    else
        local timeRemainingS = collectibleData:GetCooldownTimeRemainingMs() / 1000
        local SHOW_VISUAL_LAYER_INFO = true
        local SHOW_BLOCK_REASON = true
        GAMEPAD_TOOLTIPS:LayoutCollectibleFromData(GAMEPAD_LEFT_TOOLTIP, collectibleData, SHOW_VISUAL_LAYER_INFO, timeRemainingS, SHOW_BLOCK_REASON, GAMEPLAY_ACTOR_CATEGORY_COMPANION)
    end
end
function ZO_CompanionCollectionBook_Gamepad:ClearAllCurrentSlotPreviews()
    ZO_ClearTable(self.currentSlotPreviews)
end
function ZO_CompanionCollectionBook_Gamepad:HasAnyCurrentSlotPreviews()
    return NonContiguousCount(self.currentSlotPreviews) > 0
end
function ZO_CompanionCollectionBook_Gamepad:StartPreviewFromBase()
    ITEM_PREVIEW_GAMEPAD:PreviewUnequipOutfit(GAMEPLAY_ACTOR_CATEGORY_COMPANION)
end
function ZO_CompanionCollectionBook_Gamepad:OnUpdateCooldowns()
    for i, collectibleData in ipairs(self.updateList) do
        local remainingMs = GetCollectibleCooldownAndDuration(collectibleData:GetId())
        if remainingMs ~= collectibleData:GetCooldownTimeRemainingMs() or (remainingMs <= 0 and collectibleData.refreshWhenFinished) then
            self:OnCollectibleUpdated(collectibleData:GetId())
            return
        end
    end
end
function ZO_CompanionCollectionBook_Gamepad:UpdateActiveCollectibleCooldownTimer()
    if not self.control:IsHidden() and self:IsViewingCollectionsList() then
        local collectibleData = self:GetCurrentTargetCollectibleData()
        if collectibleData and collectibleData:IsOnCooldown() then
            self:RefreshRightPanel(collectibleData)
        end
    end
end
function ZO_CompanionCollectionBook_Gamepad:IsViewingCollectionsList()
    return self.currentList == self.collectionList
end
function ZO_CompanionCollectionBook_Gamepad:IsViewingCategoryList()
    return self.currentList == self.categoryList
end
function ZO_CompanionCollectionBook_Gamepad:IsViewingSubcategoryList()
    return self.currentList == self.subcategoryList
end
function ZO_CompanionCollectionBook_Gamepad:GetCurrentTargetData()
    return self.currentList.list:GetTargetData()
end
function ZO_CompanionCollectionBook_Gamepad:GetCurrentTargetCollectibleData()
    local targetData = self:GetCurrentTargetData()
    if targetData and not targetData:IsInstanceOf(ZO_SetDefaultCollectibleData) then
        return targetData
    end
    return nil
end
function ZO_CompanionCollectionBook_Gamepad:CanPurchaseCurrentTarget()
    if self:IsViewingCollectionsList() then
        local collectibleData = self:GetCurrentTargetCollectibleData()
        return collectibleData and collectibleData:IsPurchasable() and not collectibleData:IsOwned() and not collectibleData:IsHouse()
    end
    return false
end
-----------------
-- Actions Dialog
-----------------
function ZO_CompanionCollectionBook_Gamepad:InitializeActionsDialog()
    ZO_Dialogs_RegisterCustomDialog(GAMEPAD_COMPANION_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_InsertLinkAndSubmit(zo_strformat(SI_TOOLTIP_ITEM_NAME, link))
                    end,
                    visible = IsChatSystemAvailableForCurrentPlatform
                },
            },
            -- 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 collectibleData = self:GetCurrentTargetData()
                        local searchTerm = zo_strformat(SI_CROWN_STORE_SEARCH_FORMAT_STRING, collectibleData:GetName())
                        ShowMarketAndSearch(searchTerm, MARKET_OPEN_OPERATION_COLLECTIONS_DLC)
                    end,
                    visible = function()
                        return self:CanPurchaseCurrentTarget()
                    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
-----------------------------
-- Global XML Functions
-----------------------------
    COMPANION_COLLECTION_BOOK_GAMEPAD = ZO_CompanionCollectionBook_Gamepad:New(control)
end