Back to Home

ESO Lua File v100018

ingame/collections/keyboard/collectionsbook.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
ZO_COLLECTIBLE_PADDING = 10
ZO_COLLECTIBLE_STICKER_SINGLE_WIDTH = 175
ZO_COLLECTIBLE_STICKER_SINGLE_HEIGHT = 125
local COLLECTIBLE_STICKER_ROW_STRIDE = 3
ZO_COLLECTIBLE_STICKER_ROW_WIDTH = (ZO_COLLECTIBLE_STICKER_SINGLE_WIDTH + ZO_COLLECTIBLE_PADDING) * COLLECTIBLE_STICKER_ROW_STRIDE
ZO_COLLECTIBLE_STICKER_ROW_HEIGHT = ZO_COLLECTIBLE_STICKER_SINGLE_HEIGHT + ZO_COLLECTIBLE_PADDING
local RETAIN_SCROLL_POSITION = true
local DONT_RETAIN_SCROLL_POSITION = false
local ACTIVE_ICON = "EsoUI/Art/Inventory/inventory_icon_equipped.dds"
local HIDDEN_ICON = "EsoUI/Art/Inventory/inventory_icon_hiddenBy.dds"
local VISIBLE_ICON = "EsoUI/Art/Inventory/inventory_icon_visible.dds"
local NOTIFICATIONS_PROVIDER = NOTIFICATIONS:GetCollectionsProvider()
local STICKER_ROW_DATA = 1
--Descriptive defaults for readibility in function calls
local FORCE_HIDE_PROGRESS_TEXT = true
local DONT_HIDE_LOCKED = false
local DONT_ANIMATE = true
local function GetTextColor(enabled, normalColor, disabledColor)
    if enabled then
        return (normalColor or ZO_NORMAL_TEXT):UnpackRGBA()
    end
    return (disabledColor or ZO_DISABLED_TEXT):UnpackRGBA()
end
local function ApplyTextColorToLabel(label, ...)
    label:SetColor(GetTextColor(...))
end
local g_currentMouseTarget = nil
--[[Collectible]]--
-------------------
--[[ Initialization ]]--
------------------------
local Collectible = ZO_Object:Subclass()
function Collectible:New(...)
    local collectible = ZO_Object.New(self)
    collectible:Initialize(...)
    return collectible
end
function Collectible:Initialize(collectibleId)
    self.collectibleId = collectibleId
    self.isUsable = false
    self.isCooldownActive = false
    self.cooldownDuration = 0
    self.cooldownStartTime = 0
    if collectibleId then
        local name, description, icon, lockedIcon, unlocked, purchasable, isActive, categoryType = self:GetCollectibleInfo()
        self.name = zo_strformat(SI_COLLECTIBLE_NAME_FORMATTER, name)
        self.unlockedIcon = icon
        self.lockedIcon = lockedIcon
        self.unlocked = unlocked
        self.purchasable = purchasable
        self.active = isActive
        self.categoryType = categoryType
        COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnUpdateCooldowns",
                                                    function(...)
                                                        -- don't try to update the control if we aren't the current collectible it's showing
                                                        if self.control and self.control.collectible == self then
                                                            self:OnUpdateCooldowns(...)
                                                        end
                                                    end)
    end
end
function Collectible:RefreshInfo()
    local unlocked, _, isActive = select(5, self:GetCollectibleInfo())
    self.unlocked = unlocked
    self.active = isActive
    self.isUsable = IsCollectibleUsable(self.collectibleId)
end
function Collectible:Show(control)
    self.control = control
    if self.collectibleId then
        control.collectible = self
        self:RefreshInfo()
        self.maxIconHeight = control.icon:GetHeight()
        control.title:SetText(self.name)
        local effectiveIcon = self.unlocked and self.unlockedIcon or self.lockedIcon
        control.icon:SetTexture(effectiveIcon)
        ApplyTextColorToLabel(control.title, self.unlocked, ZO_NORMAL_TEXT, ZO_DISABLED_TEXT)
        control.cooldownIcon:SetTexture(effectiveIcon)
        control.cooldownIconDesaturated:SetTexture(effectiveIcon)
        control.cooldownIconDesaturated:SetDesaturation(1)
        control.cooldownTime:SetText("")
        control.title:SetHidden(false)
        control.icon:SetHidden(false)
        self:RefreshVisualLayer()
        self:SetBlockedState(IsCollectibleBlocked(self.collectibleId))
        if self:IsCurrentMouseTarget() then
            self:ShowKeybinds()
        end
        self:OnUpdateCooldowns()
    else
        control.title:SetHidden(true)
        control.icon:SetHidden(true)
        control.multiIcon:ClearIcons()
        control.cornerTag:SetHidden(true)
        self:EndCooldown()
        control.collectible = nil
    end
    self:RefreshMouseoverVisuals(DONT_ANIMATE)
end
function Collectible:RefreshVisualLayer()
    self:RefreshTooltip()
end
function Collectible:RefreshMultiIcon()
    local control = self.control
    control.multiIcon:ClearIcons()
    if self.active then
        control.multiIcon:AddIcon(ACTIVE_ICON)
        if WouldCollectibleBeHidden(self.collectibleId) then
            control.multiIcon:AddIcon(HIDDEN_ICON)
        end
    end
    self.notificationId = NOTIFICATIONS_PROVIDER:GetNotificationIdForCollectible(self.collectibleId)
    self.isNew = IsCollectibleNew(self.collectibleId)
    if self.isNew then
        control.multiIcon:AddIcon(ZO_KEYBOARD_NEW_ICON)
    end
    control.multiIcon:Show()
end
function Collectible:GetId()
    return self.collectibleId
end
function Collectible:GetCollectibleInfo()
    return GetCollectibleInfo(self.collectibleId)
end
function Collectible:GetControl()
    return self.control
end
function Collectible:SetHighlightHidden(hidden, dontAnimate)
    local control = self.control
    control.highlight:SetHidden(false) -- let alpha take care of the actual hiding
    if not control.highlightAnimation then
        control.highlightAnimation = ANIMATION_MANAGER:CreateTimelineFromVirtual("JournalProgressHighlightAnimation", control.highlight)
    end
    if hidden then
        ApplyTextColorToLabel(control.title, self.unlocked, ZO_NORMAL_TEXT, ZO_DISABLED_TEXT)
        if dontAnimate then
            control.iconAnimation:PlayInstantlyToStart()
            control.highlightAnimation:PlayInstantlyToStart()
        else
            control.iconAnimation:PlayBackward()
            control.highlightAnimation:PlayBackward()
        end
    else
        ApplyTextColorToLabel(control.title, self.unlocked, ZO_HIGHLIGHT_TEXT, ZO_SELECTED_TEXT)
        if dontAnimate then
            control.highlightAnimation:PlayInstantlyToEnd()
            if self.isCooldownActive ~= true then
                control.iconAnimation:PlayInstantlyToEnd()
            end
        else
            control.highlightAnimation:PlayForward()
            if self.isCooldownActive ~= true then
                control.iconAnimation:PlayForward()
            end
        end
    end
end
function Collectible:GetInteractionTextEnum()
    local textEnum
    if self.active then
        if self.categoryType == COLLECTIBLE_CATEGORY_TYPE_VANITY_PET or self.categoryType == COLLECTIBLE_CATEGORY_TYPE_ASSISTANT then
            textEnum = SI_COLLECTIBLE_ACTION_DISMISS
        else
            textEnum = SI_COLLECTIBLE_ACTION_PUT_AWAY
        end
    elseif self.isCooldownActive ~= true and self.isBlocked ~= true then
        if self.categoryType == COLLECTIBLE_CATEGORY_TYPE_MEMENTO then
            textEnum = SI_COLLECTIBLE_ACTION_USE
        else
            textEnum = SI_COLLECTIBLE_ACTION_SET_ACTIVE
        end
    end
    return textEnum
end
function Collectible:ShowCollectibleMenu()
    local collectibleId = self.collectibleId
    if not collectibleId then
        return
    end
    ClearMenu()
    --Use
    if self.isUsable then
        local textEnum = self:GetInteractionTextEnum()
        if textEnum then
            AddMenuItem(GetString(textEnum), function() UseCollectible(collectibleId) end)
        end
    end
        --Link in chat
        local link = GetCollectibleLink(collectibleId, LINK_STYLE_BRACKETS)
        AddMenuItem(GetString(SI_ITEM_ACTION_LINK_TO_CHAT), function() ZO_LinkHandler_InsertLink(zo_strformat(SI_TOOLTIP_ITEM_NAME, link)) end)
    end
    --Rename
    if IsCollectibleRenameable(collectibleId) then
        AddMenuItem(GetString(SI_COLLECTIBLE_ACTION_RENAME), function() ZO_Dialogs_ShowDialog("COLLECTIONS_INVENTORY_RENAME_COLLECTIBLE", { collectibleId = collectibleId }) end)
    end
end
local g_keybindUseCollectible = {
    name = nil,
    keybind = "UI_SHORTCUT_PRIMARY",
    callback = nil,
}
local g_keybindRenameCollectible = {
    name = GetString(SI_COLLECTIBLE_ACTION_RENAME),
    keybind = "UI_SHORTCUT_SECONDARY",
    callback = nil,
}
function Collectible:ShowKeybinds()
    local function UpdateKeybind(keybind)
        if KEYBIND_STRIP:HasKeybindButton(keybind) then
            KEYBIND_STRIP:UpdateKeybindButton(keybind)
        else
            KEYBIND_STRIP:AddKeybindButton(keybind)
        end
    end
    if self.isUsable then
        local textEnum = self:GetInteractionTextEnum()
        if textEnum then
            g_keybindUseCollectible.name = GetString(textEnum)
            g_keybindUseCollectible.callback = function() UseCollectible(self.collectibleId) end
            UpdateKeybind(g_keybindUseCollectible)
        end
    end
    if IsCollectibleRenameable(self.collectibleId) then
        g_keybindRenameCollectible.callback = function() ZO_Dialogs_ShowDialog("COLLECTIONS_INVENTORY_RENAME_COLLECTIBLE", { collectibleId = self.collectibleId }) end
        UpdateKeybind(g_keybindRenameCollectible)
    end
end
function Collectible:HideKeybinds()
    KEYBIND_STRIP:RemoveKeybindButton(g_keybindUseCollectible)
    KEYBIND_STRIP:RemoveKeybindButton(g_keybindRenameCollectible)
end
do
    local SHOW_NICKNAME, SHOW_HINT, SHOW_BLOCK_REASON = true, true, true
    function Collectible:OnMouseEnter()
        if self.collectibleId then
            InitializeTooltip(ItemTooltip, self.control.parent, RIGHT, -5, 0, LEFT)
            ItemTooltip:SetCollectible(self.collectibleId, SHOW_NICKNAME, SHOW_HINT, SHOW_BLOCK_REASON)
            g_currentMouseTarget = self
            self:ShowKeybinds()
            self:RefreshMouseoverVisuals()
        end
    end
    function Collectible:RefreshTooltip()
        if self:IsCurrentMouseTarget() then
            ClearTooltip(ItemTooltip)
            InitializeTooltip(ItemTooltip, self.parentRow, RIGHT, -5, 0, LEFT)
            ItemTooltip:SetCollectible(self.collectibleId, SHOW_NICKNAME, SHOW_HINT, SHOW_BLOCK_REASON)
        end
    end
end
function Collectible:OnMouseExit()
    if self.collectibleId then
        ClearTooltip(ItemTooltip)
        self:HideKeybinds()
        g_currentMouseTarget = nil
        self:RefreshMouseoverVisuals()
        if self.notificationId then
            RemoveCollectibleNotification(self.notificationId)
        end
        if self.isNew then
            ClearCollectibleNewStatus(self.collectibleId)
        end
    end
end
function Collectible:RefreshMouseoverVisuals(dontAnimate)
    local areVisualsHidden = not self:IsCurrentMouseTarget()
    self:SetHighlightHidden(areVisualsHidden, dontAnimate)
    if self.purchasable then
        self.control.cornerTag:SetHidden(areVisualsHidden)
    end
end
function Collectible:IsCurrentMouseTarget()
    return g_currentMouseTarget == self
end
function Collectible:OnClicked(button)
    if(button == MOUSE_BUTTON_INDEX_RIGHT) then
        --TODO: Add open store bridge (if applicable)
        self:ShowCollectibleMenu()
    end
end
function Collectible:OnMouseDoubleClick(button)
    if(button == MOUSE_BUTTON_INDEX_LEFT) then
        if self.collectibleId and self.isUsable then
            UseCollectible(self.collectibleId)
        end
    end
end
function Collectible:OnEffectivelyHidden()
    self:HideKeybinds()
end
function Collectible:OnUpdate()
    if self.isUsable and self.isCooldownActive then
        self:UpdateCooldownEffect()
    end
end
function Collectible:OnUpdateCooldowns()
    if self.isUsable then
        local remaining, duration = GetCollectibleCooldownAndDuration(self.collectibleId)
        if remaining > 0 and duration > 0 then
            self.cooldownDuration = duration
            self.cooldownStartTime = GetFrameTimeMilliseconds() - (duration - remaining)
            self:BeginCooldown()
            return
        end
    end
    self:EndCooldown()
end
function Collectible:BeginCooldown()
    local control = self.control
    self.isCooldownActive = true
    control.cooldownIcon:SetHidden(false)
    control.cooldownIconDesaturated:SetHidden(false)
    control.cooldownTime:SetHidden(false)
    control.cooldownEdge:SetHidden(false)
    self:SetHighlightHidden(true)
    self:HideKeybinds()
end
function Collectible:EndCooldown()
    local control = self.control
    self.isCooldownActive = false
    control.cooldownIcon:SetTextureCoords(0, 1, 0, 1)
    control.cooldownIcon:SetHeight(self.maxIconHeight)
    control.cooldownIcon:SetHidden(true)
    control.cooldownIconDesaturated:SetHidden(true)
    control.cooldownTime:SetHidden(true)
    control.cooldownEdge:SetHidden(true)
    control.cooldownTime:SetText("")
    if self:IsCurrentMouseTarget() then
        self:ShowKeybinds()
        self:SetHighlightHidden(false)
    end
end
function Collectible:UpdateCooldownEffect()
    local duration = self.cooldownDuration
    local cooldown = self.cooldownStartTime + duration - GetFrameTimeMilliseconds()
    local percentCompleted = (1 - (cooldown / duration)) or 1
    local height = zo_ceil(self.maxIconHeight * percentCompleted)
    local textureCoord = 1 - (height / self.maxIconHeight)
    local control = self.control
    control.cooldownIcon:SetHeight(height)
    control.cooldownIcon:SetTextureCoords(0, 1, textureCoord, 1)
    if not self.active then
        local secondsRemaining = cooldown / 1000
        control.cooldownTime:SetText(ZO_FormatTimeAsDecimalWhenBelowThreshold(secondsRemaining))
    else
        control.cooldownTime:SetText("")
    end
end
function Collectible:SetBlockedState(isBlocked)
    local desaturation = isBlocked and 1 or 0
    self.control.icon:SetDesaturation(desaturation)
    self.control.highlight:SetDesaturation(desaturation)
    self.isBlocked = isBlocked
end
--[[ Collection ]]--
--------------------
--[[ Initialization ]]--
------------------------
local CollectionsBook = ZO_Object.MultiSubclass(ZO_JournalProgressBook_Common, ZO_SortFilterList)
function CollectionsBook:New(...)
    return ZO_JournalProgressBook_Common.New(self, ...)
end
do
    local filterData = 
    {
        SI_COLLECTIONS_BOOK_FILTER_SHOW_ALL,
        SI_COLLECTIONS_BOOK_FILTER_SHOW_LOCKED,
        SI_COLLECTIONS_BOOK_FILTER_SHOW_USABLE,
        SI_COLLECTIONS_BOOK_FILTER_SHOW_UNLOCKED,
    }
    function CollectionsBook:Initialize(control)
        ZO_SortFilterList.Initialize(self, control)
        ZO_JournalProgressBook_Common.Initialize(self, control)
        self.searchString = ""
        self.searchResults = {}
        self.blankCollectibleObject = Collectible:New() --Used to blank out tile controls with no collectibleId
        self.collectibleObjectList = {}
        self:InitializeSummary(control)
        self:InitializeFilters(filterData)
        self.control:SetHandler("OnUpdate", function() self.refreshGroups:UpdateRefreshGroups() end)
        local collectionsBookScene = ZO_Scene:New("collectionsBook", SCENE_MANAGER)
        collectionsBookScene:RegisterCallback("StateChange",
            function(oldState, newState)
                if newState == SCENE_SHOWING then
                    ZO_Scroll_ResetToTop(self.list)
                    self:UpdateCollectionVisualLayer()
                end
            end)
        self:UpdateCollection()
        SYSTEMS:RegisterKeyboardObject(ZO_COLLECTIONS_SYSTEM_NAME, self)
    end
end
function CollectionsBook:InitializeControls()
    ZO_JournalProgressBook_Common.InitializeControls(self)
    self.contentSearch = self.contents:GetNamedChild("Search")
    self.scrollbar = self.list:GetNamedChild("ScrollBar")
    self.noMatches = self.contents:GetNamedChild("NoMatchMessage")
end
function CollectionsBook:InitializeEvents()
    ZO_JournalProgressBook_Common.InitializeEvents(self)
    local function UpdateSearchResults()
        ZO_ClearTable(self.searchResults)
        local numResults = GetNumCollectiblesSearchResults()
        for i = 1, numResults do
            local categoryIndex, subcategoryIndex, collectibleIndex = GetCollectiblesSearchResult(i)
            if self:IsStandardCategory(categoryIndex) then
                if not self.searchResults[categoryIndex] then
                    self.searchResults[categoryIndex] = {}
                end
                local effectiveSubCategory = subcategoryIndex or "root"
                if not self.searchResults[categoryIndex][effectiveSubCategory] then
                    self.searchResults[categoryIndex][effectiveSubCategory] = {}
                end
                self.searchResults[categoryIndex][effectiveSubCategory][collectibleIndex] = true
            end
        end
    end
    local function OnSearchResultsReady()
        UpdateSearchResults()
        self:UpdateCollection()
        if NonContiguousCount(self.searchResults) > 0 then
            local data = self.categoryTree:GetSelectedData()
            self:UpdateCategoryLabels(data, DONT_RETAIN_SCROLL_POSITION)
        end
    end
    self.control:RegisterForEvent(EVENT_COLLECTIBLES_SEARCH_RESULTS_READY, OnSearchResultsReady)
    self.control:RegisterForEvent(EVENT_VISUAL_LAYER_CHANGED, function() self:UpdateCollectionVisualLayer() end)
    COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnCollectibleUpdated", function(...) self:OnCollectibleUpdated(...) end)
    COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnCollectionUpdated", function() self:OnCollectionUpdated() end)
    COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnCollectiblesUpdated", function() self:OnCollectionUpdated() end)
    COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnCollectionNotificationRemoved", function(...) self:OnCollectionNotificationRemoved(...) end)
    COLLECTIONS_BOOK_SINGLETON:RegisterCallback("OnCollectibleNewStatusRemoved", function(...) self:OnCollectionNewStatusRemoved(...) end)
    self.refreshGroups = ZO_Refresh:New()
    self.refreshGroups:AddRefreshGroup("FullUpdate",
    {
        RefreshAll = function()
            self:UpdateCollection()
        end,
    })
    self.refreshGroups:AddRefreshGroup("CollectibleUpdated",
    {
        RefreshSingle = function(collectibleId)
            self:UpdateCollectible(collectibleId)
        end,
    })
    -- cache our GetCollectibleIds function so we don't have to make it everytime we check for new collectibles
    self.getCollectiblesFunction = function(...) return self:GetCollectibleIds(...) end
end
function CollectionsBook:InitializeCategoryTemplates()
    self.parentCategoryTemplate = "ZO_CollectibleIconHeader"
    self.childlessCategoryTemplate = "ZO_CollectibleChildlessCategory"
    self.subCategoryTemplate = "ZO_CollectibleSubCategory"
end
function CollectionsBook:InitializeChildIndentAndSpacing()
    self.childIndent = 76 -- Accounting for the extra space of the status icon (adding half of the width of the icon)
    self.childSpacing = 0
end
function CollectionsBook:InitializeStickerGrid(control)
    local function SetupRow(control, data)
        for i = 1, COLLECTIBLE_STICKER_ROW_STRIDE do
            local stickerControl = control:GetNamedChild("Sticker" .. i)
            local id = data[i]
            local collectibleObject
            if id then
                collectibleObject = self.collectibleObjectList[id]
                if not collectibleObject then
                    collectibleObject = Collectible:New(id)
                    self.collectibleObjectList[id] = collectibleObject
                end
            else
                collectibleObject = self.blankCollectibleObject
            end
            collectibleObject:Show(stickerControl)
        end
    end
    ZO_ScrollList_AddDataType(self.list, STICKER_ROW_DATA, "ZO_CollectibleStickerRow", ZO_COLLECTIBLE_STICKER_ROW_HEIGHT, SetupRow)
end
--[[ Summary ]]--
--------------------
function CollectionsBook:HideSummary()
    --Collections doesn't use the content list, so override here so the base doesn't try to show it
    self.summaryInset:SetHidden(true)
end
--[[ Categories ]]--
--------------------
function CollectionsBook:GetNumCategories()
    return GetNumCollectibleCategories()
end
function CollectionsBook:GetCategoryInfo(categoryIndex)
    return GetCollectibleCategoryInfo(categoryIndex)
end
function CollectionsBook:GetCategoryIcons(categoryIndex)
    return GetCollectibleCategoryKeyboardIcons(categoryIndex)
end
function CollectionsBook:GetSubCategoryInfo(categoryIndex, i)
    return GetCollectibleSubCategoryInfo(categoryIndex, i)
end
function CollectionsBook:IsStandardCategory(categoryIndex)
    return GetCollectibleCategorySpecialization(categoryIndex) == COLLECTIBLE_CATEGORY_SPECIALIZATION_NONE
end
--[[ Refresh ]]--
-----------------
function CollectionsBook:BuildCategories()
    --Per a design call, we're (temporarily?) removing progress indicators, so no summary blade
    self.categoryTree:Reset()
    self.nodeLookupData = {}
        
    local function AddCategoryByCategoryIndex(categoryIndex)
        local name, numSubCategories, _, _, _, hidesUnearned = self:GetCategoryInfo(categoryIndex)
        --Some categories are handled by specialized scenes.
        if self:IsStandardCategory(categoryIndex) then
            local normalIcon, pressedIcon, mouseoverIcon = self:GetCategoryIcons(categoryIndex)
            self:AddTopLevelCategory(categoryIndex, zo_strformat(SI_JOURNAL_PROGRESS_CATEGORY, name), numSubCategories, hidesUnearned, normalIcon, pressedIcon, mouseoverIcon)
        end
    end
    if not self:HasValidSearchString() then
        for categoryIndex = 1, self:GetNumCategories() do
            AddCategoryByCategoryIndex(categoryIndex)
        end
    else
        for categoryIndex, data in pairs(self.searchResults) do
            AddCategoryByCategoryIndex(categoryIndex)
        end
    end
    self.categoryTree:Commit()
end
function CollectionsBook:AddTopLevelCategory(categoryIndex, name, numSubCategories, hidesUnearned, normalIcon, pressedIcon, mouseoverIcon)
    local parent
    if not self:HasValidSearchString() then
        parent = ZO_JournalProgressBook_Common.AddTopLevelCategory(self, categoryIndex, name, numSubCategories, hidesUnearned, normalIcon, pressedIcon, mouseoverIcon)
    else
        --Special search layout
        local tree = self.categoryTree
        local lookup = self.nodeLookupData
        local hasChildren = NonContiguousCount(self.searchResults[categoryIndex]) > 1 or self.searchResults[categoryIndex]["root"] == nil
        local nodeTemplate = hasChildren and self.parentCategoryTemplate or self.childlessCategoryTemplate
        parent = self:AddCategory(lookup, tree, nodeTemplate, nil, categoryIndex, name, hidesUnearned, normalIcon, pressedIcon, mouseoverIcon)
        --We only want to add a general subcategory if we have any subcategories and we have any collectibles in the main category
        --Otherwise we'd have an emtpy general category, or only a general subcategory which can just be a childless instead
        if(hasChildren and self.searchResults[categoryIndex]["root"]) then
            local isFakedSubcategory = true
            local isSummary = false
            self:AddCategory(lookup, tree, self.subCategoryTemplate, parent, categoryIndex, GetString(SI_JOURNAL_PROGRESS_CATEGORY_GENERAL), hidesUnearned, normalIcon, pressedIcon, mouseoverIcon, isSummary, isFakedSubcategory)
        end
        
        for subcategoryIndex, data in pairs(self.searchResults[categoryIndex]) do
            if subcategoryIndex ~= "root" then
                local subCategoryName, subCategoryEntries, _, _, hidesUnearned = self:GetSubCategoryInfo(categoryIndex, subcategoryIndex)
                self:AddCategory(lookup, tree, self.subCategoryTemplate, parent, subcategoryIndex, zo_strformat(SI_JOURNAL_PROGRESS_CATEGORY, subCategoryName), nil, normalIcon, pressedIcon, mouseoverIcon)
            end
        end
    end
    return parent
end
function CollectionsBook:UpdateCategoryStatus(categoryNode)
    local categoryData = categoryNode.data
    local categoryControl = categoryNode.control
    
    local categoryIndex
    local subcategoryIndex
    if categoryData.parentData then
        categoryIndex = categoryData.parentData.categoryIndex
        subcategoryIndex = categoryData.isFakedSubcategory and ZO_JOURNAL_PROGRESS_FAKED_SUBCATEGORY_INDEX or categoryData.categoryIndex
        self:UpdateCategoryStatus(categoryData.parentData.node)
    else
        categoryIndex = categoryData.categoryIndex
    end
    
    self:UpdateCategoryStatusIcon(categoryNode)
end
function CollectionsBook:UpdateAllCategoryStatusIcons()
    for _, lookupData in pairs(self.nodeLookupData) do
        local categoryNode = lookupData.node
        if NonContiguousCount(lookupData.subCategories) == 0 then
            self:UpdateCategoryStatusIcon(categoryNode)
        else
            for _, subcategoryNode in pairs(lookupData.subCategories) do
                self:UpdateCategoryStatusIcon(subcategoryNode)
            end
        end
    end
end
function CollectionsBook:UpdateCategoryStatusIcon(categoryNode)
    local categoryData = categoryNode.data
    local categoryControl = categoryNode.control
    local categoryIndex
    local subcategoryIndex
    if categoryData.parentData then
        categoryIndex = categoryData.parentData.categoryIndex
        subcategoryIndex = categoryData.isFakedSubcategory and ZO_JOURNAL_PROGRESS_FAKED_SUBCATEGORY_INDEX or categoryData.categoryIndex
    else
        categoryIndex = categoryData.categoryIndex
    end
    if not categoryControl.statusIcon then
        categoryControl.statusIcon = categoryControl:GetNamedChild("StatusIcon")
    end
    categoryControl.statusIcon:ClearIcons()
    if self:DoesCategoryHaveAnyNewCollectibles(categoryIndex, subcategoryIndex) then
        categoryControl.statusIcon:AddIcon(ZO_KEYBOARD_NEW_ICON)
    end
    local numCollectbles = self:GetCategoryInfoFromData(categoryData, categoryData.parentData)
    if COLLECTIONS_BOOK_SINGLETON.DoesCollectibleListHaveVisibleCollectible(self:GetCollectibleIds(categoryIndex, subcategoryIndex, numCollectbles)) then
        categoryControl.statusIcon:AddIcon(VISIBLE_ICON)
    end
    categoryControl.statusIcon:Show()
end
function CollectionsBook:UpdateAllCategoryStatuses()
    for _, lookupData in pairs(self.nodeLookupData) do
        local categoryNode = lookupData.node
        if NonContiguousCount(lookupData.subCategories) == 0 then
            self:UpdateCategoryStatus(categoryNode)
        else
            for _, subcategoryNode in pairs(lookupData.subCategories) do
                self:UpdateCategoryStatus(subcategoryNode)
            end
        end
    end
end
function CollectionsBook:UpdateCategoryLabels(data, retainScrollPosition)
    ZO_JournalProgressBook_Common.UpdateCategoryLabels(self, data)
    --Per a design call, we're (temporarily?) removing progress indicators, so no category progress
    self.categoryProgress:SetHidden(true)
    self.categoryLabel:SetHidden(true)
    self:BuildContentList(data, retainScrollPosition)
end
function CollectionsBook:GetCollectibleIds(categoryIndex, subCategoryIndex, index, ...)
    if self:IsStandardCategory(categoryIndex) then -- we ignore the categories that have a special tab when viewing the standard collections window
        if index >= 1 then
            if self:HasValidSearchString() then
                local inSearchResults = false
                local categoryResults = self.searchResults[categoryIndex]
                if categoryResults then
                    local effectiveSubcategoryIndex = subCategoryIndex or "root"
                    local subcategoryResults = categoryResults[effectiveSubcategoryIndex]
                    if subcategoryResults and subcategoryResults[index] then
                        inSearchResults = true
                    end
                end
                if not inSearchResults then
                    index = index - 1
                    return self:GetCollectibleIds(categoryIndex, subCategoryIndex, index, ...)
                end
            end
            local id = GetCollectibleId(categoryIndex, subCategoryIndex, index) 
            index = index - 1
            return self:GetCollectibleIds(categoryIndex, subCategoryIndex, index, id, ...)
        end
    end
    return ...
end
function CollectionsBook:BuildContentList(data, retainScrollPosition)
    local parentData = data.parentData
    local categoryIndex, subCategoryIndex = self:GetCategoryIndicesFromData(data)
    local numCollectibles = self:GetCategoryInfoFromData(data, parentData)
    local position = self.scrollbar:GetValue()
    self:LayoutCollection(self:GetCollectibleIds(categoryIndex, subCategoryIndex, numCollectibles))
        
    if retainScrollPosition then
        self.scrollbar:SetValue(position)
        if(g_currentMouseTarget ~= nil) then
            g_currentMouseTarget:OnMouseExit()
        end
        local mouseOverControl = WINDOW_MANAGER:GetMouseOverControl()
        if (mouseOverControl and not mouseOverControl:IsHidden() and mouseOverControl.collectible) then
            mouseOverControl.collectible:OnMouseEnter()
        end
    end
end
do
    local function ShouldAddCollectible(filterType, id)
        local unlocked, _, _, _, _, isPlaceholder = select(5 , GetCollectibleInfo(id))
        if not isPlaceholder then
            if filterType == SI_COLLECTIONS_BOOK_FILTER_SHOW_ALL then
                return true
            end
            if unlocked then
                if filterType == SI_COLLECTIONS_BOOK_FILTER_SHOW_UNLOCKED then
                    return true
                elseif filterType == SI_COLLECTIONS_BOOK_FILTER_SHOW_USABLE then
                    return IsCollectibleValidForPlayer(id)
                else
                    return false
                end
            else
                return filterType == SI_COLLECTIONS_BOOK_FILTER_SHOW_LOCKED
            end
        else
            return false
        end
    end
    function CollectionsBook:LayoutCollection(...)
        ZO_Scroll_ResetToTop(self.list)
        local scrollData = ZO_ScrollList_GetDataList(self.list)
        ZO_ClearNumericallyIndexedTable(scrollData)
        local rowData = {}
        for currentIndex = 1, select("#", ...) do
            local id = select(currentIndex, ...)
            if ShouldAddCollectible(self.categoryFilter.filterType, id) then
                table.insert(rowData, id)
                if #rowData == COLLECTIBLE_STICKER_ROW_STRIDE then
                    table.insert(scrollData, ZO_ScrollList_CreateDataEntry(STICKER_ROW_DATA, rowData))
                    rowData = {}
                end
            end
        end
        if #rowData > 0 then
            table.insert(scrollData, ZO_ScrollList_CreateDataEntry(STICKER_ROW_DATA, rowData))
        end
        --Fill out the rest of the grid
        local minRows = zo_floor(self.list:GetHeight() / (ZO_COLLECTIBLE_STICKER_SINGLE_HEIGHT + ZO_COLLECTIBLE_PADDING))
        for i = #scrollData + 1, minRows do
            table.insert(scrollData, ZO_ScrollList_CreateDataEntry(STICKER_ROW_DATA, {}))
        end
        self:CommitScrollList()
    end
end
function CollectionsBook:OnCollectionUpdated()
end
function CollectionsBook:UpdateCollectionLater()
    self.refreshGroups:RefreshAll("FullUpdate")
end
function CollectionsBook:UpdateCollection()
    local foundNoMatches = self:HasValidSearchString() and NonContiguousCount(self.searchResults) == 0
    self.categoryInset:SetHidden(foundNoMatches)
    self.noMatches:SetHidden(not foundNoMatches)
    self.list:SetHidden(foundNoMatches)
end
function CollectionsBook:OnCollectibleUpdated(collectibleId)
    self.refreshGroups:RefreshSingle("CollectibleUpdated", collectibleId)
    MAIN_MENU_KEYBOARD:RefreshCategoryBar()
    MAIN_MENU_KEYBOARD:UpdateSceneGroupButtons("collectionsSceneGroup")
end
function CollectionsBook:UpdateCollectible(collectibleId)
    local category, subcategory = GetCategoryInfoFromCollectibleId(collectibleId)
    local categoryNode = self:GetLookupNodeByCategory(category, subcategory)
    if categoryNode then
        self:UpdateCategoryStatus(categoryNode)
        local data = self.categoryTree:GetSelectedData()
        if data.node == categoryNode then
            self:UpdateCategoryLabels(data, RETAIN_SCROLL_POSITION)
        end
    end
end
function CollectionsBook:OnCollectibleStatusUpdated(collectibleId)
    self.refreshGroups:RefreshSingle("CollectibleUpdated", collectibleId)
    MAIN_MENU_KEYBOARD:RefreshCategoryBar()
    MAIN_MENU_KEYBOARD:UpdateSceneGroupButtons("collectionsSceneGroup")
end
function CollectionsBook:OnCollectionNotificationRemoved(notificationId, collectibleId)
    self:OnCollectibleStatusUpdated(collectibleId)
end
function CollectionsBook:OnCollectionNewStatusRemoved(collectibleId)
    self:OnCollectibleStatusUpdated(collectibleId)
end
function CollectionsBook:BrowseToCollectible(collectibleId, categoryIndex, subcategoryIndex)
    self.refreshGroups:UpdateRefreshGroups() --In case we need to rebuild the categories before we select a category
    if COLLECTIONS_BOOK_SINGLETON:IsCategoryIndexDLC(categoryIndex) then
        DLC_BOOK_KEYBOARD:BrowseToCollectible(collectibleId)
    elseif COLLECTIONS_BOOK_SINGLETON:IsCategoryIndexHousing(categoryIndex) then
        HOUSING_BOOK_KEYBOARD:BrowseToCollectible(collectibleId)
    else
        --Select the category or subcategory of the collectible
        local categoryNode = self:GetLookupNodeByCategory(categoryIndex, subcategoryIndex)
        if categoryNode then
            self.categoryTree:SelectNode(categoryNode)
        end
        --TODO: Scroll the collectibles list to show the collectible
        MAIN_MENU_KEYBOARD:ToggleSceneGroup("collectionsSceneGroup", "collectionsBook")
    end
end
function CollectionsBook:UpdateCollectionVisualLayer()
    self:RefreshVisible()
end
--[[Search]]--
--------------
function CollectionsBook:SearchStart(searchString)
    self.searchString = searchString
    StartCollectibleSearch(searchString)
end
function CollectionsBook:HasValidSearchString()
    return zo_strlen(self.searchString) > 1
end
function CollectionsBook:HasAnyNotifications(optionalCategoryIndexFilter, optionalSubcategoryIndexFilter)
    return NOTIFICATIONS_PROVIDER:HasAnyNotifications(optionalCategoryIndexFilter, optionalSubcategoryIndexFilter)
end
function CollectionsBook:DoesCategoryHaveAnyNewCollectibles(categoryIndex, subcategoryIndex)
    return COLLECTIONS_BOOK_SINGLETON.DoesCategoryHaveAnyNewCollectibles(categoryIndex, subcategoryIndex, self.getCollectiblesFunction)
end
function CollectionsBook:HasAnyNewCollectibles()
    return COLLECTIONS_BOOK_SINGLETON.HasAnyNewCollectibles()
end
function CollectionsBook:GetNotificationIdForCollectible(collectibleId)
    return NOTIFICATIONS_PROVIDER:GetNotificationIdForCollectible(collectibleId)
end
--[[Global functions]]--
------------------------
    COLLECTIONS_BOOK = CollectionsBook:New(control)
end
    COLLECTIONS_BOOK:SearchStart(editBox:GetText())
end
    COLLECTIONS_BOOK:SearchStart(editBox:GetText())
    editBox:LoseFocus()
end