Back to Home

ESO Lua File v101041

ingame/collections/itemsetcollectionsdata.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
-- Piece --
ZO_ItemSetCollectionPieceData = ZO_InitializingObject:Subclass()
function ZO_ItemSetCollectionPieceData:Initialize(pieceId, itemSetCollectionSlot)
    self.pieceId = pieceId
    self.itemSetCollectionSlot = itemSetCollectionSlot
    self:RefreshItemLink() -- Update it the first time immediately during the load screen
end
function ZO_ItemSetCollectionPieceData:GetId()
    return self.pieceId
end
function ZO_ItemSetCollectionPieceData:GetItemSetCollectionSlot()
    return self.itemSetCollectionSlot
end
function ZO_ItemSetCollectionPieceData:GetSetId()
    return self.itemSetCollectionData:GetId()
end
function ZO_ItemSetCollectionPieceData:SetItemSetCollectionData(itemSetCollectionData)
    self.itemSetCollectionData = itemSetCollectionData
end
function ZO_ItemSetCollectionPieceData:GetItemSetCollectionData()
    return self.itemSetCollectionData
end
function ZO_ItemSetCollectionPieceData:MarkItemLinkDirty()
    self.isItemLinkDirty = true
end
function ZO_ItemSetCollectionPieceData:InternalCreateItemLink()
    return GetItemSetCollectionPieceItemLink(self.pieceId, LINK_STYLE_DEFAULT, ITEM_TRAIT_TYPE_NONE)
end
function ZO_ItemSetCollectionPieceData:RefreshItemLink()
    -- As these are often accessed from entry instance data, make sure that the refreshed info actually gets applied to the source data and not the entry instance data
    -- In order to keep this hefty system more lightweight, let the garbage collector clean up isItemLinkDirty. It shouldn't dirty often, so no reason to keep the memory around
    local itemLink = self:InternalCreateItemLink()
    if self.dataSource then
        self.dataSource.itemLink = itemLink
        self.dataSource.isItemLinkDirty = nil
    else
        self.itemLink = itemLink
        self.isItemLinkDirty = nil
    end
end
function ZO_ItemSetCollectionPieceData:GetItemLink()
    if self.isItemLinkDirty then
        self:RefreshItemLink()
    end
    return self.itemLink
end
function ZO_ItemSetCollectionPieceData:GetRawName()
    return GetItemLinkName(self:GetItemLink())
end
function ZO_ItemSetCollectionPieceData:GetRawColorizedName()
    local colorDef = GetItemQualityColor(self:GetDisplayQuality())
    return colorDef:Colorize(self:GetName())
end
function ZO_ItemSetCollectionPieceData:GetFormattedName()
    return zo_strformat(SI_LINK_FORMAT_ITEM_NAME, self:GetRawName())
end
function ZO_ItemSetCollectionPieceData:GetFormattedColorizedName()
    local colorDef = GetItemQualityColor(self:GetDisplayQuality())
    return colorDef:Colorize(self:GetFormattedName())
end
function ZO_ItemSetCollectionPieceData:GetFunctionalQuality()
end
function ZO_ItemSetCollectionPieceData:GetDisplayQuality()
end
function ZO_ItemSetCollectionPieceData:GetArmorType()
end
function ZO_ItemSetCollectionPieceData:GetEquipmentFilterType()
end
function ZO_ItemSetCollectionPieceData:MatchesEquipmentFilterTypes(equipmentFilterTypes)
    return ZO_IsElementInNumericallyIndexedTable(equipmentFilterTypes, self:GetEquipmentFilterType())
end
function ZO_ItemSetCollectionPieceData:GetIcon()
    return GetItemLinkIcon(self:GetItemLink())
end
function ZO_ItemSetCollectionPieceData:GetTraitType()
end
function ZO_ItemSetCollectionPieceData:GetTraitCategory()
end
function ZO_ItemSetCollectionPieceData:GetTradeskillType()
end
function ZO_ItemSetCollectionPieceData:IsUnlocked()
    -- There's a piece id function, but using the slot, if it's already known, is more effecient
end
function ZO_ItemSetCollectionPieceData:IsLocked()
    return not self:IsUnlocked()
end
function ZO_ItemSetCollectionPieceData:IsNew()
end
function ZO_ItemSetCollectionPieceData:ClearNew(dontBroadcast)
end
function ZO_ItemSetCollectionPieceData:IsSearchResult()
    -- Text search filters on sets, not individual pieces
    return self.itemSetCollectionData:IsSearchResult()
end
-- Reconstruction Piece --
ZO_ItemSetCollectionReconstructionPieceData = ZO_ItemSetCollectionPieceData:Subclass()
function ZO_ItemSetCollectionReconstructionPieceData:Initialize()
    -- Info will be set post initialize
end
function ZO_ItemSetCollectionReconstructionPieceData:Copy(itemSetCollectionPieceData)
    self.pieceId = itemSetCollectionPieceData:GetId()
    self.itemSetCollectionSlot = itemSetCollectionPieceData:GetItemSetCollectionSlot()
    self.itemSetCollectionData = itemSetCollectionPieceData:GetItemSetCollectionData()
    self.overrideTraitType = ITEM_TRAIT_TYPE_NONE
    self.upgradeFunctionalQuality = nil
end
function ZO_ItemSetCollectionReconstructionPieceData:GetOverrideTraitType()
    return self.overrideTraitType
end
function ZO_ItemSetCollectionReconstructionPieceData:SetOverrideTraitType(overrideTraitType)
    if self.overrideTraitType ~= overrideTraitType then
        self.overrideTraitType = overrideTraitType
        self:MarkItemLinkDirty()
    end
end
function ZO_ItemSetCollectionReconstructionPieceData:GetMinimumFunctionalQuality()
    return GetItemLinkFunctionalQuality(GetItemSetCollectionPieceItemLink(self.pieceId, LINK_STYLE_DEFAULT, ITEM_TRAIT_TYPE_NONE))
end
function ZO_ItemSetCollectionReconstructionPieceData:GetUpgradeFunctionalQuality()
    return self.upgradeFunctionalQuality or self:GetFunctionalQuality()
end
function ZO_ItemSetCollectionReconstructionPieceData:SetUpgradeFunctionalQuality(upgradeFunctionalQuality)
    if self.upgradeFunctionalQuality ~= upgradeFunctionalQuality then
        self.upgradeFunctionalQuality = upgradeFunctionalQuality
        self:MarkItemLinkDirty()
    end
end
function ZO_ItemSetCollectionReconstructionPieceData:InternalCreateItemLink()
    return GetItemSetCollectionPieceItemLink(self.pieceId, LINK_STYLE_DEFAULT, self.overrideTraitType, self.upgradeFunctionalQuality)
end
function ZO_ItemSetCollectionReconstructionPieceData:GetCostInfo(overrideFunctionalQuality)
    local itemSetCollectionData = self:GetItemSetCollectionData()
    local currencyOptionTypes = ITEM_SET_COLLECTIONS_DATA_MANAGER:GetReconstructionCurrencyOptionTypes()
    local currencyOptions = {}
    for _, currencyType in ipairs(currencyOptionTypes) do
        local currencyCost = itemSetCollectionData:GetReconstructionCurrencyOptionCost(currencyType)
        local currencyLocation = GetCurrencyPlayerStoredLocation(currencyType)
        table.insert(currencyOptions,
        {
            currencyAvailable = GetCurrencyAmount(currencyType, currencyLocation),
            currencyIcon = ZO_Currency_GetPlatformCurrencyIcon(currencyType),
            currencyLocation = currencyLocation,
            currencyName = GetCurrencyName(currencyType),
            currencyRequired = currencyCost,
            currencyType = currencyType,
        })
    end
    local tradeskillType = self:GetTradeskillType()
    local minimumQuality = self:GetMinimumFunctionalQuality()
    -- Calculate the costs from the default quality through the requested upgrade quality.
    local upgradeQuality = overrideFunctionalQuality or (self:GetUpgradeFunctionalQuality() - 1)
    local materialCosts = {}
    for quality = minimumQuality, upgradeQuality do
        local reagentItemLink = GetSmithingImprovementItemLink(tradeskillType, quality)
        local _, reagentIcon, reagentsAvailable = GetSmithingImprovementItemInfo(tradeskillType, quality)
        local reagentsRequired = GetSmithingGuaranteedImprovementItemAmount(tradeskillType, quality)
        local materialCost =
        {
            fromFunctionalQuality = quality,
            toFunctionalQuality = quality + 1,
            reagentIcon = reagentIcon,
            reagentItemLink = reagentItemLink,
            reagentsRequired = reagentsRequired,
            reagentsAvailable = reagentsAvailable,
        }
        table.insert(materialCosts, materialCost)
    end
    return currencyOptions, materialCosts
end
-- Collection --
ZO_ItemSetCollectionData = ZO_InitializingObject:Subclass()
function ZO_ItemSetCollectionData:Initialize(itemSetId)
    self.itemSetId = itemSetId
    self.pieces = {}
    -- Get Item Set Collection Category information
    local itemSetCollectionCategoryId = GetItemSetCollectionCategoryId(itemSetId)
    if itemSetCollectionCategoryId ~= 0 then
        local itemSetCollectionCategoryData = ITEM_SET_COLLECTIONS_DATA_MANAGER:GetOrCreateItemSetCollectionCategoryData(itemSetCollectionCategoryId)
        self.itemSetCollectionCategoryData = itemSetCollectionCategoryData
        itemSetCollectionCategoryData:AddItemSetCollectionData(self)
    end
    for i = 1, GetNumItemSetCollectionPieces(itemSetId) do
        local pieceId, slot = GetItemSetCollectionPieceInfo(itemSetId, i)
        local itemSetCollectionPieceData = ITEM_SET_COLLECTIONS_DATA_MANAGER:GetOrCreateItemSetCollectionPieceData(pieceId, slot)
        if internalassert(itemSetCollectionPieceData ~= nil) then
            table.insert(self.pieces, itemSetCollectionPieceData)
            itemSetCollectionPieceData:SetItemSetCollectionData(self)
        end
    end
end
function ZO_ItemSetCollectionData:GetId()
    return self.itemSetId
end
function ZO_ItemSetCollectionData:GetRawName()
    return GetItemSetName(self.itemSetId)
end
function ZO_ItemSetCollectionData:GetFormattedName()
    return zo_strformat(SI_ITEM_SET_NAME_FORMATTER, self:GetRawName())
end
function ZO_ItemSetCollectionData:GetSetType()
    return GetItemSetType(self.itemSetId)
end
function ZO_ItemSetCollectionData:GetUnperfectedSetId()
    return GetItemSetUnperfectedSetId(self.itemSetId)
end
function ZO_ItemSetCollectionData:GetUnperfectedSetCollectionData()
    return ITEM_SET_COLLECTIONS_DATA_MANAGER:GetItemSetCollectionData(self:GetUnperfectedSetId())
end
function ZO_ItemSetCollectionData:GetNumPieces()
    return #self.pieces
end
function ZO_ItemSetCollectionData:GetNumUnlockedPieces()
    return GetNumItemSetCollectionSlotsUnlocked(self.itemSetId)
end
function ZO_ItemSetCollectionData:HasAnyUnlockedPieces()
    return self:GetNumUnlockedPieces() > 0
end
function ZO_ItemSetCollectionData:HasAnyNewPieces()
    return ItemSetCollectionHasNewPieces(self.itemSetId)
end
function ZO_ItemSetCollectionData:ClearNew(dontBroadcast)
    local DONT_BROADCAST = true
    for _, itemSetCollectionPieceData in self:PieceIterator() do
        itemSetCollectionPieceData:ClearNew(DONT_BROADCAST)
    end
    if not dontBroadcast then
        ITEM_SET_COLLECTIONS_DATA_MANAGER:OnCollectionNewStatusCleared(self)
    end
end
function ZO_ItemSetCollectionData:GetReconstructionCurrencyOptionCost(currencyType)
    return GetItemReconstructionCurrencyOptionCost(self.itemSetId, currencyType)
end
function ZO_ItemSetCollectionData:GetReconstructionCurrencyOptionInfo(currencyOptionIndex)
    local currencyType = ITEM_SET_COLLECTIONS_DATA_MANAGER:GetReconstructionCurrencyOptionType(currencyOptionIndex)
    return currencyType, self:GetReconstructionCurrencyOptionCost(currencyType)
end
function ZO_ItemSetCollectionData:GetCategoryData()
    return self.itemSetCollectionCategoryData
end
function ZO_ItemSetCollectionData:GetPieceDataBySlot(itemSetCollectionSlot)
    for i, itemSetCollectionPieceData in self:PieceIterator() do
        if CompareId64s(itemSetCollectionPieceData:GetItemSetCollectionSlot(), itemSetCollectionSlot) == 0 then
            return itemSetCollectionPieceData
        end
    end
    return nil
end
function ZO_ItemSetCollectionData:SetSearchResultsVersion(searchResultsVersion)
    self.searchResultsVersion = searchResultsVersion
    self.itemSetCollectionCategoryData:SetSearchResultsVersion(searchResultsVersion)
end
function ZO_ItemSetCollectionData:IsSearchResult()
    if self.searchResultsVersion then
        if self.searchResultsVersion == ITEM_SET_COLLECTIONS_DATA_MANAGER:GetSearchResultsVersion() then
            return true
        else
            -- Old search result, might as well clean it up while we're here
            self.searchResultsVersion = nil
        end
    end
    return false
end
do
    -- if this triggers, need to add set type to this arbitrary sort order
    internalassert(ITEM_SET_TYPE_MAX_VALUE == 5)
    local SET_TYPE_SORT_ORDER =
    {
        [ITEM_SET_TYPE_MONSTER] = 1,
        [ITEM_SET_TYPE_WEAPON] = 2,
        [ITEM_SET_TYPE_DUNGEON] = 3,
        [ITEM_SET_TYPE_WORLD] = 4,
        [ITEM_SET_TYPE_CRAFTED] = 99, -- Technically invalid for item set collections
        [ITEM_SET_TYPE_NONE] = 99, -- Technically invalid for item set collections
    }
    function ZO_ItemSetCollectionData:CompareTo(otherItemSetCollectionData)
        if self:GetId() == otherItemSetCollectionData:GetId() then
            -- table.sort compares an entry to itself, no good answer, just always return false
            return false
        end
        local setTypeSortOrder = SET_TYPE_SORT_ORDER[self:GetSetType()]
        local otherSetTypeSortOrder = SET_TYPE_SORT_ORDER[otherItemSetCollectionData:GetSetType()]
        if setTypeSortOrder ~= otherSetTypeSortOrder then
            return setTypeSortOrder < otherSetTypeSortOrder
        end
        -- Check for perfected versions of sets and group them after their unperfected counterpart
        local unperfectedSetCollectionData = self:GetUnperfectedSetCollectionData()
        local otherUnperfectedSetCollectionData = otherItemSetCollectionData:GetUnperfectedSetCollectionData()
        local isSetPerfected = unperfectedSetCollectionData ~= nil
        local isOtherSetPerfected = otherUnperfectedSetCollectionData ~= nil
        local sortName = isSetPerfected and unperfectedSetCollectionData:GetRawName() or self:GetRawName()
        local otherSortName = isOtherSetPerfected and otherUnperfectedSetCollectionData:GetRawName() or otherItemSetCollectionData:GetRawName()
        if sortName == otherSortName then
            -- Names in theory should only match if one is the perfected version of the other, or when table.sort compares an entry to itself
            if isSetPerfected ~= isOtherSetPerfected then
                -- Unperfected comes first
                return isOtherSetPerfected
            else
                return self:GetId() < otherItemSetCollectionData:GetId()
            end
        else
            return sortName < otherSortName
        end
    end
end
function ZO_ItemSetCollectionData:PieceIterator(filterFunctions)
    return ZO_FilteredNumericallyIndexedTableIterator(self.pieces, filterFunctions)
end
function ZO_ItemSetCollectionData:AnyChildPassesFilters(pieceFilterFunctions)
    for _, pieceData in self:PieceIterator(pieceFilterFunctions) do
        return true
    end
    return false
end
-- Category --
ZO_ItemSetCollectionCategoryData = ZO_InitializingObject:Subclass()
function ZO_ItemSetCollectionCategoryData:Initialize(categoryId)
    self.categoryId = categoryId
    self.collections = {}
    self.subcategories = {}
    -- Get parent category information
    local parentCategoryId = GetItemSetCollectionCategoryParentId(categoryId)
    if parentCategoryId ~= 0 then
        self.parentCategoryData = ITEM_SET_COLLECTIONS_DATA_MANAGER:GetOrCreateItemSetCollectionCategoryData(parentCategoryId)
        self.parentCategoryData:AddSubcategoryData(self)
    end
end
function ZO_ItemSetCollectionCategoryData:AddSubcategoryData(subcategoryData)
    table.insert(self.subcategories, subcategoryData)
end
function ZO_ItemSetCollectionCategoryData:AddItemSetCollectionData(itemSetCollectionData)
    table.insert(self.collections, itemSetCollectionData)
end
function ZO_ItemSetCollectionCategoryData:GetId()
    return self.categoryId
end
function ZO_ItemSetCollectionCategoryData:GetName()
    return GetItemSetCollectionCategoryName(self.categoryId)
end
function ZO_ItemSetCollectionCategoryData:GetFormattedName()
    return zo_strformat(SI_ITEM_SET_CATEGORY_NAME_FORMATTER, self:GetName())
end
function ZO_ItemSetCollectionCategoryData:GetKeyboardIcons()
    return GetItemSetCollectionCategoryKeyboardIcons(self.categoryId)
end
function ZO_ItemSetCollectionCategoryData:GetGamepadIcon()
    return GetItemSetCollectionCategoryGamepadIcon(self.categoryId)
end
function ZO_ItemSetCollectionCategoryData:GetOrder()
    return GetItemSetCollectionCategoryOrder(self.categoryId)
end
function ZO_ItemSetCollectionCategoryData:GetParentCategoryData()
    return self.parentCategoryData
end
function ZO_ItemSetCollectionCategoryData:IsTopLevel()
    return self.parentCategoryData == nil
end
function ZO_ItemSetCollectionCategoryData:IsSubcategory()
    return self.parentCategoryData ~= nil
end
function ZO_ItemSetCollectionCategoryData:GetNumSubcategories()
    return #self.subcategories
end
function ZO_ItemSetCollectionCategoryData:HasSubcategories()
    return #self.subcategories > 0
end
function ZO_ItemSetCollectionCategoryData:GetNumCollections()
    return #self.collections
end
function ZO_ItemSetCollectionCategoryData:HasCollections()
    return #self.collections > 0
end
function ZO_ItemSetCollectionCategoryData:GetNumPieces()
    local numPieces = self.numPieces
    if not numPieces then
        numPieces = 0
        if self:HasSubcategories() then
            for _, subcategoryData in self:SubcategoryIterator() do
                numPieces = numPieces + subcategoryData:GetNumPieces()
            end
        else
            for _, collectionData in self:CollectionIterator() do
                numPieces = numPieces + collectionData:GetNumPieces()
            end
        end
        self.numPieces = numPieces
    end
    return numPieces
end
function ZO_ItemSetCollectionCategoryData:GetNumUnlockedPieces()
    local numUnlockedPieces = self.numUnlockedPieces
    if not numUnlockedPieces then
        numUnlockedPieces = 0
        if self:HasSubcategories() then
            for _, subcategoryData in self:SubcategoryIterator() do
                numUnlockedPieces = numUnlockedPieces + subcategoryData:GetNumUnlockedPieces()
            end
        else
            for _, collectionData in self:CollectionIterator() do
                numUnlockedPieces = numUnlockedPieces + collectionData:GetNumUnlockedPieces()
            end
        end
        self.numUnlockedPieces = numUnlockedPieces
    end
    return numUnlockedPieces
end
-- Minor optimization over calling the two functions independently
function ZO_ItemSetCollectionCategoryData:GetNumUnlockedAndTotalPieces()
    local numPieces = self.numPieces
    local numUnlockedPieces = self.numUnlockedPieces
    if not (numUnlockedPieces or numPieces) then
        numPieces, numUnlockedPieces = 0, 0
        if self:HasSubcategories() then
            for _, subcategoryData in self:SubcategoryIterator() do
                local numUnlockedSubcategoryPieces, numTotalSubcategoryPieces = subcategoryData:GetNumUnlockedAndTotalPieces()
                numUnlockedPieces = numUnlockedPieces + numUnlockedSubcategoryPieces
                numPieces = numPieces + numTotalSubcategoryPieces
            end
        else
            for _, collectionData in self:CollectionIterator() do
                numUnlockedPieces = numUnlockedPieces + collectionData:GetNumUnlockedPieces()
                numPieces = numPieces + collectionData:GetNumPieces()
            end
        end
        self.numUnlockedPieces = numUnlockedPieces
        self.numPieces = numPieces
    elseif not numUnlockedPieces then
        numUnlockedPieces = self:GetNumUnlockedPieces()
    elseif not numPieces then
        numPieces = self:GetNumPieces()
    end
    return numUnlockedPieces, numPieces
end
function ZO_ItemSetCollectionCategoryData:InvalidateCacheData()
    self.numUnlockedPieces = nil
    for _, subcategoryData in self:SubcategoryIterator() do
        subcategoryData:InvalidateCacheData()
    end
end
do
    local COLLECTION_FILTERS = { ZO_ItemSetCollectionData.HasAnyUnlockedPieces }
    function ZO_ItemSetCollectionCategoryData:HasAnyUnlockedPieces()
        if self:HasSubcategories() then
            for _, subcategoryData in self:SubcategoryIterator({ ZO_ItemSetCollectionCategoryData.HasAnyUnlockedPieces }) do
                return true
            end
        else
            for _, collectionData in self:CollectionIterator(COLLECTION_FILTERS) do
                return true
            end
        end
        return false
    end
end
function ZO_ItemSetCollectionCategoryData:HasAnyNewPieces()
    if self:HasSubcategories() then
        for _, subcategoryData in self:SubcategoryIterator({ ZO_ItemSetCollectionCategoryData.HasAnyNewPieces }) do
            return true
        end
    else
        for _, collectionData in self:CollectionIterator({ ZO_ItemSetCollectionData.HasAnyNewPieces }) do
            return true
        end
    end
end
function ZO_ItemSetCollectionCategoryData:ClearNew(dontBroadcast)
    local DONT_BROADCAST = true
    if self:HasSubcategories() then
        for _, subcategoryData in self:SubcategoryIterator() do
            subcategoryData:ClearNew(DONT_BROADCAST)
        end
    else
        for _, collectionData in self:CollectionIterator() do
            collectionData:ClearNew(DONT_BROADCAST)
        end
    end
    if not dontBroadcast then
        ITEM_SET_COLLECTIONS_DATA_MANAGER:OnCollectionCategoryNewStatusCleared(self)
    end
end
function ZO_ItemSetCollectionCategoryData:SetSearchResultsVersion(searchResultsVersion)
    self.searchResultsVersion = searchResultsVersion
    if self.parentCategoryData then
        self.parentCategoryData:SetSearchResultsVersion(searchResultsVersion)
    end
end
function ZO_ItemSetCollectionCategoryData:IsSearchResult()
    if self.searchResultsVersion then
        if self.searchResultsVersion == ITEM_SET_COLLECTIONS_DATA_MANAGER:GetSearchResultsVersion() then
            return true
        else
            -- Old search result, might as well clean it up while we're here
            self.searchResultsVersion = nil
        end
    end
    return false
end
function ZO_ItemSetCollectionCategoryData:Equals(otherItemSetCollectionCategoryData)
    return self:GetId() == otherItemSetCollectionCategoryData:GetId()
end
function ZO_ItemSetCollectionCategoryData:CompareTo(otherItemSetCollectionCategoryData)
    if self:IsInstanceOf(ZO_ItemSetCollectionSummaryCategoryData) then
        return not otherItemSetCollectionCategoryData:IsInstanceOf(ZO_ItemSetCollectionSummaryCategoryData)
    end
    local order = self:GetOrder()
    local otherOrder = otherItemSetCollectionCategoryData:GetOrder()
    return order < otherOrder or (order == otherOrder and self:GetName() < otherItemSetCollectionCategoryData:GetName())
end
function ZO_ItemSetCollectionCategoryData:SortChildren()
end
function ZO_ItemSetCollectionCategoryData:SortSubcategories()
    table.sort(self.subcategories, ZO_ItemSetCollectionCategoryData.CompareTo)
    for _, subcategory in ipairs(self.subcategories) do
        subcategory:SortChildren()
    end
end
function ZO_ItemSetCollectionCategoryData:SortCollections()
    table.sort(self.collections, ZO_ItemSetCollectionData.CompareTo)
end
function ZO_ItemSetCollectionCategoryData:SubcategoryIterator(filterFunctions)
    return ZO_FilteredNumericallyIndexedTableIterator(self.subcategories, filterFunctions)
end
function ZO_ItemSetCollectionCategoryData:CollectionIterator(filterFunctions)
    return ZO_FilteredNumericallyIndexedTableIterator(self.collections, filterFunctions)
end
function ZO_ItemSetCollectionCategoryData:AnyChildPassesFilters(pieceFilterFunctions)
    if self:HasSubcategories() then
        for _, subcategoryData in self:SubcategoryIterator() do
            if subcategoryData:AnyChildPassesFilters(pieceFilterFunctions) then
                return true
            end
        end
    else
        for _, collectionData in self:CollectionIterator() do
            if collectionData:AnyChildPassesFilters(pieceFilterFunctions) then
                return true
            end
        end
    end
    return false
end
-- Summary Category --
ZO_ItemSetCollectionSummaryCategoryData = ZO_ItemSetCollectionCategoryData:Subclass()
function ZO_ItemSetCollectionSummaryCategoryData:AnyChildPassesFilters(pieceFilterFunctions)
    -- Ensure that this top-level category appears in the list despite having no valid children.
    return true
end
function ZO_ItemSetCollectionSummaryCategoryData:GetGamepadIcon()
    return "EsoUI/Art/MenuBar/Gamepad/gp_playerMenu_icon_itemSetCollections.dds"
end
function ZO_ItemSetCollectionSummaryCategoryData:GetKeyboardIcons()
    local UP_ICON = "EsoUI/Art/Collections/collections_tabIcon_itemSets_up.dds"
    local DOWN_ICON = "EsoUI/Art/Collections/collections_tabIcon_itemSets_down.dds"
    local OVER_ICON = "EsoUI/Art/Collections/collections_tabIcon_itemSets_over.dds"
    return UP_ICON, DOWN_ICON, OVER_ICON
end
function ZO_ItemSetCollectionSummaryCategoryData:GetName()
    return GetString(SI_ITEM_SET_CATEGORY_SUMMARY_LABEL)
end
function ZO_ItemSetCollectionSummaryCategoryData:GetNumUnlockedAndTotalPieces()
    local numUnlockedPieces, numPieces = 0, 0
    for _, topLevelCategoryData in ITEM_SET_COLLECTIONS_DATA_MANAGER:TopLevelItemSetCollectionCategoryIterator() do
        local categoryUnlockedPieces, categoryPieces = topLevelCategoryData:GetNumUnlockedAndTotalPieces()
        numUnlockedPieces = numUnlockedPieces + categoryUnlockedPieces
        numPieces = numPieces + categoryPieces
    end
    return numUnlockedPieces, numPieces
end
local SUMMARY_CATEGORY_ID = 0
ITEM_SET_COLLECTIONS_SUMMARY_CATEGORY_DATA = ZO_ItemSetCollectionSummaryCategoryData:New(SUMMARY_CATEGORY_ID)