Back to Home

ESO Lua File v100018

ingame/housingeditor/furnituremanager_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
ZO_FURNITURE_NEEDS_CATEGORIZATION_FAKE_CATEGORY = "NEEDS_CATEGORY"
ZO_PLACEABLE_TYPE_ITEM = 1
ZO_PLACEABLE_TYPE_COLLECTIBLE = 2
local FURNITURE_COMMAND_REMOVE = 1
local function GetNextPlacedFurnitureIdIter(state, var1)
    return GetNextPlacedHousingFurnitureId(var1)
end
local function PlaceableFurnitureFilter(itemData)
    return itemData.isPlaceableFurniture
end
ZO_SharedFurnitureManager = ZO_CallbackObject:Subclass()
function ZO_SharedFurnitureManager:New(...)
    local sharedFurnitureManager = ZO_CallbackObject.New(self)
    sharedFurnitureManager:Initialize(...)
    return sharedFurnitureManager
end
function ZO_SharedFurnitureManager:Initialize()
    self.placeableFurniture = 
    {
        [ZO_PLACEABLE_TYPE_COLLECTIBLE] = {},
        [ZO_PLACEABLE_TYPE_ITEM] = {},
    }
    self.placeableFurnitureCategoryTreeData = ZO_FurnitureCategory:New()
    self.inProgressPlaceableFurnitureTextFilterTaskIds = { }
    self.completePlaceableFurnitureTextFilterTaskIds = { }
    self.placeableTextFilter = ""
    self.retrievableFurnitureCategoryTreeData = ZO_FurnitureCategory:New()
    self.retrievableFurniture = {}
    self.retrievableTextFilter = ""
    self.marketProductCategoryTreeData = ZO_FurnitureCategory:New()
    self.marketProducts = {}
    self.marketProductTextFilter = ""
    local function CreateMarketProduct(objectPool)
        return ZO_HousingMarketProduct:New()
    end
    
    local function ResetMarketProduct(housingMarketProduct)
        housingMarketProduct:Reset()
    end
    self.housingMarketProductPool = ZO_ObjectPool:New(CreateMarketProduct, ResetMarketProduct)
end
function ZO_SharedFurnitureManager:RegisterForEvents()
    SHARED_INVENTORY:RegisterCallback("FullInventoryUpdate", function(bagId) self:OnFullInventoryUpdate(bagId) end)
    SHARED_INVENTORY:RegisterCallback("SingleSlotInventoryUpdate", function(...) self:OnSingleSlotInventoryUpdate(...) end)
    COLLECTIONS_INVENTORY_SINGLETON:RegisterCallback("FullCollectionsInventoryUpdate", function() self:OnFullCollectionUpdate() end)
    COLLECTIONS_INVENTORY_SINGLETON:RegisterCallback("SingleCollectionsInventoryUpdate", function(collectibleId) self:OnSingleCollectibleUpdate(collectibleId) end)
    local function ApplyFurnitureCommand(categoryTreeData, furnitureCommand)
        if furnitureCommand.command == FURNITURE_COMMAND_REMOVE then
            self:RemoveFurnitureFromCategory(categoryTreeData, furnitureCommand.target)
        end
    end
    self.refreshGroups = ZO_Refresh:New()
    self.refreshGroups:AddRefreshGroup("UpdatePlacementFurniture",
    {
        RefreshAll = function()
            self.placeableFurnitureCategoryTreeData:Clear()
            local itemFurnitureCache = self:GetPlaceableFurnitureCache(ZO_PLACEABLE_TYPE_ITEM)
            local foundBankInventory = false
            for bagId, bagEntries in pairs(itemFurnitureCache) do
                self:BuildCategoryTreeData(self.placeableFurnitureCategoryTreeData, bagEntries)
                if bagId == BAG_BANK then
                    foundBankInventory = true
                end
            end
            -- it's very possible that we do not have the banks contents created at this point in the inventory cache
            -- so in the case that we did not have it yet, we need to create the data and put it in the category tree
            if not foundBankInventory then
                local filteredDataTable = SHARED_INVENTORY:GenerateFullSlotData(PlaceableFurnitureFilter, BAG_BANK)
                for _, itemData in pairs(filteredDataTable) do
                    self:CreateOrUpdateItemDataEntry(itemData.bagId, itemData.slotIndex)
                end
                -- maybe we don't actually have anything in our bank though, so only try to add bank items if there are bank items to add
                if itemFurnitureCache[BAG_BANK] then
                    --this filter operation will be late since we are already building the list and the text filter is async, but it will
                    --trigger a rebuild of the categories once it completes
                    --but only do this if we have a search string, otherwise this could cause the callback to make the placement list build twice
                    if self.placeableTextFilter ~= "" then
                        self:RequestApplyPlaceableTextFilterToData()
                    end
                    self:BuildCategoryTreeData(self.placeableFurnitureCategoryTreeData, itemFurnitureCache[BAG_BANK])
                end
            end
            self:BuildCategoryTreeData(self.placeableFurnitureCategoryTreeData, self:GetPlaceableFurnitureCache(ZO_PLACEABLE_TYPE_COLLECTIBLE))
            self.placeableFurnitureCategoryTreeData:SortCategoriesRecursive()
        end,
        RefreshSingle = function(furnitureCommand)
            ApplyFurnitureCommand(self.placeableFurnitureCategoryTreeData, furnitureCommand)
        end,
    })
    self.refreshGroups:AddRefreshGroup("UpdateRetrievableFurniture",
    {
        RefreshAll = function()
            self.retrievableFurnitureCategoryTreeData:Clear()
            self:BuildCategoryTreeData(self.retrievableFurnitureCategoryTreeData, self:GetRetrievableFurnitureCache())
            self.retrievableFurnitureCategoryTreeData:SortCategoriesRecursive()
        end,
        RefreshSingle = function(furnitureCommand)
            ApplyFurnitureCommand(self.retrievableFurnitureCategoryTreeData, furnitureCommand)
        end,
    })
    self.refreshGroups:AddRefreshGroup("UpdateMarketProducts",
    {
        RefreshAll = function()
            self.marketProductCategoryTreeData:Clear()
            self:BuildCategoryTreeData(self.marketProductCategoryTreeData, self:GetMarketProductCache())
            self.marketProductCategoryTreeData:SortCategoriesRecursive()
        end,
    })
    local function FurniturePlaced(eventId, furnitureId, collectibleId)
        self:OnFurniturePlacedInHouse(furnitureId, collectibleId)
    end
    local function FurnitureRemoved(eventId, furnitureId, collectibleId)
        self:OnFurnitureRemovedFromHouse(furnitureId, collectibleId)
    end
    EVENT_MANAGER:RegisterForEvent("SharedFurniture", EVENT_HOUSING_FURNITURE_PLACED, FurniturePlaced)
    EVENT_MANAGER:RegisterForEvent("SharedFurniture", EVENT_HOUSING_FURNITURE_REMOVED, FurnitureRemoved)
    local function InHouseOnUpdate()
        self:InHouseOnUpdate()
    end
    local function OnPlayerActivated()
        self:InitializeFurnitureCaches()
        if GetCurrentZoneHouseId() ~= 0 then
            EVENT_MANAGER:RegisterForUpdate("SharedFurniture", 100, InHouseOnUpdate)
        else
            EVENT_MANAGER:UnregisterForUpdate("SharedFurniture")
        end
        self.lastPlayerWorldX = nil
        self.lastPlayerWorldY = nil
        self.lastPlayerWorldZ = nil
        self.lastPlayerHeading = nil
    end
    EVENT_MANAGER:RegisterForEvent("SharedFurniture", EVENT_PLAYER_ACTIVATED, OnPlayerActivated)
    local function OnMarketStateUpdated(displayGroup, marketState)
        if displayGroup == MARKET_DISPLAY_GROUP_HOUSE_EDITOR then
            self:CreateOrUpdateMarketProductCache()
        end
    end
    EVENT_MANAGER:RegisterForEvent("SharedFurniture", EVENT_MARKET_STATE_UPDATED, function(eventId, ...) OnMarketStateUpdated(...) end)
    EVENT_MANAGER:RegisterForEvent("SharedFurniture", EVENT_MARKET_PURCHASE_RESULT, function(eventId, ...) self:CreateOrUpdateMarketProductCache() end)
    EVENT_MANAGER:RegisterForEvent("SharedFurniture", EVENT_BACKGROUND_LIST_FILTER_COMPLETE, function(eventId, ...) self:OnBackgroundListFilterComplete(...) end)
    EVENT_MANAGER:RegisterForEvent("SharedFurniture", EVENT_MAP_PING, function(eventId, ...) self:OnMapPing(...) end)
    EVENT_MANAGER:RegisterForEvent("SharedFurniture", EVENT_HOUSING_EDITOR_MODE_CHANGED, function(eventId, ...) self:OnHousingEditorModeChanged(...) end)
end
function ZO_SharedFurnitureManager:SetPlayerWaypointTo(retrievableFurniture)
    local furnitureId = retrievableFurniture:GetRetrievableFurnitureId()
    local worldX, worldY, worldZ = HousingEditorGetFurnitureWorldPosition(furnitureId)
    if SetPlayerWaypointByWorldLocation(worldX, worldY, worldZ) then
        ZO_Alert(UI_ALERT_CATEGORY_ALERT, nil, GetString(SI_HOUSING_FURNIUTRE_SET_WAYPOINT_SUCCESS))
        self.waypointToFurnitureId = furnitureId
        self.ourWaypointAdd = true
    end
end
function ZO_SharedFurnitureManager:OnMapPing(pingEventType, pingType, pingTag, x, y, isPingOwner)
    if pingTag == "waypoint" then
        if pingEventType == PING_EVENT_ADDED then
            if self.ourWaypointAdd then
                self.ourWaypointAdd = false
            end
        elseif pingEventType == PING_EVENT_REMOVED then
            --If the remove was triggered by our own add (there is only one player waypoint so setting it removes the old one) then we can ignore this.
            --Otherwise something else removed the player waypoint so clear out our state info.
            if not self.ourWaypointAdd then
                self.waypointToFurnitureId = nil
            end
        end
    end
end
function ZO_SharedFurnitureManager:OnHousingEditorModeChanged(oldMode, newMode)
    --If they picked up the furniture clear the player waypoint if it was showing the location of that furniture
    if newMode == HOUSING_EDITOR_MODE_PLACEMENT and self.waypointToFurnitureId and HousingEditorGetSelectedFurnitureId() == self.waypointToFurnitureId then
        RemovePlayerWaypoint()
    end
end
function ZO_SharedFurnitureManager:CreatePlacedFurnitureData(furnitureId)
    return ZO_RetrievableFurniture:New(furnitureId)
end
function ZO_SharedFurnitureManager:InitializeFurnitureCaches()
    --setup just the placeable collections, SharedInventory will tell us when its ready to query placeable items
    ZO_ClearTable(self.retrievableFurniture)
    for furnitureId in GetNextPlacedFurnitureIdIter do
        self.retrievableFurniture[zo_getSafeId64Key(furnitureId)] = self:CreatePlacedFurnitureData(furnitureId)
    end
    self.refreshGroups:RefreshAll("UpdateRetrievableFurniture")
end
function ZO_SharedFurnitureManager:OnFurniturePlacedInHouse(furnitureId, collectibleId)
    if collectibleId ~= 0 then
        local furnitureCollectible = self.placeableFurniture[ZO_PLACEABLE_TYPE_COLLECTIBLE][collectibleId]
        if self:CanAddFurnitureDataToRefresh(self.placeableFurnitureCategoryTreeData, furnitureCollectible) then
            self.refreshGroups:RefreshSingle("UpdatePlacementFurniture", { target=furnitureCollectible, command=FURNITURE_COMMAND_REMOVE })
        end
        self.placeableFurniture[ZO_PLACEABLE_TYPE_COLLECTIBLE][collectibleId] = nil
        --No need to run the text filter since this is just a remove. We can notify others immediately.
        self:FireCallbacks("PlaceableFurnitureChanged")
    end
    --if an item just add to the recall list, SharedInventory will propagate the placeable list changes
    local furnitureIdKey = zo_getSafeId64Key(furnitureId)
    self.retrievableFurniture[furnitureIdKey] = self:CreatePlacedFurnitureData(furnitureId)
end
function ZO_SharedFurnitureManager:OnFurnitureRemovedFromHouse(furnitureId, collectibleId)
    local furnitureIdKey = zo_getSafeId64Key(furnitureId)
    if collectibleId ~= 0 then
        self.placeableFurniture[ZO_PLACEABLE_TYPE_COLLECTIBLE][collectibleId] = ZO_PlaceableFurnitureCollectible:New(collectibleId)
    end
    --if an item just remove, the inventory update will handle the placeable list changes
    self.refreshGroups:RefreshSingle("UpdateRetrievableFurniture", { target=self.retrievableFurniture[furnitureIdKey], command=FURNITURE_COMMAND_REMOVE })
    self.retrievableFurniture[furnitureIdKey] = nil
    --No need to run the text filter since this is just a remove. We can notify others immediately.
    self:FireCallbacks("RetrievableFurnitureChanged")
    --If we removed this furniture and it had a waypoint then remove the waypoint
    if self.waypointToFurnitureId then
        if AreId64sEqual(furnitureId, self.waypointToFurnitureId) then
            RemovePlayerWaypoint()
        end
    end
end
function ZO_SharedFurnitureManager:OnFullInventoryUpdate(bagId)
end
function ZO_SharedFurnitureManager:OnSingleSlotInventoryUpdate(bagId, slotIndex, previousSlotData)
    local slotData = SHARED_INVENTORY:GenerateSingleSlotData(bagId, slotIndex)
    if slotData and slotData.isPlaceableFurniture then
        self:CreateOrUpdateItemDataEntry(bagId, slotIndex)
    elseif not slotData and previousSlotData and previousSlotData.isPlaceableFurniture then
        --the item was deleted
        local bag = self.placeableFurniture[ZO_PLACEABLE_TYPE_ITEM][bagId]
        if bag then
            local itemToRemove = bag[slotIndex]
            if self:CanAddFurnitureDataToRefresh(self.placeableFurnitureCategoryTreeData, itemToRemove) then
                self.refreshGroups:RefreshSingle("UpdatePlacementFurniture", { target = itemToRemove, command = FURNITURE_COMMAND_REMOVE })
            end
            bag[slotIndex] = nil
            --No need to run the text filter since this is just a remove. We can notify others immediately.
            self:FireCallbacks("PlaceableFurnitureChanged")
        end
    end
end
function ZO_SharedFurnitureManager:OnFullCollectionUpdate()
end
function ZO_SharedFurnitureManager:OnSingleCollectibleUpdate(collectibleId)
    local collectibleData = COLLECTIONS_INVENTORY_SINGLETON:GetSingleCollectibleData(collectibleId, IsCollectibleCategoryPlaceableFurniture)
    if collectibleData then
        if self:CreateOrUpdateCollectibleDataEntry(collectibleId) then
            self:RequestApplyPlaceableTextFilterToData()
        end
    else
        --something made the collectible no longer valid
        placeableCollectible = self.placeableFurniture[ZO_PLACEABLE_TYPE_COLLECTIBLE][collectibleId]
        if placeableCollectible and self:CanAddFurnitureDataToRefresh(self.placeableFurnitureCategoryTreeData, placeableCollectible) then
            self.refreshGroups:RefreshSingle("UpdatePlacementFurniture", { target=placeableCollectible, command=FURNITURE_COMMAND_REMOVE })
        end
        self.placeableFurniture[ZO_PLACEABLE_TYPE_COLLECTIBLE][collectibleId] = nil
        --No need to run the text filter since this is just a remove. We can notify others immediately.
        self:FireCallbacks("PlaceableFurnitureChanged")
    end
end 
do
    local function AddEntryToCategory(categoryTreeData, entry)
        local categoryId, subcategoryId = entry:GetCategoryInfo()
        if categoryId and categoryId > 0 then
            local categoryData = categoryTreeData:GetSubcategory(categoryId)
            if not categoryData then
                categoryTreeData:AddSubcategory(categoryId, ZO_FurnitureCategory:New(categoryTreeData, categoryId))
                categoryData = categoryTreeData:GetSubcategory(categoryId)
            end
            if subcategoryId and subcategoryId > 0 then
                local subcategoryData = categoryData:GetSubcategory(subcategoryId)
                if not subcategoryData then
                    categoryData:AddSubcategory(subcategoryId, ZO_FurnitureCategory:New(categoryData, subcategoryId))
                    subcategoryData = categoryData:GetSubcategory(subcategoryId)
                end
                subcategoryData:AddEntry(entry)
            else
                categoryData:AddEntry(entry)
            end
        else
            local categoryData = categoryTreeData:GetSubcategory(ZO_FURNITURE_NEEDS_CATEGORIZATION_FAKE_CATEGORY)
            if not categoryData then
                categoryTreeData:AddSubcategory(ZO_FURNITURE_NEEDS_CATEGORIZATION_FAKE_CATEGORY, ZO_FurnitureCategory:New(categoryTreeData, ZO_FURNITURE_NEEDS_CATEGORIZATION_FAKE_CATEGORY))
                categoryData = categoryTreeData:GetSubcategory(ZO_FURNITURE_NEEDS_CATEGORIZATION_FAKE_CATEGORY)
            end
            categoryData:AddEntry(entry)
        end
    end
    function ZO_SharedFurnitureManager:BuildCategoryTreeData(categoryTreeData, data)
        for _, furniture in pairs(data) do
            if furniture:GetPassesTextFilter() then
                AddEntryToCategory(categoryTreeData, furniture)
            end
        end
    end
    function ZO_SharedFurnitureManager:AddFurnitureToCategory(categoryTreeData, furniture)
        AddEntryToCategory(categoryTreeData, furniture)
    end
    function ZO_SharedFurnitureManager:RemoveFurnitureFromCategory(categoryTreeData, furniture)
        local categoryId, subcategoryId = furniture:GetCategoryInfo()
        if categoryId and categoryId > 0 then
            local categoryData = categoryTreeData:GetSubcategory(categoryId)
            if subcategoryId and subcategoryId > 0 then
                local subcategoryData = categoryData:GetSubcategory(subcategoryId)
                subcategoryData:RemoveEntry(furniture)
            else
                categoryData:RemoveEntry(furniture)
            end
        else
            local categoryData = categoryTreeData:GetSubcategory(ZO_FURNITURE_NEEDS_CATEGORIZATION_FAKE_CATEGORY)
            categoryData:RemoveEntry(furniture)
        end
    end
end
function ZO_SharedFurnitureManager:GetPlaceableFurnitureCache(type)
    return self.placeableFurniture[type]
end
function ZO_SharedFurnitureManager:GetRetrievableFurnitureCache()
    return self.retrievableFurniture
end
function ZO_SharedFurnitureManager:GetMarketProductCache()
    return self.marketProducts
end
function ZO_SharedFurnitureManager:GetPlaceableFurnitureCategoryTreeData()
    self.refreshGroups:UpdateRefreshGroups()
    return self.placeableFurnitureCategoryTreeData
end
function ZO_SharedFurnitureManager:GetRetrievableFurnitureCategoryTreeData()
    self.refreshGroups:UpdateRefreshGroups()
    return self.retrievableFurnitureCategoryTreeData
end
function ZO_SharedFurnitureManager:GetMarketProductCategoryTreeData()
    self.refreshGroups:UpdateRefreshGroups()
    return self.marketProductCategoryTreeData
end
function ZO_SharedFurnitureManager:CreateOrUpdateItemCache(bagId)
    if bagId then
        local itemCache = self.placeableFurniture[ZO_PLACEABLE_TYPE_ITEM]
        local bagCache = itemCache[bagId]
        if bagCache then
            ZO_ClearTable(bagCache)
        end
        local filteredDataTable = SHARED_INVENTORY:GenerateFullSlotData(PlaceableFurnitureFilter, bagId)
        for _, itemData in pairs(filteredDataTable) do
            self:CreateOrUpdateItemDataEntry(itemData.bagId, itemData.slotIndex)
        end
        self.refreshGroups:RefreshAll("UpdatePlacementFurniture")
    end
end
function ZO_SharedFurnitureManager:CreateOrUpdateCollectibleCache()
    local collectibleCache = self.placeableFurniture[ZO_PLACEABLE_TYPE_COLLECTIBLE]
    ZO_ClearTable(collectibleCache)
    
    local filteredDataTable = COLLECTIONS_INVENTORY_SINGLETON:GetCollectionsData(IsCollectibleCategoryPlaceableFurniture)
    for _, collectibleData in pairs(filteredDataTable) do
        self:CreateOrUpdateCollectibleDataEntry(collectibleData.collectibleId)
    end
    self.refreshGroups:RefreshAll("UpdatePlacementFurniture")
end
function ZO_SharedFurnitureManager:CreateOrUpdateMarketProductCache()
    local productCache = self.marketProducts
    ZO_ClearTable(productCache)
    self.housingMarketProductPool:ReleaseAllObjects()
    local NO_SUBCATEGORY = nil
    for categoryIndex = 1, GetNumMarketProductCategories(MARKET_DISPLAY_GROUP_HOUSE_EDITOR) do
        local _, numSubcategories, numMarketProducts = GetMarketProductCategoryInfo(MARKET_DISPLAY_GROUP_HOUSE_EDITOR, categoryIndex)
        for marketProductIndex = 1, numMarketProducts do
            local productId, presentationIndex = GetMarketProductPresentationIds(MARKET_DISPLAY_GROUP_HOUSE_EDITOR, categoryIndex, NO_SUBCATEGORY, marketProductIndex)
            self:CreateMarketProductEntry(productId, presentationIndex)
        end
        for subcategoryIndex = 1, numSubcategories do
            local _, numSubCategoryMarketProducts = GetMarketProductSubCategoryInfo(MARKET_DISPLAY_GROUP_HOUSE_EDITOR, categoryIndex, subcategoryIndex)
            for marketProductIndex = 1, numSubCategoryMarketProducts do
                local productId, presentationIndex = GetMarketProductPresentationIds(MARKET_DISPLAY_GROUP_HOUSE_EDITOR, categoryIndex, subcategoryIndex, marketProductIndex)
                self:CreateMarketProductEntry(productId, presentationIndex)
            end
        end
    end
    self.refreshGroups:RefreshAll("UpdateMarketProducts")
end
function ZO_SharedFurnitureManager:CreateOrUpdateItemDataEntry(bagId, slotIndex)
    local itemCache = self.placeableFurniture[ZO_PLACEABLE_TYPE_ITEM]
    local bag = itemCache[bagId]
    if not bag then
        bag = {}
        itemCache[bagId] = bag
    end
    local placeableItem = bag[slotIndex]
    if placeableItem then
        placeableItem:RefreshInfo(bagId, slotIndex)
    else
        bag[slotIndex] = ZO_PlaceableFurnitureItem:New(bagId, slotIndex)
        placeableItem = bag[slotIndex]
    end
end
function ZO_SharedFurnitureManager:CreateOrUpdateCollectibleDataEntry(collectibleId)
    local existingCollectible = self.placeableFurniture[ZO_PLACEABLE_TYPE_COLLECTIBLE][collectibleId]
    if HousingEditorCanPlaceCollectible(collectibleId) then
        if existingCollectible then
            existingCollectible:RefreshInfo(collectibleId)
        else
            local newCollectible = ZO_PlaceableFurnitureCollectible:New(collectibleId)
            self.placeableFurniture[ZO_PLACEABLE_TYPE_COLLECTIBLE][collectibleId] = newCollectible
        end
        return true
    else
        if existingCollectible and self:CanAddFurnitureDataToRefresh(self.placeableFurnitureCategoryTreeData, existingCollectible) then
            self.refreshGroups:RefreshSingle("UpdatePlacementFurniture", { target=existingCollectible, command=FURNITURE_COMMAND_REMOVE })
        end
        self.placeableFurniture[ZO_PLACEABLE_TYPE_COLLECTIBLE][collectibleId] = nil
        --No need to run the text filter since this is just a remove. We can notify others immediately.
        self:FireCallbacks("PlaceableFurnitureChanged")
        return false
    end
end
function ZO_SharedFurnitureManager:CreateMarketProductEntry(marketProductId, presentationIndex)
    local marketHousingProduct = self.housingMarketProductPool:AcquireObject()
    marketHousingProduct:RefreshInfo(marketProductId, presentationIndex)
    table.insert(self.marketProducts, marketHousingProduct)
end
function ZO_SharedFurnitureManager:DoesPlayerHavePlaceableFurniture()
    return next(self.placeableFurniture[ZO_PLACEABLE_TYPE_COLLECTIBLE]) ~= nil or
        next(self.placeableFurniture[ZO_PLACEABLE_TYPE_ITEM]) ~= nil
end
function ZO_SharedFurnitureManager:DoesPlayerHaveRetrievableFurniture()
    return next(self.retrievableFurniture) ~= nil
end
function ZO_SharedFurnitureManager:AreThereMarketProducts()
    return next(self.marketProducts) ~= nil
end
do
    local DISTANCE_CHANGE_BEFORE_UPDATE = 10
    local HEADING_CHANGE_BEFORE_UPDATE_RADIANS = math.rad(5)
    function ZO_SharedFurnitureManager:InHouseOnUpdate()
        if next(self.retrievableFurniture) then
            local playerWorldX, playerWorldY, playerWorldZ = GetPlayerWorldPositionInHouse()
            local playerCameraHeading = GetPlayerCameraHeading()
            --If this is the first update in the zone or we've moved far enough from our last position then update the retrievable furniture's
            --position information relative to the player.
            local updateDistances = false
            if self.lastPlayerWorldX == nil then
                updateDistances = true
            else
                local distanceChange = zo_abs(playerWorldX - self.lastPlayerWorldX) + zo_abs(playerWorldY - self.lastPlayerWorldY) + zo_abs(playerWorldZ - self.lastPlayerWorldZ)
                if distanceChange > DISTANCE_CHANGE_BEFORE_UPDATE then
                    updateDistances = true
                end
            end
            self.lastPlayerWorldX = playerWorldX
            self.lastPlayerWorldY = playerWorldY
            self.lastPlayerWorldZ = playerWorldZ
            --If this is the first update or we are updating the distances (which also influences heading) or we have turned the camera far enough from
            --our last heading then update the retrievable furniture direction to the player
            local updateHeading = false
            if self.lastPlayerHeading == nil or updateDistances then
                updateHeading = true
            elseif zo_abs(self.lastPlayerHeading - playerCameraHeading) > HEADING_CHANGE_BEFORE_UPDATE_RADIANS then
                updateHeading = true
            end
            self.lastPlayerHeading = playerCameraHeading
            --In both cases we update all the position data. This could be changed to only touch the heading for the heading case but
            --it saves very little.
            if updateDistances or updateHeading then
                for furnitureIdKey, retrievableFurniture in pairs(self.retrievableFurniture) do
                    retrievableFurniture:RefreshPositionalData(playerWorldX, playerWorldY, playerWorldZ, playerCameraHeading)
                end
            end
            --Notify that the distances have changed
            if updateDistances then             
                self:FireCallbacks("RetrievableFurnitureDistanceAndHeadingChanged")
            elseif updateHeading then
                self:FireCallbacks("RetrievableFurnitureHeadingChanged")
            end
        end
    end
end
function ZO_SharedFurnitureManager:GetPlaceableTextFilter()
    return self.placeableTextFilter
end
function ZO_SharedFurnitureManager:SetPlaceableTextFilter(text)
    if text ~= self.placeableTextFilter then
        self.placeableTextFilter = text    
        self:RequestApplyPlaceableTextFilterToData()    
    end
end
function ZO_SharedFurnitureManager:GetRetrievableTextFilter()
    return self.retrievableTextFilter
end
function ZO_SharedFurnitureManager:SetRetrievableTextFilter(text)
    if text ~= self.retrievableTextFilter then
        self.retrievableTextFilter = text    
    end
end
function ZO_SharedFurnitureManager:GetMarketProductTextFilter()
    return self.marketProductTextFilter
end
function ZO_SharedFurnitureManager:SetMarketProductTextFilter(text)
    if text ~= self.marketProductTextFilter then
        self.marketProductTextFilter = text    
    end
end
function ZO_SharedFurnitureManager:CanAddFurnitureDataToRefresh(categoryTree, furnitureData)
    local canAddToRefresh = true
    local categoryId, subcategoryId = furnitureData:GetCategoryInfo()
    if categoryId and categoryId > 0 then
        local categoryData = categoryTree:GetSubcategory(categoryId)
        canAddToRefresh = categoryData ~= nil
        if canAddToRefresh and subcategoryId and subcategoryId > 0 then
            local subcategoryData = categoryData:GetSubcategory(subcategoryId)
            canAddToRefresh = subcategoryData ~= nil
        end
    end
    return canAddToRefresh
end
--Starts a background task to filter the placeable list entries using the text input. This will eventually result in the category list being marked dirty
--and others being notified to update once the filter completes.
function ZO_SharedFurnitureManager:RequestApplyPlaceableTextFilterToData()
    --Cancel any in progress filtering so we can do a new one
    for _, taskId in pairs(self.inProgressPlaceableFurnitureTextFilterTaskIds) do
        DestroyBackgroundListFilter(taskId)
    end
        
    --If we have filter text than create the tasks
    if self.placeableTextFilter ~= "" then
        --Inventory Items
        local itemTaskId = CreateBackgroundListFilter(BACKGROUND_LIST_FILTER_TARGET_BAG_SLOT, self.placeableTextFilter)
        self.inProgressPlaceableFurnitureTextFilterTaskIds[ZO_PLACEABLE_TYPE_ITEM] = itemTaskId
        AddBackgroundListFilterType(itemTaskId, BACKGROUND_LIST_FILTER_TYPE_NAME)
        for bagId, slots in pairs(self.placeableFurniture[ZO_PLACEABLE_TYPE_ITEM]) do
            for slotId, slotData in pairs(slots) do
                slotData:SetPassesTextFilter(false)
                AddBackgroundListFilterEntry(itemTaskId, bagId, slotId)
            end
        end
        StartBackgroundListFilter(itemTaskId)
        --Collectibles
        local collectibleTaskId = CreateBackgroundListFilter(BACKGROUND_LIST_FILTER_TARGET_COLLECTIBLE_ID, self.placeableTextFilter)
        self.inProgressPlaceableFurnitureTextFilterTaskIds[ZO_PLACEABLE_TYPE_COLLECTIBLE] = collectibleTaskId
        AddBackgroundListFilterType(collectibleTaskId, BACKGROUND_LIST_FILTER_TYPE_NAME)
        for collectibleId, collectibleData in pairs(self.placeableFurniture[ZO_PLACEABLE_TYPE_COLLECTIBLE]) do
            collectibleData:SetPassesTextFilter(false)
            AddBackgroundListFilterEntry(collectibleTaskId, collectibleId)
        end
        StartBackgroundListFilter(collectibleTaskId)
    --If we have no search text then everything passes, so set everything to true now.
    else
        --Inventory Items
        for bagId, slots in pairs(self.placeableFurniture[ZO_PLACEABLE_TYPE_ITEM]) do
            for slotId, slotData in pairs(slots) do
                slotData:SetPassesTextFilter(true)
            end
        end
        --Collectibles
        for collectibleId, collectibleData in pairs(self.placeableFurniture[ZO_PLACEABLE_TYPE_COLLECTIBLE]) do
            collectibleData:SetPassesTextFilter(true)
        end
        --Mark the placeable furniture category data dirty and let others know about that
        self.refreshGroups:RefreshAll("UpdatePlacementFurniture")
        self:FireCallbacks("PlaceableFurnitureChanged")
    end
end
--Starts a background task to filter the retrievable list entries using the text input. This will eventually result in the category list being marked dirty
--and others being notified to update once the filter completes.
function ZO_SharedFurnitureManager:RequestApplyRetrievableTextFilterToData()
    if self.inProgressRetrievableTextFilterTaskId then
        DestroyBackgroundListFilter(self.inProgressRetrievableTextFilterTaskId)
    end
    --If we have filter text than create the task
    if self.retrievableTextFilter ~= "" then
        local furnitureTaskId = CreateBackgroundListFilter(BACKGROUND_LIST_FILTER_TARGET_FURNITURE_ID, self.retrievableTextFilter)
        self.inProgressRetrievableFurnitureTextFilterTaskId = furnitureTaskId
        AddBackgroundListFilterType(furnitureTaskId, BACKGROUND_LIST_FILTER_TYPE_NAME)
        for _, furnitureData in pairs(self.retrievableFurniture) do
            furnitureData:SetPassesTextFilter(false)
            local furnitureId = furnitureData:GetFurnitureId()
            AddBackgroundListFilterEntry64(furnitureTaskId, furnitureId) 
        end
        StartBackgroundListFilter(furnitureTaskId)
    --If we have no search text then everything passes, so set everything to true now.
    else
        for _, furnitureData in pairs(self.retrievableFurniture) do
            furnitureData:SetPassesTextFilter(true)
        end
        --Mark the retrievable furniture category data dirty and let others know about that
        self.refreshGroups:RefreshAll("UpdateRetrievableFurniture")
        self:FireCallbacks("RetrievableFurnitureChanged")
    end
end
function ZO_SharedFurnitureManager:RequestApplyMarketProductTextFilterToData()
    if self.inProgressMarketProductTextFilterTaskId then
        DestroyBackgroundListFilter(self.inProgressMarketProductTextFilterTaskId)
    end
    --If we have filter text than create the task
    if self.marketProductTextFilter ~= "" then
        local marketProductTaskId = CreateBackgroundListFilter(BACKGROUND_LIST_FILTER_TARGET_MARKET_PRODUCT_ID, self.marketProductTextFilter)
        self.inProgressMarketProductTextFilterTaskId = marketProductTaskId
        AddBackgroundListFilterType(marketProductTaskId, BACKGROUND_LIST_FILTER_TYPE_NAME)
        AddBackgroundListFilterType(marketProductTaskId, BACKGROUND_LIST_FILTER_TYPE_DESCRIPTION)
        AddBackgroundListFilterType(marketProductTaskId, BACKGROUND_LIST_FILTER_TYPE_SEARCH_KEYWORDS)
        for i, marketProductData in ipairs(self.marketProducts) do
            marketProductData:SetPassesTextFilter(false)
            AddBackgroundListFilterEntry(marketProductTaskId, marketProductData:GetMarketProductId())
        end
        StartBackgroundListFilter(marketProductTaskId)
    --If we have no search text then everything passes, so set everything to true now.
    else
        for i, marketProductData in ipairs(self.marketProducts) do
            marketProductData:SetPassesTextFilter(true)
        end
        --Mark the market product category data dirty and let others know about that
        self.refreshGroups:RefreshAll("UpdateMarketProducts")
        self:FireCallbacks("MarketProductsChanged")
    end
end
function ZO_SharedFurnitureManager:TryMarkPlaceableBackgroundListFilterComplete(placeableType, taskId)
    if self.inProgressPlaceableFurnitureTextFilterTaskIds[placeableType] == taskId then
        self.inProgressPlaceableFurnitureTextFilterTaskIds[placeableType] = nil
        self.completePlaceableFurnitureTextFilterTaskIds[placeableType] = taskId
        return true
    end
    return false
end
function ZO_SharedFurnitureManager:OnBackgroundListFilterComplete(taskId)
    local CHANGED_FROM_SEARCH = true
    --Retrievable
    if taskId == self.inProgressRetrievableFurnitureTextFilterTaskId then
        self.inProgressRetrievableFurnitureTextFilterTaskId = nil
        --Set everything that passed the filter to true
        local retrievableFurnitureDataCache = self.retrievableFurniture
        if retrievableFurnitureDataCache then
            for i = 1, GetNumBackgroundListFilterResults(taskId) do
                local furnitureId = GetBackgroundListFilterResult64(taskId, i)
                local furnitureIdKey = zo_getSafeId64Key(furnitureId)
                local furnitureData = retrievableFurnitureDataCache[furnitureIdKey]
                if furnitureData then
                    furnitureData:SetPassesTextFilter(true)
                end
            end
        end
        DestroyBackgroundListFilter(taskId)
        --Mark the retrievable furniture category data dirty and let others know about that
        self.refreshGroups:RefreshAll("UpdateRetrievableFurniture")
        self:FireCallbacks("RetrievableFurnitureChanged", CHANGED_FROM_SEARCH)
    --Market Product
    elseif taskId == self.inProgressMarketProductTextFilterTaskId then
        self.inProgressMarketProductTextFilterTaskId = nil
        local marketProductDataCache = self.marketProducts
        if marketProductDataCache then
            for i = 1, GetNumBackgroundListFilterResults(taskId) do
                local marketProductId = GetBackgroundListFilterResult(taskId, i)
                for _, marketProductData in ipairs(marketProductDataCache) do
                    if marketProductData:GetMarketProductId() == marketProductId then
                        marketProductData:SetPassesTextFilter(true)
                    end
                end
            end
        end
        DestroyBackgroundListFilter(taskId)
        --Mark the retrievable furniture category data dirty and let others know about that
        self.refreshGroups:RefreshAll("UpdateMarketProducts")
        self:FireCallbacks("MarketProductsChanged", CHANGED_FROM_SEARCH)
    --Item/Collectible that can be placed
    else
        --Mark that it was completed.
        if not self:TryMarkPlaceableBackgroundListFilterComplete(ZO_PLACEABLE_TYPE_ITEM, taskId) then
            self:TryMarkPlaceableBackgroundListFilterComplete(ZO_PLACEABLE_TYPE_COLLECTIBLE, taskId)
        end
        --We only trigger the update when all outstanding filter tasks are done. This is to
        --prevent building the categories 3 times for each letter typed in the search box and also to prevent having the
        --categories rebuilt with only some of the visibility states know.
        if next(self.inProgressPlaceableFurnitureTextFilterTaskIds) == nil then
            --Inventory Items
            local itemTaskId = self.completePlaceableFurnitureTextFilterTaskIds[ZO_PLACEABLE_TYPE_ITEM]
            local itemDataCache = self.placeableFurniture[ZO_PLACEABLE_TYPE_ITEM]
            if itemDataCache then
                for i = 1, GetNumBackgroundListFilterResults(itemTaskId) do
                    local bag, slot = GetBackgroundListFilterResult(itemTaskId, i)
                    local bagCache = itemDataCache[bag]
                    if bagCache then
                        local slotData = bagCache[slot]
                        if slotData then
                            slotData:SetPassesTextFilter(true)
                        end
                    end
                end
            end
            DestroyBackgroundListFilter(itemTaskId)
            --Collectibles
            local collectibleTaskId = self.completePlaceableFurnitureTextFilterTaskIds[ZO_PLACEABLE_TYPE_COLLECTIBLE]
            local collectibleDataCache = self.placeableFurniture[ZO_PLACEABLE_TYPE_COLLECTIBLE]
            if collectibleDataCache then
                for i = 1, GetNumBackgroundListFilterResults(collectibleTaskId) do
                    local collectibleId = GetBackgroundListFilterResult(collectibleTaskId, i)
                    local collectibleData = collectibleDataCache[collectibleId]
                    if collectibleData then
                        collectibleData:SetPassesTextFilter(true)
                    end
                end
            end
            DestroyBackgroundListFilter(collectibleTaskId)
            --Mark the placeable furniture category data dirty and let others know about that
            self.refreshGroups:RefreshAll("UpdatePlacementFurniture")
            self:FireCallbacks("PlaceableFurnitureChanged", CHANGED_FROM_SEARCH)
        end
    end
end
SHARED_FURNITURE = ZO_SharedFurnitureManager:New()