Back to Home

ESO Lua File v101036

ingame/utilitywheel/assignableutilitywheel_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
--Data for hotbar categories that are supported by the assignable utility wheel. If a new category or action type is added that we want to support, this table needs to be updated
internalassert(HOTBAR_CATEGORY_MAX_VALUE == 14, "Update category data.")
internalassert(ACTION_TYPE_MAX_VALUE == 10, "Update category data.")
local SUPPORTED_HOTBAR_CATEGORY_DATA =
{
    [HOTBAR_CATEGORY_QUICKSLOT_WHEEL] = 
    {
        [ACTION_TYPE_ITEM] = true,
        [ACTION_TYPE_COLLECTIBLE] = true,
        [ACTION_TYPE_QUEST_ITEM] = true,
        [ACTION_TYPE_EMOTE] = true,
        [ACTION_TYPE_QUICK_CHAT] = true,
    },
    [HOTBAR_CATEGORY_EMOTE_WHEEL] = 
    {
        [ACTION_TYPE_EMOTE] = true,
        [ACTION_TYPE_QUICK_CHAT] = true,
    },
    [HOTBAR_CATEGORY_MEMENTO_WHEEL] =
    {
        [ACTION_TYPE_COLLECTIBLE] = true,
    },
    [HOTBAR_CATEGORY_ALLY_WHEEL] =
    {
        [ACTION_TYPE_COLLECTIBLE] = true,
    },
    [HOTBAR_CATEGORY_TOOL_WHEEL] =
    {
        [ACTION_TYPE_COLLECTIBLE] = true,
    },
}
--Fake hotbar category used to denote that the wheel is currently hidden
ZO_UTILITY_WHEEL_HOTBAR_CATEGORY_HIDDEN = -1
ZO_UTILITY_SLOT_EMPTY_STRING = GetString(SI_QUICKSLOTS_EMPTY)
ZO_UTILITY_SLOT_EMPTY_TEXTURE = "EsoUI/Art/Quickslots/quickslot_emptySlot.dds"
ZO_AssignableUtilityWheel_Shared = ZO_InitializingObject:Subclass()
--[[
The data table can support the following fields:
-hotbarCategories: Which hotbars this wheel represents. The order of the categories displayed is based off of the order of the categories here.
-numSlots: The number of slots that are in this wheel. Should match up with the size of the bar that the slots are stored in.
-startSlotIndex: The index that this wheel starts at on the hotbar(s). Example:
startSlotIndex = ACTION_BAR_FIRST_UTILITY_BAR_SLOT
-overrideShowNameLabels: Whether or not to show the names of each slot. This overrides the default behavior for all hotbar categories used in this wheel.
-By default, the emote wheel category will show name labels and the rest will not.
-showPendingIcon: Whether or not to show the icon of the item being slotted in the center of the wheel. Currently only supported for Gamepad
-showCategoryLabel: Whether nor not to show the name of the wheel currently being displayed
-includeHiddenState: Set this to true if we want one of the "Cycle Wheel" options to hide the wheel entirely
-onSelectionChangedCallback: Function called when the selected entry on the wheel changes. Currently only supported for Gamepad
-overrideGamepadTooltip: Overrides the tooltip used when an entry is selected. Currently only supported for Gamepad.
-If this field is not set, GAMEPAD_QUAD1_TOOLTIP will be used
]]
function ZO_AssignableUtilityWheel_Shared:Initialize(control, data)
    self.control = control
    self.categoryLabel = control:GetNamedChild("Category")
    if self.categoryLabel then
        self.categoryLabel:SetHidden(not data.showCategoryLabel)
    end
    self.data = data
    self.slots = {}
    self:SetupHotbarCategories(self.data.hotbarCategories)
    self:UpdateAllSlots()
end
function ZO_AssignableUtilityWheel_Shared:RegisterForEvents()
    local function OnSlotUpdated(eventCode, physicalSlot, hotbarCategory)
        if self:GetHotbarCategory() == hotbarCategory then
            local PLAY_ANIMATION = true
            self:DoSlotUpdate(physicalSlot, PLAY_ANIMATION)
        end
    end
    self.control:RegisterForEvent(EVENT_HOTBAR_SLOT_UPDATED, OnSlotUpdated)
    self.control:RegisterForEvent(EVENT_PERSONALITY_CHANGED, function()
        --This event is only relevant if this wheel supports emotes
        if self:IsActionTypeSupported(ACTION_TYPE_EMOTE) then
            self:UpdateAllSlots()
        end
    end)
end
function ZO_AssignableUtilityWheel_Shared:GetNumSlotted()
    local numSlots = self.data.numSlots
    local actionBarOffset = self.data.startSlotIndex or 0
    local numSlotted = 0
    local hotbarCategory = self:GetHotbarCategory()
    for i = actionBarOffset + 1, actionBarOffset + numSlots do
        if GetSlotType(i, hotbarCategory) ~= ACTION_TYPE_NOTHING then
            numSlotted = numSlotted + 1
        end
    end
    return numSlotted
end
function ZO_AssignableUtilityWheel_Shared:GetHotbarCategory()
    return self.hotbarCategories[self.currentHotbarCategoryIndex]
end
function ZO_AssignableUtilityWheel_Shared:UpdateAllSlots()
    if self:GetHotbarCategory() ~= ZO_UTILITY_WHEEL_HOTBAR_CATEGORY_HIDDEN then
        for physicalSlot in pairs(self.slots) do
            self:DoSlotUpdate(physicalSlot)
        end
    end
end
function ZO_AssignableUtilityWheel_Shared:CycleHotbarCategory()
    local nextHotbarCategoryIndex = self.currentHotbarCategoryIndex % self.numHotbars + 1
    if nextHotbarCategoryIndex ~= self.currentHotbarCategoryIndex then
        self.currentHotbarCategoryIndex = nextHotbarCategoryIndex
        self:RefreshHotbarCategory()
    end
end
function ZO_AssignableUtilityWheel_Shared:RefreshHotbarCategory()
    local hotbarCategory = self:GetHotbarCategory()
    if hotbarCategory == ZO_UTILITY_WHEEL_HOTBAR_CATEGORY_HIDDEN then
        self.control:SetHidden(true)
        if self.categoryLabel then
            self.categoryLabel:SetText("")
        end
    else
        self.control:SetHidden(false)
        self:UpdateAllSlots()
        if self.categoryLabel then
            local categoryName = GetString("SI_HOTBARCATEGORY", hotbarCategory)
            self.categoryLabel:SetText(categoryName)
        end
    end
end
function ZO_AssignableUtilityWheel_Shared:SetupHotbarCategories(categoryList)
    local validCategories = {}
    local numValidCategories = 0
    for _, hotbarCategory in ipairs(categoryList) do
        if SUPPORTED_HOTBAR_CATEGORY_DATA[hotbarCategory] ~= nil then
            table.insert(validCategories, hotbarCategory)
            numValidCategories = numValidCategories + 1
        end
    end
    if numValidCategories > 0 then
        if self.data.includeHiddenState then
            table.insert(validCategories, ZO_UTILITY_WHEEL_HOTBAR_CATEGORY_HIDDEN)
            numValidCategories = numValidCategories + 1
        end
        self.numHotbars = numValidCategories
        self.hotbarCategories = validCategories
        self.currentHotbarCategoryIndex = 1
        return true
    else
        internalassert(false, "No valid hotbar categories found")
        return false
    end
end
function ZO_AssignableUtilityWheel_Shared:SetHotbarCategories(hotbarCategories)
    -- We use self.data.hotbarCategories instead of self.hotbarCategories for the comparison because self.hotbarCategories includes the hidden state
    if not ZO_AreNumericallyIndexedTablesEqual(hotbarCategories, self.data.hotbarCategories) then
        if self:SetupHotbarCategories(hotbarCategories) then
            ClearCursor()
            self.data.hotbarCategories = hotbarCategories
            self:RefreshHotbarCategory()
            KEYBIND_STRIP:UpdateKeybindButtonGroup(self.keybindStripDescriptor)
        end
    end
end
function ZO_AssignableUtilityWheel_Shared:IsActionTypeSupported(actionType)
    local categoryData = SUPPORTED_HOTBAR_CATEGORY_DATA[self:GetHotbarCategory()]
    if categoryData and categoryData[actionType] then
        return true
    else
        return false
    end
end
function ZO_AssignableUtilityWheel_Shared:Activate()
    if self.categoryLabel then
        local hotbarCategory = self:GetHotbarCategory()
        if hotbarCategory ~= ZO_UTILITY_WHEEL_HOTBAR_CATEGORY_HIDDEN then
            local categoryName = GetString("SI_HOTBARCATEGORY", hotbarCategory)
            self.categoryLabel:SetText(categoryName)
        else
            self.categoryLabel:SetText("")
        end
    end
    if self:IsActionTypeSupported(ACTION_TYPE_ITEM) then
        self:UpdateAllSlots()
    end
    KEYBIND_STRIP:AddKeybindButtonGroup(self.keybindStripDescriptor)
end
function ZO_AssignableUtilityWheel_Shared:Deactivate()
    KEYBIND_STRIP:RemoveKeybindButtonGroup(self.keybindStripDescriptor)
end
function ZO_AssignableUtilityWheel_Shared:CreateSlots()
    --To be overridden
end
function ZO_AssignableUtilityWheel_Shared:DoSlotUpdate(physicalSlot, playAnimation)
    --To be overridden
end
function ZO_AssignableUtilityWheel_Shared:InitializeKeybindStripDescriptors()
    local function AlignLeftOnGamepadCenterOnKeyboard()
        if IsInGamepadPreferredMode() then
            return KEYBIND_STRIP_ALIGN_LEFT
        else
            return KEYBIND_STRIP_ALIGN_CENTER
        end
    end
    self.keybindStripDescriptor =
    {
        -- Cycle
        {
            name = GetString(SI_UTILITY_WHEEL_CYCLE_WHEEL),
            keybind = "UI_SHORTCUT_QUATERNARY",
            visible = function()
                return self.numHotbars > 1
            end,
            callback = function()
                ClearCursor()
                self:CycleHotbarCategory()
            end,
        },
    }
end