Back to Home

ESO Lua File v101043

ingame/housingeditor/keyboard/furnitureclasses_keyboard.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
--
--[[ ZO_HousingBrowserList ]]--
--
ZO_HousingBrowserList = ZO_TextSearchObject:Subclass()
function ZO_HousingBrowserList:Initialize(control, owner, searchContext, searchEditBox)
    ZO_TextSearchObject.Initialize(self, searchContext, searchEditBox)
    self.control = control
    self.owner = owner
    self.contents = control:GetNamedChild("Contents")
    self.parentCategoryTemplate = "ZO_FurnitureBrowserCategory"
    self.childlessCategoryTemplate = "ZO_FurnitureBrowserChildless"
    self.subCategoryTemplate = "ZO_FurnitureBrowserSubCategory"
    local ALWAYS_ANIMATE = true
    self.fragment = ZO_FadeSceneFragment:New(self.control, ALWAYS_ANIMATE)
    self.fragment:RegisterCallback("StateChange", function(oldState, newState)
        if newState == SCENE_FRAGMENT_SHOWING then
            self:OnShowing()
        elseif newState == SCENE_FRAGMENT_SHOWN then
            self:OnShown()
        elseif newState == SCENE_FRAGMENT_HIDING then
            self:OnHiding()
        elseif newState == SCENE_FRAGMENT_HIDDEN then
            self:OnHidden()
        end
    end)
end
function ZO_HousingBrowserList:GetFragment()
    return self.fragment
end
function ZO_HousingBrowserList:OnShowing()
    if self.keybindStripDescriptor then
        KEYBIND_STRIP:AddKeybindButtonGroup(self.keybindStripDescriptor)
    end
end
function ZO_HousingBrowserList:OnShown()
    -- Can override
end
function ZO_HousingBrowserList:OnHiding()
    if self.keybindStripDescriptor then
        KEYBIND_STRIP:RemoveKeybindButtonGroup(self.keybindStripDescriptor)
    end
end
function ZO_HousingBrowserList:OnHidden()
    -- Can override
end
function ZO_HousingBrowserList:GetCategoryInfo(categoryId, categoryObject)
    local normalIcon, pressedIcon, mouseoverIcon
    local isFakedSubcategory = false
    if categoryId == ZO_FURNITURE_NEEDS_CATEGORIZATION_FAKE_CATEGORY then
        isFakedSubcategory = true
    elseif categoryId == ZO_FURNITURE_PATH_NODES_FAKE_CATEGORY then
        isFakedSubcategory = true
        normalIcon = "EsoUI/Art/Housing/Keyboard/housing_category_npc_pathing_up.dds"
        pressedIcon = "EsoUI/Art/Housing/Keyboard/housing_category_npc_pathing_down.dds"
        mouseoverIcon = "EsoUI/Art/Housing/Keyboard/housing_category_npc_pathing_over.dds"
    else
        normalIcon, pressedIcon, mouseoverIcon = GetFurnitureCategoryKeyboardIcons(categoryId)
    end
    -- Avoiding zo_strformat for performance, this will get run for every category every time the number of entries could have changed
    local formattedName = string.format("%s (%d)", categoryObject:GetName(), categoryObject:GetNumEntryItemsRecursive())
    return formattedName, normalIcon, pressedIcon, mouseoverIcon, isFakedSubcategory
end
do
    local function AddNodeLookup(lookup, node, parent, categoryId)
        if categoryId ~= nil then
            local parentCategory = categoryId
            local subCategory
            if parent then
                parentCategory = parent.data.categoryId
                subCategory = categoryId
            end
            local categoryTable = lookup[parentCategory]
            
            if categoryTable == nil then
                categoryTable = { subCategories = {} }
                lookup[parentCategory] = categoryTable
            end
            if subCategory then
                categoryTable.subCategories[subCategory] = node
            else
                categoryTable.node = node
            end
        end
    end
    function ZO_HousingBrowserList:AddCategory(tree, nodeTemplate, parent, categoryId, categoryObject)
        local name, normalIcon, pressedIcon, mouseoverIcon, isFakedSubcategory = self:GetCategoryInfo(categoryId, categoryObject)
        local entryData =
        {
            isFakedSubcategory = isFakedSubcategory,
            categoryId = categoryId,
            categoryEntries = categoryObject:GetAllEntries(),
            name = name,
            parentData = parent and parent.data or nil,
            normalIcon = normalIcon,
            pressedIcon = pressedIcon,
            mouseoverIcon = mouseoverIcon,
        }
        local node = tree:AddNode(nodeTemplate, entryData, parent)
        AddNodeLookup(self.nodeLookupData, node, parent, categoryId)
        entryData.node = node
        categoryObject.node = node
        return node
    end
    function ZO_HousingBrowserList:BuildCategories()
        local currentSelectedData = self.categoryTree:GetSelectedData()
        self.categoryTree:Reset()
        self.nodeLookupData = {}
        local hasCategory = false
        local categoryTreeData = self:GetCategoryTreeData()
        if categoryTreeData then
            local isOwner = IsOwnerOfCurrentHouse()
            local allTopLevelCategories = categoryTreeData:GetAllSubcategories()
            for index, categoryObject in ipairs(allTopLevelCategories) do
                if isOwner or not categoryObject:IsOwnerRestrictedCategory() then
                    self:AddTopLevelCategory(categoryObject)
                    hasCategory = true
                end
            end
        end
        local nodeToSelect
        if currentSelectedData then
            local categoryId
            local subcatgoryId
            local parentData = currentSelectedData.parentData
            if parentData then
                categoryId = parentData.categoryId
                subcatgoryId = currentSelectedData.categoryId
            else
                categoryId = currentSelectedData.categoryId
            end
            nodeToSelect = self:GetCategoryData(categoryId, subcatgoryId)
        end
        self.categoryTree:Commit(nodeToSelect)
        if hasCategory then
            self:SetNoItemTextShown(false)
        else
            self.selectedCategoryEntries = nil
            self.contentsList:RefreshData()
            self:SetNoItemTextShown(true, self:GetNoItemText())
        end
    end
end
function ZO_HousingBrowserList:GetCategoryData(categoryId, subCategoryId)
    if categoryId ~= nil then
        local categoryTable = self.nodeLookupData[categoryId]
        if categoryTable ~= nil then
            if subCategoryId ~= nil then
                return categoryTable.subCategories[subCategoryId]
            else
                if categoryTable.node:IsLeaf() then
                    return categoryTable.node
                else
                    return categoryTable.node:GetChildren()[1]
                end
            end
        end
    end
end
function ZO_HousingBrowserList:AddTopLevelCategory(categoryObject)
    local categoryId = categoryObject:GetCategoryId()
    local tree = self.categoryTree
    local nodeTemplate = self.childlessCategoryTemplate
    local hasChildren = categoryObject:GetHasSubcategories()
    if hasChildren then
        nodeTemplate = self.parentCategoryTemplate
    end
    local NO_PARENT = nil
    local parent = self:AddCategory(tree, nodeTemplate, NO_PARENT, categoryId, categoryObject)
    if hasChildren then
        local isOwner = IsOwnerOfCurrentHouse()
        local allSubcategories = categoryObject:GetAllSubcategories()
        for index, subcategoryObject in ipairs(allSubcategories) do
            if isOwner or not subcategoryObject:IsOwnerRestrictedCategory() then
                local subcategoryId = subcategoryObject:GetCategoryId()
                self:AddCategory(tree, self.subCategoryTemplate, parent, subcategoryId, subcategoryObject)
            end
        end
    end
    return parent
end
function ZO_HousingBrowserList:InitializeCategories(control)
    self.categories = control:GetNamedChild("CategoryList")
    self.categoryTree = ZO_Tree:New(self.categories:GetNamedChild("ScrollChild"), 60, -10, ZO_HOUSING_FURNITURE_BROWSER_CATEGORY_LIST_WIDTH)
    self.noMatchMessageLabel = control:GetNamedChild("NoMatchMessage")
    local function BaseTreeHeaderIconSetup(control, data, open)
        local iconTexture = (open and data.pressedIcon or data.normalIcon) or ZO_NO_TEXTURE_FILE
        local mouseoverTexture = data.mouseoverIcon or ZO_NO_TEXTURE_FILE
        
        control.icon:SetTexture(iconTexture)
        control.iconHighlight:SetTexture(mouseoverTexture)
        ZO_IconHeader_Setup(control, open)
    end
    local function BaseTreeHeaderSetup(node, control, data, open)
        control.text:SetText(data.name)
        BaseTreeHeaderIconSetup(control, data, open)
    end
    local function TreeHeaderSetup_Child(node, control, data, open, userRequested)
        BaseTreeHeaderSetup(node, control, data, open)
        if open and userRequested then
            self.categoryTree:SelectFirstChild(node)
        end
    end
    local function TreeHeaderSetup_Childless(node, control, data, open)
        BaseTreeHeaderSetup(node, control, data, open)
    end
    local function TreeEntryOnSelected(control, data, selected, reselectingDuringRebuild)
        control:SetSelected(selected)
        if selected and not reselectingDuringRebuild then
            self:OnCategorySelected(data)
        end
    end
    local function TreeEntryOnSelected_Childless(control, data, selected, reselectingDuringRebuild)
        TreeEntryOnSelected(control, data, selected, reselectingDuringRebuild)
        BaseTreeHeaderIconSetup(control, data, selected)
    end
    local function TreeEntrySetup(node, control, data, open)
        control:SetSelected(node:IsSelected())
        control:SetText(data.name)
    end
    local NO_SELECTION_FUNCTION = nil
    local NO_EQUALITY_FUNCTION = nil
    local childSpacing = 0
    self.categoryTree:AddTemplate(self.parentCategoryTemplate, TreeHeaderSetup_Child, NO_SELECTION_FUNCTION, NO_EQUALITY_FUNCTION, ZO_HOUSING_FURNITURE_BROWSER_SUBCATEGORY_INDENT, childSpacing)
    self.categoryTree:AddTemplate(self.childlessCategoryTemplate, TreeHeaderSetup_Childless, TreeEntryOnSelected_Childless)
    self.categoryTree:AddTemplate(self.subCategoryTemplate, TreeEntrySetup, TreeEntryOnSelected)
    self.categoryTree:SetExclusive(true)
    self.categoryTree:SetOpenAnimation("ZO_TreeOpenAnimation")
end
function ZO_HousingBrowserList:SetNoItemTextShown(shown, text)
    self.noMatchMessageLabel:SetHidden(not shown)
    if shown then
        self.noMatchMessageLabel:SetText(text)
    end
end
function ZO_HousingBrowserList:OnCategorySelected(data)
    assert(false) -- Needs to be overridden in derived classes
end
function ZO_HousingBrowserList:GetCategoryTreeData()
    assert(false) -- Needs to be overridden in derived classes
end
function ZO_HousingBrowserList:InitializeKeybindStrip()
    --Override
end
--
--[[ ZO_HousingFurnitureList ]]--
--
ZO_HousingFurnitureList = ZO_Object.MultiSubclass(ZO_HousingBrowserList, ZO_CallbackObject)
function ZO_HousingFurnitureList:New(...)
    local list = ZO_CallbackObject.New(self)
    list:Initialize(...)
    return list
end
function ZO_HousingFurnitureList:Initialize(...)
    ZO_HousingBrowserList.Initialize(self, ...)
    self:InitializeList()
    self.CompareFurnitureEntriesFunction = function(a, b)
        return self:CompareFurnitureEntries(a.data, b.data)
    end
    local searchEditBox = self.control:GetNamedChild("ContentsSearchBoxBox")
    if searchEditBox then
        searchEditBox:SetHandler("OnTextChanged", function(editBox)
            self:OnSearchTextChanged(editBox)
        end)
    end
    self:SetSearchEditBox(searchEditBox)
    self.freeSlotsLabel = self.contents:GetNamedChild("InfoBarFreeSlots")
end
function ZO_HousingFurnitureList:InitializeList()
    local contentsList = ZO_SortFilterList:New(self.contents)
    self.contentsList = contentsList
    contentsList.BuildMasterList = function()
        self:ContentsBuildMasterList()
    end
    contentsList.FilterScrollList = function()
        self:ContentsFilterScrollList()
    end
    contentsList.SortScrollList = function()
        self:ContentsSortScrollList()
    end
    contentsList.CommitScrollList = function()
        self:ContentsCommitScrollList()
    end
    ZO_ScrollList_EnableSelection(contentsList:GetListControl(), "ZO_ThinListHighlight", function(...) self:OnSelectionChanged(...) end)
    ZO_ScrollList_SetDeselectOnReselect(contentsList:GetListControl(), false)
end
function ZO_HousingFurnitureList:GetList()
    return self.contentsList:GetListControl()
end
function ZO_HousingFurnitureList:OnShowing()
    ZO_HousingBrowserList.OnShowing(self)
end
function ZO_HousingFurnitureList:OnShown()
    ZO_HousingBrowserList.OnShown(self)
end
function ZO_HousingFurnitureList:OnHiding()
    ZO_HousingBrowserList.OnHiding(self)
        self:ClearSelection()
    end
end
function ZO_HousingFurnitureList:OnSearchTextChanged(editBox)
    -- Can override
end
function ZO_HousingFurnitureList:AddDataType(dataType, controlTemplate, entryHeight, setupFunction, hideFunction)
    ZO_ScrollList_AddDataType(self.contentsList:GetListControl(), dataType, controlTemplate, entryHeight, setupFunction, hideFunction)
end
function ZO_HousingFurnitureList:UpdateLists()
    -- When the furniture data is updated the most recently selected item might have been destroyed so clear it out just in case.
    self:ClearSelection()
end
function ZO_HousingFurnitureList:UpdateContentsSort()
    self.contentsList:RefreshSort()
end
function ZO_HousingFurnitureList:UpdateContentsVisible()
    self.contentsList:RefreshVisible()
end
function ZO_HousingFurnitureList:BuildCategories()
    ZO_HousingBrowserList.BuildCategories(self)
end
function ZO_HousingFurnitureList:OnCategorySelected(data)
    self.selectedCategoryEntries = data.categoryEntries
    self.contentsList:RefreshData()
end
function ZO_HousingFurnitureList:ContentsBuildMasterList()
    if self.selectedCategoryEntries then
        self.contentsMasterList = ZO_ShallowTableCopy(self.selectedCategoryEntries)
    else
        self.contentsMasterList = {}
    end
end
function ZO_HousingFurnitureList:ContentsFilterScrollList()
    local scrollData = ZO_ScrollList_GetDataList(self.contentsList:GetListControl())
    ZO_ClearNumericallyIndexedTable(scrollData)
    for _, entryData in ipairs(self.contentsMasterList) do
        table.insert(scrollData, ZO_ScrollList_CreateDataEntry(entryData:GetDataType(), entryData))
    end
end
function ZO_HousingFurnitureList:CompareFurnitureEntries(a, b)
    return a:GetRawName() < b:GetRawName()
end
function ZO_HousingFurnitureList:ContentsSortScrollList()
    local scrollData = ZO_ScrollList_GetDataList(self:GetList())
    table.sort(scrollData, self.CompareFurnitureEntriesFunction)
end
function ZO_HousingFurnitureList:ContentsCommitScrollList()
    ZO_SortFilterList.CommitScrollList(self.contentsList)
    --Reselect the most recently selected data if it is in this contents list
    ZO_ScrollList_SelectData(self.contentsList:GetListControl(), self.mostRecentlySelectedData)
end
function ZO_HousingFurnitureList:SetMostRecentlySelectedData(data)
    self.mostRecentlySelectedData = data
    if self.mostRecentlySelectedData and self.mostRecentlySelectedData:IsPreviewable() then
        ZO_HousingFurnitureBrowser_Base.PreviewFurniture(self.mostRecentlySelectedData)
    else
        ITEM_PREVIEW_KEYBOARD:EndCurrentPreview()
    end
    if self.keybindStripDescriptor then
        KEYBIND_STRIP:UpdateKeybindButtonGroup(self.keybindStripDescriptor)
    end
    self:FireCallbacks("OnMostRecentlySelectedDataChanged", data)
end
function ZO_HousingFurnitureList:GetMostRecentlySelectedData()
    return self.mostRecentlySelectedData
end
function ZO_HousingFurnitureList:OnSelectionChanged(previouslySelectedData, selectedData, selectingDuringRebuild)
    -- When switching between categories the list will clear it's selection
    -- but we want to preserve the last selection so we can restore it later
    -- so if selectedData is nil we will skip he call to SetMostRecentlySelectedData
    if selectedData then
        self:SetMostRecentlySelectedData(selectedData)
    end
end
function ZO_HousingFurnitureList:ClearSelection()
end
function ZO_HousingFurnitureList:GetNoItemsText()
    --Override
    assert(false)
end
function ZO_HousingFurnitureList:UpdateFreeSlots()
    local numUsedSlots, numSlots = PLAYER_INVENTORY:GetNumSlots(INVENTORY_BACKPACK)
    if self.numUsedSlots ~= numUsedSlots or self.numSlots ~= numSlots then
        self.numUsedSlots = numUsedSlots
        self.numSlots = numSlots
        if numUsedSlots < numSlots then
            self.freeSlotsLabel:SetText(zo_strformat(SI_INVENTORY_BACKPACK_REMAINING_SPACES, numUsedSlots, numSlots))
        else
            self.freeSlotsLabel:SetText(zo_strformat(SI_INVENTORY_BACKPACK_COMPLETELY_FULL, numUsedSlots, numSlots))
        end
    end
end
function ZO_HousingFurnitureList:InitializeThemeSelector()
    --Override
end
function ZO_HousingFurnitureList:PreviewMarketProductPlacement(marketProductData)
    if not marketProductData then
        return
    end
    
    self:ClearSelection()
    if HousingEditorRequestMarketProductPlacementPreview(marketProductData.marketProductId) == HOUSING_REQUEST_RESULT_SUCCESS then
        HOUSING_EDITOR_SHARED:SetCurrentPreviewMarketProduct(marketProductData)
    end
end
function ZO_HousingFurnitureList:RestoreMarketProductPreview()
    local marketProductData = HOUSING_EDITOR_SHARED:GetCurrentPreviewMarketProduct()
    if marketProductData then
        HOUSING_EDITOR_SHARED:ClearCurrentPreviewMarketProduct()
        ZO_ScrollList_SelectData(self:GetList(), marketProductData)
    end
end
--
--[[ ZO_HousingSettingsList ]]--
--
ZO_HousingSettingsList = ZO_SocialListKeyboard:Subclass()
function ZO_HousingSettingsList:New(...)
    return ZO_SocialListKeyboard.New(self, ...)
end
function ZO_HousingSettingsList:Initialize(userGroup, control, owner, rowDataType, rowTemplate)
    ZO_SocialListKeyboard.Initialize(self, control)
    self.userGroup = userGroup
    self.owner = owner
    self.rowDataType = rowDataType
    self.rowTemplate = rowTemplate
    self.masterList = {}
    self:SetEmptyText(GetString(SI_GAMEPAD_HOUSING_PERMISSIONS_NO_ENTRIES))
    self.sortFunction = function(listEntry1, listEntry2) return self:CompareEntries(listEntry1, listEntry2) end
    ZO_ScrollList_AddDataType(self.list, rowDataType, rowTemplate, 30, function(control, data) self:SetupRow(control, data) end)
    ZO_ScrollList_EnableHighlight(self.list, "ZO_ThinListHighlight")
end
function ZO_HousingSettingsList:ColorRow(control, data, mouseIsOver)
    local textColor, iconColor = self:GetRowColors(data, mouseIsOver)
    ZO_SocialList_ColorRow(control, data, textColor, iconColor, textColor)
    if data.permissionPresetName then
        local permissions = GetControl(control, "Permissions")
        permissions:SetColor(iconColor:UnpackRGBA())
    end
end
function ZO_HousingSettingsList:SetActive(hidden)
    self.control:SetHidden(hidden)
end
function ZO_HousingSettingsList:SetupRow(control, data)
    ZO_SortFilterList.SetupRow(self, control, data)
    local displayName = GetControl(control, "DisplayName")
    local permissions = GetControl(control, "Permissions")
    if displayName then
        displayName:SetText(ZO_FormatUserFacingDisplayName(data.displayName))
    end
    if permissions then
        permissions:SetText(data.permissionPresetName)
    end
    control.panel = self
end
function ZO_HousingSettingsList:SortScrollList()
    if self.currentSortKey ~= nil and self.currentSortOrder ~= nil then
        local scrollData = ZO_ScrollList_GetDataList(self.list)
        table.sort(scrollData, self.sortFunction)
    end
    self:RefreshVisible()
end
function ZO_HousingSettingsList:CompareEntries(listEntry1, listEntry2)
    return ZO_TableOrderingFunction(listEntry1.data, listEntry2.data, self.currentSortKey, ZO_HOUSING_SETTINGS_LIST_ENTRY_SORT_KEYS, self.currentSortOrder)
end
function ZO_HousingSettingsList:FilterScrollList()
    ZO_HousingSettings_FilterScrollList(self.list, self.masterList, self.rowDataType)
end
function ZO_HousingSettingsList:GetUserGroup()
    return self.userGroup
end
function ZO_HousingSettingsList_CreateOccupantScrollData(displayName, currentHouse, index)
    return { 
                displayName = displayName, 
                index = index,
                currentHouse = currentHouse, 
                online = true, -- Assumed because this player is currently occupying this house.
           }
end
function ZO_HousingSettingsList_CreateScrollData(displayName, currentHouse, userGroup, index, permissionPresetName)
    return { 
                displayName = displayName, 
                userGroup = userGroup,
                index = index,
                currentHouse = currentHouse, 
                permissionPresetName = permissionPresetName,
                online = true, -- since we are using this data in a social list, and we don't know the status of the individual or guild, we are default to true so that the text is properly colorized
           }
end
function ZO_HousingSettingsFilters_SetupDropdown(dropdown, includeLocationFilters, callback)
    local comboBox = ZO_ComboBox_ObjectFromContainer(dropdown)
    comboBox:SetFont("ZoFontWinT1")
    comboBox:SetSortsItems(false)
    comboBox:SetSpacing(4)
    comboBox:SetHeight(450)
    comboBox:EnableMultiSelect(SI_HOUSING_FURNITURE_FILTER_DROPDOWN_TEXT, zo_strformat(SI_HOUSING_FURNITURE_FILTER_DROPDOWN_TEXT, 0))
    local function SetupScrollableEntry(control, data, ...)
        data.m_dropdownObject:SetupEntry(control, data, ...)
    end
    comboBox:AddCustomEntryTemplate("ZO_HousingFurnitureBrowserFilters_ComboBoxHeaderEntry", ZO_COMBO_BOX_ENTRY_TEMPLATE_HEIGHT, SetupScrollableEntry)
    local onDropdownHidden = function()
        callback(comboBox)
    end
    -- Add Location filters starting with the subcategory entry.
    if includeLocationFilters then
        do
            local subcategoryName = GetString(SI_HOUSING_FURNITURE_LOCATION_FILTER_DROPDOWN_LABEL)
            local entry = comboBox:CreateItemEntry(subcategoryName)
            ZO_ComboBox.SetItemEntryCustomTemplate(entry, "ZO_HousingFurnitureBrowserFilters_ComboBoxHeaderEntry")
            entry.m_normalColor = ZO_SELECTED_TEXT
            comboBox:AddItem(entry)
        end
        local locationFilterEntries = {}
        for filterValue in ZO_FlagHelpers.FlagIterator(HOUSING_FURNITURE_LOCATION_FILTER_ALL * 2, HOUSING_FURNITURE_LOCATION_FILTER_ITERATION_END) do
            local filterName = zo_strformat(SI_HOUSING_FURNITURE_FILTER_LIST_ITEM_FORMATTER, GetString("SI_HOUSINGFURNITURELOCATIONFILTER", filterValue))
            local entry = comboBox:CreateItemEntry(filterName)
            entry.filterValue = filterValue
            entry.filterCategory = ZO_HOUSING_FURNITURE_FILTER_CATEGORY.LOCATION
            table.insert(locationFilterEntries, entry)
        end
        local function CompareLocationFilters(left, right)
            return left.name < right.name
        end
        table.sort(locationFilterEntries, CompareLocationFilters)
        for _, entry in ipairs(locationFilterEntries) do
            comboBox:AddItem(entry)
        end
    end
    -- Add Bound State filters starting with the subcategory entry.
    do
        local entry = comboBox:CreateItemEntry(GetString(SI_HOUSING_FURNITURE_BOUND_FILTER_DROPDOWN_LABEL))
        ZO_ComboBox.SetItemEntryCustomTemplate(entry, "ZO_HousingFurnitureBrowserFilters_ComboBoxHeaderEntry")
        entry.m_normalColor = ZO_SELECTED_TEXT
        comboBox:AddItem(entry)
    end
    for filterValue = HOUSING_FURNITURE_BOUND_FILTER_ALL + 1, HOUSING_FURNITURE_BOUND_FILTER_ITERATION_END do
        local filterName = zo_strformat(SI_HOUSING_FURNITURE_FILTER_LIST_ITEM_FORMATTER, GetString("SI_HOUSINGFURNITUREBOUNDFILTER", filterValue))
        local entry = comboBox:CreateItemEntry(filterName)
        entry.filterValue = filterValue
        entry.filterCategory = ZO_HOUSING_FURNITURE_FILTER_CATEGORY.BOUND
        comboBox:AddItem(entry)
    end
    -- Add Limit Type filters starting with the subcategory entry.
    do
        local entry = comboBox:CreateItemEntry(GetString(SI_TOOLTIP_FURNISHING_LIMIT_TYPE))
        ZO_ComboBox.SetItemEntryCustomTemplate(entry, "ZO_HousingFurnitureBrowserFilters_ComboBoxHeaderEntry")
        entry.m_normalColor = ZO_SELECTED_TEXT
        comboBox:AddItem(entry)
    end
    for limitType = HOUSING_FURNISHING_LIMIT_TYPE_ITERATION_BEGIN, HOUSING_FURNISHING_LIMIT_TYPE_ITERATION_END do
        local filterValue = ZO_HOUSING_FURNITURE_LIMIT_FILTERS[limitType + 1]
        local filterName = zo_strformat(SI_HOUSING_FURNITURE_FILTER_LIST_ITEM_FORMATTER, GetString("SI_HOUSINGFURNISHINGLIMITTYPE", limitType))
        local entry = comboBox:CreateItemEntry(filterName)
        entry.filterValue = filterValue
        entry.filterCategory = ZO_HOUSING_FURNITURE_FILTER_CATEGORY.LIMIT
        comboBox:AddItem(entry)
    end
end
    local comboBox = ZO_ComboBox_ObjectFromContainer(dropdown)
    comboBox:SetSortsItems(false)
    comboBox:SetFont("ZoFontWinT1")
    comboBox:SetSpacing(4)
    for furnitureTheme = FURNITURE_THEME_TYPE_ITERATION_BEGIN, FURNITURE_THEME_TYPE_ITERATION_END do
        if DoesFurnitureThemeShowInBrowser(furnitureTheme) then
            local themeName = GetString("SI_FURNITURETHEMETYPE", furnitureTheme)
            local entry = comboBox:CreateItemEntry(themeName, callback)
            entry.furnitureTheme = furnitureTheme
            comboBox:AddItem(entry)
        end
    end
    comboBox:SelectItemByIndex(1)
end
--
--[[ ZO_HousingSettingsOccupantList_Keyboard ]]--
--
ZO_HousingSettingsOccupantList_Keyboard = ZO_HousingSettingsList:Subclass()
function ZO_HousingSettingsOccupantList_Keyboard:New(...)
    local NO_PERMISSION_USER_GROUP = 0
    return ZO_HousingSettingsList.New(self, NO_PERMISSION_USER_GROUP, ...)
end
function ZO_HousingSettingsOccupantList_Keyboard:BuildMasterList()
    self.currentHouse = GetCurrentZoneHouseId()
end
--
--[[ ZO_HousingSettingsVisitorList_Keyboard ]]--
--
ZO_HousingSettingsVisitorList_Keyboard = ZO_HousingSettingsList:Subclass()
function ZO_HousingSettingsVisitorList_Keyboard:New(...)
    return ZO_HousingSettingsList.New(self, HOUSE_PERMISSION_USER_GROUP_INDIVIDUAL, ...)
end
function ZO_HousingSettingsVisitorList_Keyboard:BuildMasterList()
    self.currentHouse = GetCurrentZoneHouseId()
    self.numPermissions = GetNumHousingPermissions(self.currentHouse, HOUSE_PERMISSION_USER_GROUP_INDIVIDUAL)
    ZO_HousingSettings_BuildMasterList_Visitor(self.currentHouse, self.userGroup, self.numPermissions, self.masterList, ZO_HousingSettingsList_CreateScrollData)
end
function ZO_HousingSettingsVisitorList_Keyboard:GetAddUserGroupDialogTitle()
    return GetString(SI_DIALOG_TITLE_ADD_INDIVIDUAL_PERMISSION)
end
--
--[[ ZO_HousingSettingsBanList_Keyboard ]]--
--
ZO_HousingSettingsBanList_Keyboard = ZO_HousingSettingsList:Subclass()
function ZO_HousingSettingsBanList_Keyboard:New(...)
    return ZO_HousingSettingsList.New(self, HOUSE_PERMISSION_USER_GROUP_INDIVIDUAL, ...)
end
function ZO_HousingSettingsBanList_Keyboard:BuildMasterList()
    self.currentHouse = GetCurrentZoneHouseId()
    self.numPermissions = GetNumHousingPermissions(self.currentHouse, HOUSE_PERMISSION_USER_GROUP_INDIVIDUAL)
    ZO_HousingSettings_BuildMasterList_Ban(self.currentHouse, self.userGroup, self.numPermissions, self.masterList, ZO_HousingSettingsList_CreateScrollData)
end
function ZO_HousingSettingsBanList_Keyboard:GetAddUserGroupDialogTitle()
    return GetString(SI_DIALOG_TITLE_BAN_INDIVIDUAL_PERMISSION)
end
--
--[[ ZO_HousingSettingsGuildVisitorList_Keyboard ]]--
--
ZO_HousingSettingsGuildVisitorList_Keyboard = ZO_HousingSettingsList:Subclass()
function ZO_HousingSettingsGuildVisitorList_Keyboard:New(...)
    return ZO_HousingSettingsList.New(self, HOUSE_PERMISSION_USER_GROUP_GUILD, ...)
end
function ZO_HousingSettingsGuildVisitorList_Keyboard:BuildMasterList()
    self.currentHouse = GetCurrentZoneHouseId()
    self.numPermissions = GetNumHousingPermissions(self.currentHouse, HOUSE_PERMISSION_USER_GROUP_GUILD)
    ZO_HousingSettings_BuildMasterList_Visitor(self.currentHouse, self.userGroup, self.numPermissions, self.masterList, ZO_HousingSettingsList_CreateScrollData)
end
function ZO_HousingSettingsGuildVisitorList_Keyboard:GetAddUserGroupDialogTitle()
    return GetString(SI_DIALOG_TITLE_ADD_GUILD_PERMISSION)
end
--
--[[ ZO_HousingSettingsGuildBanList_Keyboard ]]--
--
ZO_HousingSettingsGuildBanList_Keyboard = ZO_HousingSettingsList:Subclass()
function ZO_HousingSettingsGuildBanList_Keyboard:New(...)
    return ZO_HousingSettingsList.New(self, HOUSE_PERMISSION_USER_GROUP_GUILD, ...)
end
function ZO_HousingSettingsGuildBanList_Keyboard:BuildMasterList()
    self.currentHouse = GetCurrentZoneHouseId()
    self.numPermissions = GetNumHousingPermissions(self.currentHouse, HOUSE_PERMISSION_USER_GROUP_GUILD)
    ZO_HousingSettings_BuildMasterList_Ban(self.currentHouse, self.userGroup, self.numPermissions, self.masterList, ZO_HousingSettingsList_CreateScrollData)
end
function ZO_HousingSettingsGuildBanList_Keyboard:GetAddUserGroupDialogTitle()
    return GetString(SI_DIALOG_TITLE_BAN_GUILD_PERMISSION)
end