Back to Home

ESO Lua File v101044

ingame/housingeditor/keyboard/housingfurnitureretrieval_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
ZO_HousingFurnitureRetrieval_Keyboard = ZO_HousingFurnitureList:Subclass()
function ZO_HousingFurnitureRetrieval_Keyboard:New(...)
    return ZO_HousingFurnitureList.New(self, ...)
end
function ZO_HousingFurnitureRetrieval_Keyboard:Initialize(...)
    ZO_HousingFurnitureList.Initialize(self, ...)
    self.CompareRetrievableEntriesFunction = function(a, b)
        return a.data:CompareTo(b.data)
    end
end
function ZO_HousingFurnitureRetrieval_Keyboard:InitializeKeybindStrip()
    self.keybindStripDescriptor =
    {
        alignment = KEYBIND_STRIP_ALIGN_CENTER,
        {
            name = GetString(SI_HOUSING_EDITOR_MODIFY),
            keybind = "UI_SHORTCUT_PRIMARY",
            callback = function()
                local mostRecentlySelectedData = self:GetMostRecentlySelectedData()
                self:Retrieve(mostRecentlySelectedData)
            end,
            enabled = function()
                local isSelectionEmpty = self:GetMostRecentlySelectedData() == nil
                if isSelectionEmpty then
                    return false, GetString(SI_HOUSING_BROWSER_MUST_CHOOSE_TO_MODIFY)
                end
                return true
            end,
            visible = function()
                return HOUSING_EDITOR_STATE:CanLocalPlayerEditHouse()
            end
        },
        {
            name = function()
                local mostRecentlySelectedData = self:GetMostRecentlySelectedData()
                if mostRecentlySelectedData and mostRecentlySelectedData:GetDataType() == ZO_HOUSING_PATH_NODE_DATA_TYPE then
                    return GetString(SI_HOUSING_EDITOR_PATH_REMOVE_NODE)
                else
                    return GetString(SI_HOUSING_EDITOR_PUT_AWAY)
                end
            end,
            keybind = "UI_SHORTCUT_SECONDARY",
            callback = function()
                local mostRecentlySelectedData = self:GetMostRecentlySelectedData()
                if mostRecentlySelectedData:GetDataType() == ZO_RECALLABLE_HOUSING_DATA_TYPE then
                    ZO_HousingFurnitureBrowser_Base.PutAwayFurniture(mostRecentlySelectedData)
                else
                    ZO_HousingFurnitureBrowser_Base.PutAwayNode(mostRecentlySelectedData)
                end
            end,
            enabled = function()
                local isSelectionEmpty = self:GetMostRecentlySelectedData() == nil
                if isSelectionEmpty then
                    return false, GetString(SI_HOUSING_BROWSER_MUST_CHOOSE_TO_PUT_AWAY)
                end
                return true
            end,
            visible = function()
                local mostRecentlySelectedData = self:GetMostRecentlySelectedData()
                if mostRecentlySelectedData and mostRecentlySelectedData:GetDataType() == ZO_HOUSING_PATH_NODE_DATA_TYPE then
                    return HOUSING_EDITOR_STATE:CanLocalPlayerEditHouse()
                else
                    return HOUSING_EDITOR_STATE:IsLocalPlayerHouseOwner()
                end
            end,
        },
        {
            name = GetString(SI_WORLD_MAP_ACTION_SET_PLAYER_WAYPOINT),
            keybind = "UI_SHORTCUT_TERTIARY",
            callback = function()
                local mostRecentlySelectedData = self:GetMostRecentlySelectedData()
                SHARED_FURNITURE:SetPlayerWaypointTo(mostRecentlySelectedData)
            end,
            enabled = function()
                local recentlySelectedData = self:GetMostRecentlySelectedData()
                local isSelectionEmpty = recentlySelectedData == nil
                if isSelectionEmpty then
                    return false, GetString(SI_HOUSING_BROWSER_MUST_CHOOSE_TO_SET_PLAYER_WAYPOINT)
                end
                local dataType = recentlySelectedData:GetDataType()
                return dataType == ZO_RECALLABLE_HOUSING_DATA_TYPE or dataType == ZO_HOUSING_PATH_NODE_DATA_TYPE
            end
        },
        {
            name = GetString(SI_HOUSING_EDITOR_PRECISION_EDIT),
            keybind = "UI_SHORTCUT_QUINARY",
            callback = function()
                local mostRecentlySelectedData = self:GetMostRecentlySelectedData()
                self:PrecisionEdit(mostRecentlySelectedData)
            end,
            enabled = function()
                local isSelectionEmpty = self:GetMostRecentlySelectedData() == nil
                if isSelectionEmpty then
                    return false, GetString(SI_HOUSING_BROWSER_MUST_CHOOSE_TO_MODIFY)
                end
                return true
            end,
            visible = function()
                return HOUSING_EDITOR_STATE:CanLocalPlayerEditHouse()
            end
        },
        {
            name = GetString(SI_CRAFTING_EXIT_PREVIEW_MODE),
            keybind = "UI_SHORTCUT_NEGATIVE",
            callback = function()
                self:ClearSelection()
            end,
            visible = function()
                local hasSelection = self:GetMostRecentlySelectedData() ~= nil and IsCurrentlyPreviewing()
                return hasSelection
            end,
        },
        {
            name = GetString(SI_HOUSING_FURNITURE_SET_STARTING_NODE),
            keybind = "UI_SHORTCUT_QUATERNARY",
            callback = function()
                local recentlySelectedData = self:GetMostRecentlySelectedData()
                ZO_HousingFurnitureBrowser_Base.SetAsStartingNode(recentlySelectedData)
            end,
            visible = function()
                local recentlySelectedData = self:GetMostRecentlySelectedData()
                return recentlySelectedData and recentlySelectedData:GetDataType() == ZO_HOUSING_PATH_NODE_DATA_TYPE and not recentlySelectedData:IsStartingPathNode() and HOUSING_EDITOR_STATE:CanLocalPlayerEditHouse()
            end,
        },
    }
end
function ZO_HousingFurnitureRetrieval_Keyboard:InitializeFiltersSelector()
    self.retrievalFiltersDropdown = self.contents:GetNamedChild("FiltersDropdown")
    local filterValues = {}
    local function OnFiltersChanged(comboBox, entryText, entry)
        -- Initialize the filter value 'buckets' for bound and location both to the 'All' value,
        -- indicating that no filter has effectively been selected for either as a baseline.
        -- Note that the bound filterValues {0, 1, 2} are being treated as a bit mask for the
        -- purpose of this all-in-one drop down.
        filterValues[ZO_HOUSING_FURNITURE_FILTER_CATEGORY.BOUND] = HOUSING_FURNITURE_BOUND_FILTER_ALL
        filterValues[ZO_HOUSING_FURNITURE_FILTER_CATEGORY.LIMIT] = ZO_HOUSING_FURNITURE_LIMIT_TYPE_FILTER_ALL
        -- Iterate through the drop down items, adding each selected items' filterValues to their
        -- respective bound or location bucket.
        -- Because the initial 'All' value for either bucket acts as a non-selection, the addition
        -- operations occuring below are effectively expressions of the mathematical Identity property
        -- whereby 0 + x = x.
        local selectedItems = comboBox:GetSelectedItemData()
        for _, item in ipairs(selectedItems) do
            local filterCategory = item.filterCategory
            if filterCategory then
                filterValues[filterCategory] = filterValues[filterCategory] + item.filterValue
            end
        end
        -- Retrieve the cumulative bitmask for each bucket and update the retrievable filters accordingly.
        local boundFilterValue = filterValues[ZO_HOUSING_FURNITURE_FILTER_CATEGORY.BOUND]
        local limitFilterValue = filterValues[ZO_HOUSING_FURNITURE_FILTER_CATEGORY.LIMIT]
        SHARED_FURNITURE:SetRetrievableFurnitureFilters(boundFilterValue, limitFilterValue)
    end
    local EXCLUDE_LOCATION_FILTERS = false
    ZO_HousingSettingsFilters_SetupDropdown(self.retrievalFiltersDropdown, EXCLUDE_LOCATION_FILTERS, OnFiltersChanged)
end
function ZO_HousingFurnitureRetrieval_Keyboard:OnUpdateSearchResults()
    SHARED_FURNITURE:OnRetrievableFiltersChanged()
end
function ZO_HousingFurnitureRetrieval_Keyboard:AddListDataTypes()
    self.RetrievableFurnitureOnMouseClick = function(control, buttonIndex, upInside)
        if buttonIndex == MOUSE_BUTTON_INDEX_LEFT and upInside then
            ZO_ScrollList_MouseClick(self:GetList(), control)
        end
    end
    self.RetrievableFurnitureOnMouseDoubleClick = function(control, buttonIndex)
        if buttonIndex == MOUSE_BUTTON_INDEX_LEFT then
        local data = ZO_ScrollList_GetData(control)
            self:Retrieve(data)
        end
    end
    self:AddDataType(ZO_RECALLABLE_HOUSING_DATA_TYPE, "ZO_RetrievableFurnitureSlot", ZO_HOUSING_FURNITURE_LIST_ENTRY_HEIGHT, function(...) self:SetupRetrievableFurnitureRow(...) end, ZO_HousingFurnitureBrowser_Keyboard.OnHideFurnitureRow)
    self:AddDataType(ZO_HOUSING_PATH_NODE_DATA_TYPE, "ZO_RetrievableFurnitureSlot", ZO_HOUSING_FURNITURE_LIST_ENTRY_HEIGHT, function(...) self:SetupRetrievableFurnitureRow(...) end, ZO_HousingFurnitureBrowser_Keyboard.OnHideFurnitureRow)
end
function ZO_HousingFurnitureRetrieval_Keyboard:RefreshFilters()
    -- Get the current filter state.
    local boundFilters = SHARED_FURNITURE:GetRetrievableFurnitureBoundFilters()
    local limitFilters = SHARED_FURNITURE:GetRetrievableFurnitureLimitFilters()
    SHARED_FURNITURE.refreshGroups:RefreshAll("UpdateRetrievableFurniture")
    SHARED_FURNITURE:FireCallbacks("RetrievableFurnitureChanged")
    if HOUSING_EDITOR_STATE:IsHousePreview() then
        self.retrievalFiltersDropdown:SetHidden(true)
    else
        -- Update the Furniture filters to reflect the filter state.
        local filtersList = ZO_ComboBox_ObjectFromContainer(self.retrievalFiltersDropdown)
        filtersList:ClearAllSelections()
        for _, filterItem in ipairs(filtersList:GetItems()) do
            if filterItem.filterCategory == ZO_HOUSING_FURNITURE_FILTER_CATEGORY.BOUND then
                if ZO_FlagHelpers.MaskHasFlag(boundFilters, filterItem.filterValue) then
                    filtersList:SelectItem(filterItem)
                end
            elseif filterItem.filterCategory == ZO_HOUSING_FURNITURE_FILTER_CATEGORY.LIMIT then
                if ZO_FlagHelpers.MaskHasFlag(limitFilters, filterItem.filterValue) then
                    filtersList:SelectItem(filterItem)
                end
            end
        end
        self.retrievalFiltersDropdown:SetHidden(false)
    end
end
function ZO_HousingFurnitureRetrieval_Keyboard:Retrieve(data)
    if data:GetDataType() == ZO_HOUSING_PATH_NODE_DATA_TYPE then
        ZO_HousingFurnitureBrowser_Base.SelectNodeForReplacement(data)
    else
        ZO_HousingFurnitureBrowser_Base.SelectFurnitureForReplacement(data)
    end
    SCENE_MANAGER:HideCurrentScene()
end
function ZO_HousingFurnitureRetrieval_Keyboard:PrecisionEdit(data)
    if data:GetDataType() == ZO_HOUSING_PATH_NODE_DATA_TYPE then
        ZO_HousingFurnitureBrowser_Base.SelectNodeForPrecisionEdit(data)
    else
        ZO_HousingFurnitureBrowser_Base.SelectFurnitureForPrecisionEdit(data)
    end
    SCENE_MANAGER:HideCurrentScene()
end
function ZO_HousingFurnitureRetrieval_Keyboard:SetupRetrievableFurnitureRow(control, data)
    local distanceLabel = control:GetNamedChild("Distance")
    distanceLabel:SetText(zo_strformat(SI_HOUSING_BROWSER_DISTANCE_AWAY_FORMAT, data:GetDistanceFromPlayerM()))
    local directionTexture = control:GetNamedChild("Direction")
end
--Overridden from ZO_HousingFurnitureList
function ZO_HousingFurnitureRetrieval_Keyboard:OnShowing()
    ZO_HousingFurnitureList.OnShowing(self)
    self:RefreshFilters()
end
--Overridden from ZO_HousingFurnitureList
function ZO_HousingFurnitureRetrieval_Keyboard:GetCategoryTreeData()
    return SHARED_FURNITURE:GetRetrievableFurnitureCategoryTreeData()
end
--Overridden from ZO_HousingFurnitureList
function ZO_HousingFurnitureRetrieval_Keyboard:GetNoItemText()
    if SHARED_FURNITURE:DoesPlayerHaveRetrievableFurniture() then
        return GetString(SI_HOUSING_FURNITURE_NO_SEARCH_RESULTS)
    else
        return GetString(SI_HOUSING_FURNITURE_NO_RETRIEVABLE_FURNITURE)
    end
end
--Overridden from ZO_HousingFurnitureList
function ZO_HousingFurnitureRetrieval_Keyboard:CompareFurnitureEntries(a, b)
    return a:CompareTo(b)
end
--Overridden from ZO_HousingFurnitureList
function ZO_HousingFurnitureRetrieval_Keyboard:OnCategorySelected(data)
    local mostRecentlySelectedData = self:GetMostRecentlySelectedData()
    if mostRecentlySelectedData and mostRecentlySelectedData:GetDataType() == ZO_HOUSING_PATH_NODE_DATA_TYPE then
        self:ClearSelection()
    end
    ZO_HousingFurnitureList.OnCategorySelected(self, data)
end