Back to Home

ESO Lua File v101038

internalingame/market/market_shared.lua

[◄ back to folders ]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
ZO_MARKET_NAME = "Market"
ZO_MARKET_DISPLAY_LOADING_DELAY_MS = 500
ZO_MARKET_CATEGORY_TYPE_NONE = "none"
ZO_MARKET_CATEGORY_TYPE_FEATURED = "featured"
ZO_MARKET_CATEGORY_TYPE_ESO_PLUS = "esoPlus"
ZO_MARKET_CATEGORY_TYPE_CHAPTER_UPGRADE = "chapterUpgrade"
ZO_MARKET_CATEGORY_TYPE_ESO_PLUS_OFFERS = "esoPlusOffers"
ZO_MARKET_FEATURED_CATEGORY_INDEX = 0
ZO_MARKET_ESO_PLUS_CATEGORY_INDEX = -1
ZO_MARKET_CHAPTER_UPGRADE_CATEGORY_INDEX = -2
ZO_MARKET_ESO_PLUS_OFFERS_CATEGORY_INDEX = -3
ZO_NO_MARKET_SUBCATEGORY = nil
--
--[[ Market Shared ]]--
--
ZO_Market_Shared = ZO_Object:Subclass()
function ZO_Market_Shared:New(...)
    local market = ZO_Object.New(self)
    market:Initialize(...)
    return market
end
function ZO_Market_Shared:Initialize(control, sceneName)
    self.control = control
    self.sceneName = sceneName
    -- Special buckets to contain MarketProducts in lieu of a Category/Subcategory
    self.featuredProducts = {}
    self.limitedTimedOfferProducts = {}
    self.dlcProducts = {}
    self.marketProducts = {} -- An "All" bucket
    self.searchResults = {}
    self.searchString = ""
    self.isSearching = false
    ZO_DIALOG_SYNC_OBJECT:SetHandler("OnShown", function()
        if self:IsShowing() then
            self:OnDialogShowing()
            self:RemoveActionLayerForDialog()
        end
    end, self.sceneName)
    ZO_DIALOG_SYNC_OBJECT:SetHandler("OnHidden", function()
        if self:IsShowing() then
            self:RestoreActionLayerForDialog()
            self:OnDialogHidden()
        end
    end, self.sceneName)
    self.refreshCategories = false
end
function ZO_Market_Shared:RegisterForMarketSingletonCallbacks()
    -- events we need to react to even if we are hiding
    ZO_MARKET_MANAGER:RegisterCallback("OnMarketStateUpdated", function(...) self:OnMarketStateUpdated(...) end)
    ZO_MARKET_MANAGER:RegisterCallback("OnMarketProductAvailabilityUpdated", function(...) self:OnMarketProductAvailabilityUpdated(...) end)
    ZO_MARKET_MANAGER:RegisterCallback("OnMarketSearchResultsReady", function(...) self:OnMarketSearchResultsReady(...) end)
    ZO_MARKET_MANAGER:RegisterCallback("OnMarketSearchResultsCanceled", function(...) self:OnMarketSearchResultsCanceled(...) end)
    -- events we only need to react to if we're showing
    ZO_MARKET_MANAGER:RegisterCallback("OnMarketPurchaseResult", function(...) if self:IsShowing() then self:OnMarketPurchaseResult(...) end end)
    ZO_MARKET_MANAGER:RegisterCallback("OnCollectiblesUnlockStateChanged", function(...) if self:IsShowing() then self:OnCollectiblesUnlockStateChanged(...) end end)
    ZO_MARKET_MANAGER:RegisterCallback("OnEsoPlusSubscriptionStatusChanged", function(...) if self:IsShowing() then self:OnEsoPlusSubscriptionStatusChanged(...) end end)
end
function ZO_Market_Shared:OnInitialInteraction()
    -- ensure that we are in the correct state
    local marketState = GetMarketState(self:GetDisplayGroup())
    if self.marketState ~= marketState then
        self:UpdateMarket(marketState)
    elseif marketState == MARKET_STATE_OPEN then
        self:UpdateCurrentCategory()
    end
end
function ZO_Market_Shared:OnEndInteraction()
    self:ResetSearch()
    OnMarketClose()
end
function ZO_Market_Shared:OnStateChanged(oldState, newState)
    if newState == SCENE_SHOWING then
        self:OnInitialInteraction()
        self:OnShowing()
    elseif newState == SCENE_SHOWN then
        self:OnShown()
    elseif newState == SCENE_HIDING then
        self:OnHiding()
    elseif newState == SCENE_HIDDEN then
        self:OnHidden()
        self:OnEndInteraction()
    end
end
function ZO_Market_Shared:RegisterSceneStateChangeCallback()
    self.marketScene:RegisterCallback("StateChange", function(...) self:OnStateChanged(...) end)
end
function ZO_Market_Shared:IsShowing()
    return self.marketScene:IsShowing()
end
function ZO_Market_Shared:ResetCategoryData()
    self.currentCategoryData = nil
end
function ZO_Market_Shared:OnMarketStateUpdated(displayGroup, marketState)
    if displayGroup == self:GetDisplayGroup() then
        if marketState == MARKET_STATE_LOCKED or marketState == MARKET_STATE_UPDATING then
            self:FlagMarketCategoriesForRefresh()
        end
        if self:IsShowing() then
            self:ResetCategoryData()
            self:UpdateMarket(marketState)
        end
    end
end
function ZO_Market_Shared:OnMarketProductAvailabilityUpdated(displayGroup)
    if displayGroup == self:GetDisplayGroup() then
        if self:IsShowing() then
            self:BuildCategories()
        else
            self:FlagMarketCategoriesForRefresh()
        end
    end
end
function ZO_Market_Shared:OnMarketPurchaseResult()
end
function ZO_Market_Shared:OnMarketSearchResultsReady(taskId)
    self.isSearching = false
    if taskId == self.searchTaskId and self:IsShowing() then
        self:UpdateSearchResults()
        self:UpdateMarket()
    else
        -- someone else performed a search or the search completed after we hid
        self:ClearSearchResults()
        self.refreshCategories = true
    end
end
function ZO_Market_Shared:OnMarketSearchResultsCanceled(taskId)
    if taskId == self.searchTaskId then
        self.isSearching = false
        self:ClearSearchResults()
        if self:IsShowing() then
            self:UpdateMarket()
        else
            self.refreshCategories = true
        end
    end
end
function ZO_Market_Shared:UpdateCurrentCategory()
    if self.currentCategoryData then
        if self.currentCategoryData.categoryIndex == ZO_MARKET_ESO_PLUS_CATEGORY_INDEX then
            self:RefreshEsoPlusPage()
        elseif self.currentCategoryData.type == ZO_MARKET_CATEGORY_TYPE_CHAPTER_UPGRADE then
            self:RefreshChapterUpgradePage()
        else
            self:RefreshProducts()
        end
    end
end
function ZO_Market_Shared:OnCollectiblesUnlockStateChanged()
end
function ZO_Market_Shared:OnShowMarketProduct(marketProductId)
    internalassert(marketProductId ~= 0, "OnShowMarketProduct called with market product id: 0")
    local useCrownStore = IsInGamepadPreferredMode() -- The Crown Store handles requests for all Gamepad products.
    useCrownStore = useCrownStore or
        (DoesAnyMarketProductPresentationMatchFilter(marketProductId, MARKET_PRODUCT_FILTER_TYPE_COST_CROWNS) or
         DoesAnyMarketProductPresentationMatchFilter(marketProductId, MARKET_PRODUCT_FILTER_TYPE_COST_CROWN_GEMS))
    if useCrownStore then
        -- The Crown Store processes requests for both Keyboard Crown and Crown Gem products and all Gamepad products.
        SCENE_MANAGER:Show("show_market")
        self:RequestShowMarketProduct(marketProductId)
    elseif DoesAnyMarketProductPresentationMatchFilter(marketProductId, MARKET_PRODUCT_FILTER_TYPE_COST_ENDEAVOR_SEALS) then
        -- Keyboard Seals of Endeavor Store products.
        SCENE_MANAGER:Show(ENDEAVOR_SEAL_STORE_KEYBOARD.sceneName)
        ENDEAVOR_SEAL_STORE_KEYBOARD:RequestShowMarketProduct(marketProductId)
    else
        -- If we couldn't figure out where to go, just fall back to opening the crown store
        -- This can happen if we haven't fully initialized crown store data, meaning that DoesAnyMarketProductPresentationMatchFilter may not be able to give us the right answer
        -- If the market product is listed for seals of endeavor only, this will fail to navigate to it, but should work in all other cases
        SCENE_MANAGER:Show("show_market")
        self:RequestShowMarketProduct(marketProductId)
    end
end
function ZO_Market_Shared:OnShowMarketAndSearch(marketProductSearchString)
    SCENE_MANAGER:Show("show_market")
    self:RequestShowMarketWithSearchString(marketProductSearchString)
end
function ZO_Market_Shared:OnRequestPurchaseMarketProduct(marketProductId, presentationIndex, isGift)
    local marketProductData = ZO_MarketProductData:New(marketProductId, presentationIndex)
    if isGift then
        self:GiftMarketProduct(marketProductData)
    else
        self:PurchaseMarketProduct(marketProductData)
    end
end
function ZO_Market_Shared:OnShowFeaturedCategory()
    SCENE_MANAGER:Show("show_market")
    self:RequestShowCategory(ZO_MARKET_FEATURED_CATEGORY_INDEX)
end
function ZO_Market_Shared:OnShowEsoPlusPage()
    if IsInGamepadPreferredMode() then
        SCENE_MANAGER:Show("show_market")
    else
        SCENE_MANAGER:Show("show_esoPlus")
    end
    self:RequestShowCategory(ZO_MARKET_ESO_PLUS_CATEGORY_INDEX)
end
function ZO_Market_Shared:OnShowChapterUpgrade(chapterUpgradeId)
    SCENE_MANAGER:Show("show_market")
    self:RequestShowCategory(ZO_MARKET_CHAPTER_UPGRADE_CATEGORY_INDEX, chapterUpgradeId) -- the subcategory id for the chapter is the chapterUpdradeId
end
function ZO_Market_Shared:OnShowMarketProductCategory(marketProductCategoryId)
    SCENE_MANAGER:Show("show_market")
    self:RequestShowCategoryById(marketProductCategoryId)
end
function ZO_Market_Shared:OnEsoPlusSubscriptionStatusChanged()
end
function ZO_Market_Shared:RequestShowMarket(openSource, openBehavior, additionalData)
    SetOpenMarketSource(openSource)
    if openBehavior == OPEN_MARKET_BEHAVIOR_NAVIGATE_TO_PRODUCT or openBehavior == OPEN_MARKET_BEHAVIOR_NAVIGATE_TO_OTHER_PRODUCT then
        self:OnShowMarketProduct(additionalData)
    elseif openBehavior == OPEN_MARKET_BEHAVIOR_SHOW_FEATURED_CATEGORY then
        self:OnShowFeaturedCategory()
    elseif openBehavior == OPEN_MARKET_BEHAVIOR_SHOW_ESO_PLUS_CATEGORY then
        self:OnShowEsoPlusPage()
    elseif openBehavior == OPEN_MARKET_BEHAVIOR_SHOW_CHAPTER_UPGRADE then
        self:OnShowChapterUpgrade(additionalData)
    elseif openBehavior == OPEN_MARKET_BEHAVIOR_SHOW_MARKET_PRODUCT_CATEGORY then
        self:OnShowMarketProductCategory(additionalData)
    end
end
function ZO_Market_Shared:UpdateMarket(marketState)
    self.marketState = marketState or GetMarketState(self:GetDisplayGroup())
    if self.marketState == MARKET_STATE_OPEN then
        self:OnMarketOpen()
    elseif self.marketState == MARKET_STATE_UNKNOWN or self.marketState == MARKET_STATE_UPDATING then
        self:OnMarketLoading()
    else -- MARKET_STATE_LOCKED
        self:OnMarketLocked()
    end
    self:OnMarketUpdate()
end
function ZO_Market_Shared:GetState()
    return self.marketState
end
function ZO_Market_Shared:SetMarketScene(scene)
    self.marketScene = scene
end
function ZO_Market_Shared:EndCurrentPreview()
    self:RefreshActions()
end
function ZO_Market_Shared:IsMarketEmpty()
    return self.isMarketEmpty
end
function ZO_Market_Shared:SetIsMarketEmpty(empty)
    self.isMarketEmpty = empty
end
function ZO_Market_Shared:OnMarketOpen()
    self:SetIsMarketEmpty(false)
    if self:IsMarketEmpty() then
        self:ShowMarket(false)
        self:OnMarketLocked()
    else
        self:ShowMarket(true)
    end
end
function ZO_Market_Shared:OnCategorySelected(data)
    self.currentCategoryData = data
    self:RefreshActions()
end
function ZO_Market_Shared:DisplayCategory(data)
    if data.type == ZO_MARKET_CATEGORY_TYPE_FEATURED then
    elseif data.type == ZO_MARKET_CATEGORY_TYPE_NONE then
        self:BuildMarketProductList(data)
    end
end
function ZO_Market_Shared:FlagMarketCategoriesForRefresh()
    self.refreshCategories = true
end
function ZO_Market_Shared:AddKeybinds()
    KEYBIND_STRIP:AddKeybindButtonGroup(self.keybindStripDescriptors)
end
function ZO_Market_Shared:RemoveKeybinds()
    KEYBIND_STRIP:RemoveKeybindButtonGroup(self.keybindStripDescriptors)
end
function ZO_Market_Shared:RefreshKeybinds()
    KEYBIND_STRIP:UpdateKeybindButtonGroup(self.keybindStripDescriptors)
end
do
    local MARKET_PRODUCT_SORT_KEYS =
        {
            isBundle = { tiebreaker = "name", tieBreakerSortOrder = ZO_SORT_ORDER_UP },
            name = { tiebreaker = "stackCount", tieBreakerSortOrder = ZO_SORT_ORDER_DOWN },
            stackCount = {},
        }
    function ZO_Market_Shared:CompareMarketProducts(entry1, entry2)
        return ZO_TableOrderingFunction(entry1, entry2, "isBundle", MARKET_PRODUCT_SORT_KEYS, ZO_SORT_ORDER_DOWN)
    end
end
do
    local MARKET_PRODUCT_SORT_KEYS =
        {
            tierOrdering = { tiebreaker = "name", tieBreakerSortOrder = ZO_SORT_ORDER_UP },
            name = { tiebreaker = "stackCount", tieBreakerSortOrder = ZO_SORT_ORDER_DOWN },
            stackCount = {},
        }
    function ZO_Market_Shared.CompareCrateMarketProducts(entry1, entry2)
        return ZO_TableOrderingFunction(entry1, entry2, "tierOrdering", MARKET_PRODUCT_SORT_KEYS, ZO_SORT_ORDER_DOWN)
    end
end
do
    local MARKET_PRODUCT_SORT_KEYS =
        {
            isRewardEntry = { tiebreaker = "isBundle", tieBreakerSortOrder = ZO_SORT_ORDER_DOWN },
            isBundle = { tiebreaker = "isValidForPlayer", tieBreakerSortOrder = ZO_SORT_ORDER_DOWN },
            isValidForPlayer = { tiebreaker = "headerName", tieBreakerSortOrder = ZO_SORT_ORDER_UP },
            headerName = { tiebreaker = "name", tieBreakerSortOrder = ZO_SORT_ORDER_UP },
            name = { tiebreaker = "stackCount", tieBreakerSortOrder = ZO_SORT_ORDER_DOWN },
            stackCount = { isNumeric = true },
        }
    function ZO_Market_Shared.CompareBundleMarketProducts(entry1, entry2)
        return ZO_TableOrderingFunction(entry1, entry2, "isRewardEntry", MARKET_PRODUCT_SORT_KEYS, ZO_SORT_ORDER_UP)
    end
end
function ZO_Market_Shared:HasNewFeaturedMarketProducts()
    local REQUIRED_FILTER_TYPES = MARKET_PRODUCT_FILTER_TYPE_FEATURED + MARKET_PRODUCT_FILTER_TYPE_NEW
    return DoesFilteredMarketProductExist(self:GetDisplayGroup(), REQUIRED_FILTER_TYPES, self.featuredMarketProductFiltersMask)
end
function ZO_Market_Shared:DoesFeaturedMarketProductExist()
    return DoesFilteredMarketProductExist(self:GetDisplayGroup(), MARKET_PRODUCT_FILTER_TYPE_FEATURED, self.featuredMarketProductFiltersMask)
end
function ZO_Market_Shared:GetFeaturedProductPresentations()
    local products = {}
    local displayGroup = self:GetDisplayGroup()
    local NO_PRODUCT_ID = nil
    local NO_ALL_FILTER_TYPE = nil
    for productId, presentationIndex in ZO_GetNextFilteredMarketProductIterFunction(displayGroup, MARKET_PRODUCT_FILTER_TYPE_FEATURED, self.featuredMarketProductFiltersMask) do
        local productData = ZO_MarketProductData:New(productId, presentationIndex)
        table.insert(products, productData)
    end
    return products
end
-- filterTypeList is an array of MARKET_PRODUCT_FILTER_TYPE flag combinations
function ZO_Market_Shared:DoesMarketProductMatchAnyFilter(id, presentationIndex, filterTypeList)
    if filterTypeList and #filterTypeList > 0 then
        for _, filterType in ipairs(filterTypeList) do
            if DoesMarketProductMatchFilter(id, presentationIndex, filterType) then
                return true
            end
        end
        return false
    else
        local NO_FILTER = 0
        return DoesMarketProductMatchFilter(id, presentationIndex, NO_FILTER)
    end
end
function ZO_Market_Shared:DoesCategoryContainFilteredProducts(displayGroup, topLevelIndex, categoryIndex, filterTypeList)
    if filterTypeList and #filterTypeList > 0 then
        for _, filterType in ipairs(filterTypeList) do
            if DoesMarketProductCategoryContainFilteredProducts(displayGroup, topLevelIndex, categoryIndex, filterType) then
                return true
            end
        end
        return false
    else
        local NO_FILTER = 0
        return DoesMarketProductCategoryContainFilteredProducts(displayGroup, topLevelIndex, categoryIndex, NO_FILTER)
    end
end
function ZO_Market_Shared:DoesCategoryOrSubcategoriesContainFilteredProducts(displayGroup, topLevelIndex, categoryIndex, filterTypeList)
    if filterTypeList and #filterTypeList > 0 then
        for _, filterType in ipairs(filterTypeList) do
            if DoesMarketProductCategoryOrSubcategoriesContainFilteredProducts(displayGroup, topLevelIndex, categoryIndex, filterType) then
                return true
            end
        end
        return false
    else
        local NO_FILTER = 0
        return DoesMarketProductCategoryOrSubcategoriesContainFilteredProducts(displayGroup, topLevelIndex, categoryIndex, NO_FILTER)
    end
end
do
    local addedMarketProductsMapping = {}
    function ZO_Market_Shared.GetCrownCrateContentsProductInfo(marketProductId)
        ZO_ClearTable(addedMarketProductsMapping)
        local marketProducts = {}
        local crateId = GetMarketProductCrownCrateId(marketProductId)
        local crateTierIds = { GetCrownCrateTierIds(crateId) }
        for tierIndex, tierId in ipairs(crateTierIds) do
            local tierOrdering = GetCrownCrateTierOrdering(tierId)
            local tierDisplayName = GetCrownCrateTierDisplayName(tierId)
            local tierDisplayNameColor = nil
            if tierDisplayName == "" then
                tierDisplayName = nil
            else
                -- color only matters if we have a header to show
                tierDisplayNameColor = ZO_ColorDef:New(GetCrownCrateTierDisplayNameColor(tierId))
            end
            local numProducts = GetNumMarketProductsInCrownCrateTier(tierId)
            for productIndex = 1, numProducts do
                local productId = GetMarketProductIdFromCrownCrateTier(tierId, productIndex)
                if not addedMarketProductsMapping[productId] then
                    local displayQuality = GetMarketProductDisplayQuality(productId)
                    local productInfo =
                        {
                            productId = productId,
                            name = GetMarketProductDisplayName(productId),
                            stackCount = GetMarketProductStackCount(productId),
                            displayQuality = displayQuality,
                            tierId = tierId,
                            tierOrdering = tierOrdering,
                            headerName = tierDisplayName,
                            headerColor = tierDisplayNameColor,
                        }
                    table.insert(marketProducts, productInfo)
                    addedMarketProductsMapping[productId] = true
                end
            end
        end
        return marketProducts
    end
end
function ZO_Market_Shared.GetMarketProductBundleChildProductInfo(marketProductId)
    local marketProducts = {}
    local numChildren = GetMarketProductNumChildren(marketProductId)
    if numChildren == 0 then
        return marketProducts
    end
    for childIndex = 1, numChildren do
        local childMarketProductId = GetMarketProductChildId(marketProductId, childIndex)
        local productType = GetMarketProductType(childMarketProductId)
        local productName = GetMarketProductDisplayName(childMarketProductId)
        local productStackCount = GetMarketProductStackCount(childMarketProductId)
        local productDisplayQuality = GetMarketProductDisplayQuality(childMarketProductId)
        local productRewardListId = GetMarketProductItemRewardListId(childMarketProductId)
        if productRewardListId == 0 then
            local isBundle = false
            local isValidForPlayer = true
            if productType == MARKET_PRODUCT_TYPE_BUNDLE then
                isBundle = true
            elseif productType == MARKET_PRODUCT_TYPE_COLLECTIBLE then
                local collectibleId = GetMarketProductCollectibleId(childMarketProductId)
                isValidForPlayer = IsCollectibleValidForPlayer(collectibleId)
            end
            -- Add a MarketProduct row.
            local productInfo =
            {
                displayQuality = productDisplayQuality,
                headerName = "",
                isBundle = isBundle,
                isRewardEntry = false,
                isValidForPlayer = isValidForPlayer,
                name = productName,
                productId = childMarketProductId,
                stackCount = productStackCount,
            }
            table.insert(marketProducts, productInfo)
        else
            -- GetAllRewardInfoForRewardList returns a table containing new ZO_Reward instances.
            local rewardInfoList = REWARDS_MANAGER:GetAllRewardInfoForRewardList(productRewardListId)
            local headerColor = ZO_ColorDef:New(GetInterfaceColor(INTERFACE_COLOR_TYPE_ITEM_QUALITY_COLORS, productDisplayQuality))
            for _, rewardInfo in ipairs(rewardInfoList) do
                -- Add a RewardInfo row for each reward in this reward container.
                rewardInfo:SetDisplayFlags(REWARD_DISPLAY_FLAGS_FROM_CROWN_STORE_CONTAINER)
                rewardInfo.headerColor = headerColor
                rewardInfo.headerName = productName
                rewardInfo.isBundle = false
                rewardInfo.isRewardEntry = true
                rewardInfo.name = rewardInfo:GetFormattedName()
                rewardInfo.productId = childMarketProductId
                rewardInfo.stackCount = productStackCount
                if rewardInfo:GetRewardType() == REWARD_ENTRY_TYPE_COLLECTIBLE then
                    local collectibleId = GetCollectibleRewardCollectibleId(rewardInfo:GetRewardId())
                    rewardInfo.isValidForPlayer = IsCollectibleValidForPlayer(collectibleId)
                else
                    rewardInfo.isValidForPlayer = true
                end
                table.insert(marketProducts, rewardInfo)
            end
        end
    end
    return marketProducts
end
do
    local SERVICE_TOKEN =
    {
        buttonText = GetString(SI_MARKET_LOG_OUT_TO_CHARACTER_SELECT_KEYBIND_LABEL),
        transactionCompleteText = GetString(SI_MARKET_PURCHASE_SUCCESS_TEXT_WITH_TOKEN_USAGE),
        GoToUseProductLocation = function()
            SCENE_MANAGER:RequestShowLeaderBaseScene()
            Logout()
        end,
    }
    local CROWN_CRATE =
    {
        buttonText = GetString(SI_MARKET_OPEN_CROWN_CRATES_KEYBIND_LABEL),
        transactionCompleteText = GetString(SI_MARKET_PURCHASE_SUCCESS_TEXT_WITH_QUANTITY),
        enabled = function()
            local isAllowed, errorStringId = IsPlayerAllowedToOpenCrownCrates()
            return isAllowed, GetString(errorStringId)
        end,
        GoToUseProductLocation = function()
            if IsInGamepadPreferredMode() then
                SCENE_MANAGER:Show("crownCrateGamepad")
            else
                SCENE_MANAGER:Show("crownCrateKeyboard")
            end
        end,
    }
    local ESO_PLUS =
    {
        transactionCompleteTitleText = GetString(SI_MARKET_PURCHASE_FREE_TRIAL_SUCCESS_TITLE_TEXT),
        transactionCompleteText = GetString(SI_MARKET_PURCHASE_FREE_TRIAL_SUCCESS_TEXT),
        visible = function() return false end,
    }
    function ZO_Market_Shared.GetUseProductInfo(marketProductData)
        if marketProductData:ContainsServiceToken() then
            return SERVICE_TOKEN
        elseif GetCurrentZoneHouseId() ~= 0 and marketProductData:GetFurnitureDataId() ~= 0
            and HasAnyEditingPermissionsForCurrentHouse() and GetHousingEditorMode() ~= HOUSING_EDITOR_MODE_DISABLED then
            local furniturePlacementInfo =
            {
                buttonText = GetString(SI_MARKET_PLACE_IN_HOUSE_KEYBIND_LABEL),
                transactionCompleteText = GetString(SI_MARKET_PURCHASE_SUCCESS_TEXT),
                GoToUseProductLocation = function()
                    if HousingEditorCreateFurnitureForPlacementFromMarketProduct(marketProductData:GetId()) then
                        SCENE_MANAGER:RequestShowLeaderBaseScene()
                    end
                end,
            }
            return furniturePlacementInfo
        else
            local marketProductType = marketProductData:GetMarketProductType()
            if marketProductType == MARKET_PRODUCT_TYPE_CROWN_CRATE then
                return CROWN_CRATE
            elseif marketProductType == MARKET_PRODUCT_TYPE_HOUSING then
                local marketProductHouseId = marketProductData:GetHouseId()
                local houseInfo =
                {
                    buttonText = GetString(SI_MARKET_TRAVEL_TO_HOUSE_KEYBIND_LABEL),
                    transactionCompleteText = GetString(SI_MARKET_PURCHASE_SUCCESS_TEXT),
                    GoToUseProductLocation = function()
                        RequestJumpToHouse(marketProductHouseId)
                        SCENE_MANAGER:RequestShowLeaderBaseScene()
                    end,
                }
                return houseInfo
            elseif marketProductType == MARKET_PRODUCT_TYPE_INSTANT_UNLOCK then
                local instantUnlockType = marketProductData:GetInstantUnlockType()
                if instantUnlockType == INSTANT_UNLOCK_ESO_PLUS then
                    return ESO_PLUS
                end
            end
        end
    end
    function ZO_Market_Shared.HasUseProductInfo(marketProductData)
        return ZO_Market_Shared.GetUseProductInfo(marketProductData) ~= nil
    end
    function ZO_Market_Shared.GoToUseProductLocation(marketProductData)
        local useProductInfo = ZO_Market_Shared.GetUseProductInfo(marketProductData)
        if useProductInfo then
            useProductInfo.GoToUseProductLocation()
        end
    end
end
function ZO_Market_Shared:GetCategoryIndices(data, parentData)
    if parentData then
        return parentData.categoryIndex, data.categoryIndex
    end
    return data.categoryIndex
end
function ZO_Market_Shared:GetPreviewState()
    local isPreviewing = IsCurrentlyPreviewing()
    local canPreview = false
    local isActivePreview = false
    local marketProduct = self.selectedMarketProduct
    if marketProduct ~= nil then -- User is hovering over a MarketProduct
        canPreview = marketProduct:HasPreview() and IsCharacterPreviewingAvailable()
        if isPreviewing and marketProduct:IsActivelyPreviewing() then
            isActivePreview = true
        end
    end
    return isPreviewing, canPreview, isActivePreview
end
function ZO_Market_Shared:IsReadyToPreview()
    local _, canPreview, isActivePreview = self:GetPreviewState()
    return canPreview and not isActivePreview
end
function ZO_Market_Shared:TriggerCrownGemTutorial()
    if self.marketState == MARKET_STATE_OPEN then
        TUTORIAL_MANAGER:ShowTutorial(TUTORIAL_TRIGGER_CROWN_CRATE_UI_OPENED)
    end
end
function ZO_Market_Shared:OnShowing()
    if self.queuedSearchString then
        self:RequestShowMarketWithSearchString(self.queuedSearchString)
    end
end
function ZO_Market_Shared:OnShown()
    if self.marketState == MARKET_STATE_OPEN then
        ZO_MARKET_MANAGER:SetActiveMarket(self)
        if self.marketOpenedTutorialTriggerType then
            TUTORIAL_MANAGER:ShowTutorial(self.marketOpenedTutorialTriggerType)
        else
            TUTORIAL_MANAGER:ShowTutorial(TUTORIAL_TRIGGER_MARKET_OPENED)
        end
    end
end
function ZO_Market_Shared:OnHiding()
    ZO_MARKET_MANAGER:OnActiveMarketHidden(self)
end
function ZO_Market_Shared:OnHidden()
end
function ZO_Market_Shared:ClearLabeledGroups()
    ZO_ClearNumericallyIndexedTable(self.featuredProducts)
    ZO_ClearNumericallyIndexedTable(self.limitedTimedOfferProducts)
    ZO_ClearNumericallyIndexedTable(self.marketProducts)
end
do
    function ZO_Market_Shared:GetCategoryDataForMarketProduct(productId)
        local displayGroup = self:GetDisplayGroup()
        for categoryIndex = 1, GetNumMarketProductCategories(displayGroup) do
            local _, numSubCategories, numMarketProducts = GetMarketProductCategoryInfo(displayGroup, categoryIndex)
            for marketProductIndex = 1, numMarketProducts do
                local id = GetMarketProductPresentationIds(displayGroup, categoryIndex, ZO_NO_MARKET_SUBCATEGORY, marketProductIndex)
                if id == productId then
                    return self:GetCategoryData(categoryIndex, ZO_NO_MARKET_SUBCATEGORY)
                end
            end
            for subcategoryIndex = 1, numSubCategories do
                local _, numSubCategoryMarketProducts = GetMarketProductSubCategoryInfo(displayGroup, categoryIndex, subcategoryIndex)
                for marketProductIndex = 1, numSubCategoryMarketProducts do
                    local id = GetMarketProductPresentationIds(displayGroup, categoryIndex, subcategoryIndex, marketProductIndex)
                    if id == productId then
                        return self:GetCategoryData(categoryIndex, subcategoryIndex)
                    end
                end
            end
        end
    end
end
function ZO_Market_Shared:ShowMarket(show)
    if self.queuedSearchString then
        self:RequestShowMarketWithSearchString(self.queuedSearchString)
    end
end
function ZO_Market_Shared:SetQueuedMarketProductId(marketProductId)
    self.queuedMarketProductId = marketProductId ~= 0 and marketProductId or nil
end
function ZO_Market_Shared:ClearQueuedMarketProductId()
end
function ZO_Market_Shared:GetQueuedMarketProductId()
    return self.queuedMarketProductId
end
function ZO_Market_Shared:GetQueuedCategoryIndices()
    return self.queuedCategoryIndex, self.queuedSubcategoryIndex
end
function ZO_Market_Shared:SetQueuedCategoryIndices(categoryIndex, subcategoryIndex)
    self.queuedCategoryIndex = categoryIndex
    self.queuedSubcategoryIndex = subcategoryIndex
end
function ZO_Market_Shared:ClearQueuedCategoryIndices()
    self:SetQueuedCategoryIndices(nil, nil)
end
function ZO_Market_Shared:SetQueuedCategoryId(categoryId)
    self.queuedCategoryId = categoryId
end
function ZO_Market_Shared:ClearQueuedCategoryId()
end
function ZO_Market_Shared:ProcessQueuedNavigation()
    if self.queuedCategoryId then
        self:RequestShowCategoryById(self.queuedCategoryId)
        self:ClearQueuedCategoryIndices()
    elseif self.queuedCategoryIndex then
        self:RequestShowCategory(self.queuedCategoryIndex, self.queuedSubcategoryIndex)
        -- A request to go to a specific category overrides a request to go to a specific Market Product
        self:ClearQueuedMarketProductId()
    elseif self.queuedMarketProductId then
        self:RequestShowMarketProduct(self.queuedMarketProductId)
    end
end
function ZO_Market_Shared.PreviewMarketProduct(previewObject, marketProductId)
    local previewInEmptyWorld = false
    local furnitureId = GetMarketProductFurnitureDataId(marketProductId)
    if furnitureId ~= 0 then
        local productType = GetMarketProductType(marketProductId)
        previewInEmptyWorld = productType == MARKET_PRODUCT_TYPE_ITEM
    end
    previewObject:SetPreviewInEmptyWorld(previewInEmptyWorld)
    previewObject:PreviewMarketProduct(marketProductId)
end
function ZO_Market_Shared.PreviewReward(previewObject, rewardId)
    local QUANTITY = 1
    local rewardInfo = REWARDS_MANAGER:GetInfoForReward(rewardId, QUANTITY)
    if not rewardInfo then
        return false
    end
    local previewInEmptyWorld = rewardInfo:GetRewardType() == REWARD_TYPE_ITEM
    previewObject:SetPreviewInEmptyWorld(previewInEmptyWorld)
    previewObject:PreviewReward(rewardId)
    return true
end
function ZO_Market_Shared:GetDisplayGroup()
    return self.displayGroup
end
function ZO_Market_Shared:SetDisplayGroup(displayGroup)
    self.displayGroup = displayGroup
end
--[[ Functions to be overridden ]]--
function ZO_Market_Shared:InitializeKeybindDescriptors()
end
function ZO_Market_Shared:InitializeCategories()
end
function ZO_Market_Shared:InitializeMarketList()
end
function ZO_Market_Shared:InitializeFilters()
end
function ZO_Market_Shared:CreateMarketScene()
end
function ZO_Market_Shared:BuildCategories()
end
function ZO_Market_Shared:OnMarketUpdate()
end
function ZO_Market_Shared:OnMarketLoading()
end
function ZO_Market_Shared:OnMarketLocked()
end
function ZO_Market_Shared:RefreshVisibleCategoryFilter()
end
function ZO_Market_Shared:RefreshProducts()
end
function ZO_Market_Shared:OnDialogShowing()
end
function ZO_Market_Shared:OnDialogHidden()
end
function ZO_Market_Shared:GetCategoryData(targetId)
end
function ZO_Market_Shared:RequestShowMarketWithSearchString(searchString)
end
function ZO_Market_Shared:ResetSearch()
end
function ZO_Market_Shared:PurchaseMarketProduct(marketProductData)
end
function ZO_Market_Shared:GiftMarketProduct(marketProductData)
end
function ZO_Market_Shared:BuildFeaturedMarketProductList()
    assert(false) -- must be overridden
end
function ZO_Market_Shared:BuildMarketProductList(data)
    assert(false) -- must be overridden
end
function ZO_Market_Shared:RefreshEsoPlusPage()
end
function ZO_Market_Shared:RefreshChapterUpgradePage()
    -- To be overridden
end
function ZO_Market_Shared:RemoveActionLayerForDialog()
    local actionLayerName = GetString(SI_KEYBINDINGS_LAYER_USER_INTERFACE_SHORTCUTS)
    if IsActionLayerActiveByName(actionLayerName) then
        RemoveActionLayerByName(actionLayerName)
        self.restoreActionLayerWhenDialogHides = true
    end
end
function ZO_Market_Shared:RestoreActionLayerForDialog()
    if self.restoreActionLayerWhenDialogHides then
        PushActionLayerByName(GetString(SI_KEYBINDINGS_LAYER_USER_INTERFACE_SHORTCUTS))
        self.restoreActionLayerWhenDialogHides = nil
    end
end
function ZO_Market_Shared:RefreshActions()
    self:RefreshKeybinds() -- default behavior
end
function ZO_Market_Shared:RequestShowMarketProduct(id)
    assert(false) -- must be overridden
end
function ZO_Market_Shared:RequestShowCategory(categoryIndex, subcategoryIndex)
    assert(false) -- must be overridden
end
function ZO_Market_Shared:RequestShowCategoryById(categoryId)
    assert(false) -- must be overridden
end
--[[Search]]--
--------------
function ZO_Market_Shared:SearchStart(searchString)
    if searchString ~= self.searchString then
        self.searchString = searchString
        self.searchTaskId = StartMarketProductSearch(self:GetDisplayGroup(), searchString)
        self.isSearching = self.searchTaskId ~= nil
        if not self.isSearching then
            -- the search never started (probably because we use too short of a search string)
            self:OnMarketSearchResultsCanceled(self.searchTaskId)
        end
    end
end
function ZO_Market_Shared:HasValidSearchString()
    return zo_strlen(self.searchString) > 1
end
function ZO_Market_Shared:IsSearching()
    return self.isSearching
end
function ZO_Market_Shared:ClearSearchResults()
    ZO_ClearTable(self.searchResults)
end
function ZO_Market_Shared:UpdateSearchResults()
    local searchResults = self.searchResults
    local numResults = GetNumMarketProductSearchResults()
    for resultIndex = 1, numResults do
        local categoryIndex, subcategoryIndex, productIndex = GetMarketProductSearchResult(resultIndex)
        if self:ShouldAddSearchResult(categoryIndex, subcategoryIndex, productIndex) then
            local categoryResults = searchResults[categoryIndex]
            if not categoryResults then
                categoryResults = {}
                searchResults[categoryIndex] = categoryResults
            end
            local effectiveSubcategory = subcategoryIndex or "root"
            local subcategoryResults = categoryResults[effectiveSubcategory]
            if not subcategoryResults then
                subcategoryResults = {}
                categoryResults[effectiveSubcategory] = subcategoryResults
            end
            subcategoryResults[productIndex] = true
        end
    end
end
function ZO_Market_Shared:ShouldAddSearchResult(categoryIndex, subcategoryIndex, productIndex)
    return true
end
function ZO_GetNextFilteredMarketProductIterFunction(displayGroup, matchAllFilterTypes, matchAnyFilterTypes)
    return function(_, lastProductId)
        return GetNextFilteredMarketProduct(lastProductId, displayGroup, matchAllFilterTypes, matchAnyFilterTypes)
    end
end