Back to Home

ESO Lua File v101036

common/gamepad/zo_gamepadparametricscrolllisttemplates.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
ZO_TABBAR_MOVEMENT_TYPES = 
{
    PAGE_FORWARD = ZO_PARAMETRIC_MOVEMENT_TYPES.LAST,
    PAGE_BACK = ZO_PARAMETRIC_MOVEMENT_TYPES.LAST + 1,
    PAGE_NAVIGATION_FAILED = ZO_PARAMETRIC_MOVEMENT_TYPES.LAST + 2
}
ZO_PARAMETRIC_SCROLL_MOVEMENT_SOUNDS =
{
    [ZO_PARAMETRIC_MOVEMENT_TYPES.MOVE_NEXT] = SOUNDS.GAMEPAD_MENU_DOWN,
    [ZO_PARAMETRIC_MOVEMENT_TYPES.MOVE_PREVIOUS] = SOUNDS.GAMEPAD_MENU_UP,
    [ZO_PARAMETRIC_MOVEMENT_TYPES.JUMP_NEXT] = SOUNDS.GAMEPAD_MENU_JUMP_DOWN,
    [ZO_PARAMETRIC_MOVEMENT_TYPES.JUMP_PREVIOUS] = SOUNDS.GAMEPAD_MENU_JUMP_UP,
    [ZO_TABBAR_MOVEMENT_TYPES.PAGE_FORWARD] = SOUNDS.GAMEPAD_PAGE_FORWARD,
    [ZO_TABBAR_MOVEMENT_TYPES.PAGE_BACK] = SOUNDS.GAMEPAD_PAGE_BACK,
    [ZO_TABBAR_MOVEMENT_TYPES.PAGE_NAVIGATION_FAILED] = SOUNDS.GAMEPAD_PAGE_NAVIGATION_FAILED,
}
local function GamepadParametricScrollListPlaySound(movementType)
    PlaySound(ZO_PARAMETRIC_SCROLL_MOVEMENT_SOUNDS[movementType])
end
--------------------------------------------
-- ZO_GamepadVerticalParametricScrollList
--------------------------------------------
ZO_GamepadVerticalParametricScrollList = ZO_ParametricScrollList:Subclass()
function ZO_GamepadVerticalParametricScrollList:New(...)
    local list = ZO_ParametricScrollList.New(self, ...)
    return list
end
function ZO_GamepadVerticalParametricScrollList:Initialize(control)
    ZO_ParametricScrollList.Initialize(self, control, PARAMETRIC_SCROLL_LIST_VERTICAL, ZO_GamepadOnDefaultScrollListActivatedChanged)
    self:SetHeaderPadding(GAMEPAD_HEADER_DEFAULT_PADDING, GAMEPAD_HEADER_SELECTED_PADDING)
    self:SetUniversalPostPadding(GAMEPAD_DEFAULT_POST_PADDING)
end
--------------------------------------------
-- ZO_GamepadVerticalItemParametricScrollList
--------------------------------------------
ZO_GamepadVerticalItemParametricScrollList = ZO_GamepadVerticalParametricScrollList:Subclass()
function ZO_GamepadVerticalItemParametricScrollList:New(control)
    local list = ZO_GamepadVerticalParametricScrollList.New(self, control)
    list:SetUniversalPostPadding(GAMEPAD_DEFAULT_POST_PADDING)
    return list
end
--------------------------------------------
-- ZO_GamepadHorizontalParametricScrollList
--------------------------------------------
ZO_GamepadHorizontalParametricScrollList = ZO_ParametricScrollList:Subclass()
function ZO_GamepadHorizontalParametricScrollList:New(control, onActivatedChangedFunction, onCommitWithItemsFunction, onClearedFunction)
    local list = ZO_ParametricScrollList.New(self, control, PARAMETRIC_SCROLL_LIST_HORIZONTAL, onActivatedChangedFunction, onCommitWithItemsFunction, onClearedFunction)
    list:SetHeaderPadding(GAMEPAD_HEADER_DEFAULT_PADDING, GAMEPAD_HEADER_SELECTED_PADDING)
    return list
end
--------------------------------------------
-- ZO_GamepadTabBarScrollList
--------------------------------------------
ZO_TABBAR_ICON_WIDTH = 50
ZO_TABBAR_ICON_HEIGHT = 50
ZO_GamepadTabBarScrollList = ZO_GamepadHorizontalParametricScrollList:Subclass()
function ZO_GamepadTabBarScrollList:New(control, leftIcon, rightIcon, onActivatedChangedFunction, onCommitWithItemsFunction, onClearedFunction)
    local list = ZO_GamepadHorizontalParametricScrollList.New(self, control, onActivatedChangedFunction, onCommitWithItemsFunction, onClearedFunction)
    list:EnableAnimation(false)
    local function CreateKeybindLabel(name, parent, anchor)
        local keybindLabel = CreateControlFromVirtual(name, parent, "ZO_ClickableKeybindLabel_Gamepad")
        keybindLabel:SetAnchor(anchor, parent, anchor)
        return keybindLabel
    end
    list.leftIcon = leftIcon or CreateKeybindLabel("$(parent)LeftIcon", control, LEFT)
    list.rightIcon = rightIcon or CreateKeybindLabel("$(parent)RightIcon", control, RIGHT)
    list:SetEntryAnchors({ BOTTOM, BOTTOM })
    list.control = control
    return list
end
function ZO_GamepadTabBarScrollList:Activate()
    KEYBIND_STRIP:AddKeybindButtonGroup(self.keybindStripDescriptor)
    ZO_GamepadHorizontalParametricScrollList.Activate(self)
end
function ZO_GamepadTabBarScrollList:Deactivate()
    KEYBIND_STRIP:RemoveKeybindButtonGroup(self.keybindStripDescriptor)
    ZO_GamepadHorizontalParametricScrollList.Deactivate(self)
end
function ZO_GamepadTabBarScrollList:InitializeKeybindStripDescriptors()
    --TODO XAR: Look into making these not narrate if there is only one tab
    local leftShoulderKeybind =
    {
        --Even though this is an ethereal keybind, the name will still be read during screen narration
        name = GetString(SI_SCREEN_NARRATION_TABBAR_PREVIOUS_KEYBIND),
        keybind = "UI_SHORTCUT_LEFT_SHOULDER",
        ethereal = true,
        narrateEthereal = true,
        etherealNarrationOrder = 0,
        callback = function()
            if self.active then
                self:MovePrevious()
            end
        end,
    }
    local rightShoulderKeybind =
    {
        --Even though this is an ethereal keybind, the name will still be read during screen narration
        name = GetString(SI_SCREEN_NARRATION_TABBAR_NEXT_KEYBIND),
        keybind = "UI_SHORTCUT_RIGHT_SHOULDER",
        ethereal = true,
        narrateEthereal = true,
        etherealNarrationOrder = 1,
        callback = function()
            if self.active then
                self:MoveNext()
            end
        end,
    }
    self.keybindStripDescriptor =
    {
        leftShoulderKeybind,
        rightShoulderKeybind,
    }
    self.leftIcon:SetKeybindButtonDescriptor(leftShoulderKeybind)
    self.rightIcon:SetKeybindButtonDescriptor(rightShoulderKeybind)
end
function ZO_GamepadTabBarScrollList:Commit(dontReselect)
    if #self.dataList > 1 then
        self.leftIcon:SetHidden(false)
        self.rightIcon:SetHidden(false)
    else
        self.leftIcon:SetHidden(true)
        self.rightIcon:SetHidden(true)
    end
    ZO_GamepadHorizontalParametricScrollList.Commit(self, dontReselect)
    self:RefreshPips()
end
function ZO_GamepadTabBarScrollList:SetPipsEnabled(enabled, divider)
    self.pipsEnabled = enabled
    if not divider then
        -- There is a default divider in the tabbar control
        divider = self.control:GetNamedChild("Divider")
    end
    if not self.pips and enabled then
        self.pips = ZO_GamepadPipCreator:New(divider)
    end
    self:RefreshPips()
end
function ZO_GamepadTabBarScrollList:RefreshPips()
    if not self.pipsEnabled then
        if self.pips then
            self.pips:RefreshPips()
        end
        return
    end
    local selectedIndex = self.targetSelectedIndex or self.selectedIndex
    local numPips = 0
    local selectedPipIndex = 0
    for i = 1,#self.dataList do
        if self.dataList[i].canSelect ~= false then
            numPips = numPips + 1
            local active = (selectedIndex == i)
            if active then
                selectedPipIndex = numPips
            end
        end
    end
    self.pips:RefreshPips(numPips, selectedPipIndex)
end
function ZO_GamepadTabBarScrollList:SetSelectedIndex(selectedIndex, allowEvenIfDisabled, forceAnimation)
    ZO_GamepadHorizontalParametricScrollList.SetSelectedIndex(self, selectedIndex, allowEvenIfDisabled, forceAnimation)
    self:RefreshPips()
end
function ZO_GamepadTabBarScrollList:MovePrevious(allowWrapping, suppressFailSound)
    local succeeded = ZO_ParametricScrollList.MovePrevious(self)
    if not succeeded and allowWrapping then
        self:SetLastIndexSelected() --Wrap
        succeeded = true
    end
    if succeeded then
        self.onPlaySoundFunction(ZO_TABBAR_MOVEMENT_TYPES.PAGE_BACK)
    elseif not suppressFailSound then
        self.onPlaySoundFunction(ZO_TABBAR_MOVEMENT_TYPES.PAGE_NAVIGATION_FAILED)
    end
    return succeeded
end
function ZO_GamepadTabBarScrollList:MoveNext(allowWrapping, suppressFailSound)
    local succeeded = ZO_ParametricScrollList.MoveNext(self)
    if not succeeded and allowWrapping then
        ZO_ParametricScrollList.SetFirstIndexSelected(self)
        succeeded = true
    end
    if succeeded then
        self.onPlaySoundFunction(ZO_TABBAR_MOVEMENT_TYPES.PAGE_FORWARD)
    elseif not suppressFailSound then
        self.onPlaySoundFunction(ZO_TABBAR_MOVEMENT_TYPES.PAGE_NAVIGATION_FAILED)
    end
    return succeeded
end
--------------------------------------------
-- ZO_GamepadVerticalParametricScrollListSubList
--------------------------------------------
-- This is a parametric scroll list meant to be embedded as an entry within another parametric scroll list.
-- The main purpose of this class is to prevent managers that create a list with these type of entries from
--having to handle the logic for switching.
local SUB_LIST_CENTER_OFFSET = -70 --for aligning the sublist and the parent list entries
ZO_GamepadVerticalParametricScrollListSubList = ZO_GamepadVerticalParametricScrollList:Subclass()
function ZO_GamepadVerticalParametricScrollListSubList:New(control, parentList, parentKeybinds, onDataChosen)
    local manager = ZO_GamepadVerticalParametricScrollList.New(self, control, parentList, parentKeybinds, onDataChosen)
    return manager
end
function ZO_GamepadVerticalParametricScrollListSubList:Initialize(control, parentList, parentKeybinds, onDataChosen)
    ZO_GamepadVerticalParametricScrollList.Initialize(self, control)
    self.parentList = parentList
    self.parentKeybinds = parentKeybinds
    self.control:SetHidden(true)
    self:SetFixedCenterOffset(SUB_LIST_CENTER_OFFSET)
end
function ZO_GamepadVerticalParametricScrollListSubList:Commit(dontReselect)
    ZO_ParametricScrollList.Commit(self, dontReselect) --no override in ZO_GamepadVerticalParametricScrollList
    --The list isn't shown yet, so we need to ensure the default selection is updated
    self:UpdateAnchors(self.targetSelectedIndex)
    --Need to do the callback for the default selection
end
function ZO_GamepadVerticalParametricScrollListSubList:CancelSelection()
    --If the list is recommitted while open, the original index may be invalid
    local indexToReturnTo = zo_clamp(self.indexOnOpen, 1, #self.dataList)
    self.targetSelectedIndex = indexToReturnTo
    self:UpdateAnchors(indexToReturnTo)
    self.onDataChosen(self:GetDataForDataIndex(indexToReturnTo))
end
function ZO_GamepadVerticalParametricScrollListSubList:InitializeKeybindStrip()
    local function OnEntered()
        self.onDataChosen(self:GetTargetData())
        self.didSelectEntry = true
        self:Deactivate()
    end
    local function OnBack()
        self:Deactivate()
    end
    self.keybindStripDescriptor = {}
    ZO_Gamepad_AddForwardNavigationKeybindDescriptors(self.keybindStripDescriptor, GAME_NAVIGATION_TYPE_BUTTON, OnEntered)
    ZO_Gamepad_AddBackNavigationKeybindDescriptors(self.keybindStripDescriptor, GAME_NAVIGATION_TYPE_BUTTON, OnBack)
    ZO_Gamepad_AddListTriggerKeybindDescriptors(self.keybindStripDescriptor, self)
end
function ZO_GamepadVerticalParametricScrollListSubList:Activate()
    self.parentList:Deactivate()
    KEYBIND_STRIP:RemoveKeybindButtonGroup(self.parentKeybinds)
    ZO_GamepadVerticalParametricScrollList.Activate(self)
    KEYBIND_STRIP:AddKeybindButtonGroup(self.keybindStripDescriptor)
    self.control:SetHidden(false)
    self.indexOnOpen = self.selectedIndex
    self.didSelectEntry = false
end
function ZO_GamepadVerticalParametricScrollListSubList:Deactivate()
    if not self.active then
        return
    end
    if self.active and not self.didSelectEntry then
        self:CancelSelection()
    end
    ZO_GamepadVerticalParametricScrollList.Deactivate(self)
    KEYBIND_STRIP:RemoveKeybindButtonGroup(self.keybindStripDescriptor)
    self.parentList:Activate()
    KEYBIND_STRIP:AddKeybindButtonGroup(self.parentKeybinds)
    self.control:SetHidden(true)
end