Back to Home

ESO Lua File v101050

libraries/zo_focus/gamepad/zo_gamepadfocus.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
--[[
Each entry can contain the following:
local entry =
{
control, -- Control to focus on. Can be nil.
data, -- Data associated with the focus. Can be nil.
highlight, -- Highlight texture that is alpha'ed in and out via the highlightFadeAnimation when focus is lost/received. Can be nil.
highlightFadeAnimation, -- Animation to play on a highlight texture. If nil, and highlight exists, will create a FocusAlphaFadeAnimation connected to the highlight texture
iconScaleAnimation, -- Animation to play on an icon. If nil, and entry.control.icon exists, will create a FocusIconScaleAnimation connected to entry.control.icon. If false, no animation will be created or played.
activate = function(control, data) blah() end, -- Function that is called when focused is received. If nil, defaults to control:Activate() if that function exists.
deactivate = function(control, data) blah() end, -- Function that is called when focused is lost. If nil, defaults to control:Deactivate() if that function exists.
canFocus = function(control) return true end, -- Function that returns a boolean indicating whether the control can receive focus. If nil, defaults to true.
}
--]]
--Layout consts--
ZO_GAMEPAD_FOCUS_HIGHLIGHT_INSIDE_PADDING = 4
ZO_GAMEPAD_FOCUS_HIGHLIGHT_WIDE_PADDING = ZO_GAMEPAD_FOCUS_HIGHLIGHT_INSIDE_PADDING + 5
local FOCUS_MOVEMENT_TYPES = 
{
    MOVE_NEXT = 1,
    MOVE_PREVIOUS = 2,
}
local function GamepadListPlaySound(movementType)
    if movementType == FOCUS_MOVEMENT_TYPES.MOVE_NEXT then
        PlaySound(SOUNDS.GAMEPAD_MENU_DOWN)
    elseif movementType == FOCUS_MOVEMENT_TYPES.MOVE_PREVIOUS then
        PlaySound(SOUNDS.GAMEPAD_MENU_UP)
    end
end
ZO_GamepadFocus = ZO_InitializingCallbackObject:Subclass()
--[[
Initializes a GamepadFocus with an optional movementController or direction.
If movementController is not nil, one will be created using direction. If direction
is not specified, it will default to vertical.
]]
function ZO_GamepadFocus:Initialize(control, movementController, direction)
    self.data = {}
    self.control = control
    self.index = nil
    self.savedIndex = nil
    self:InitializeMovementController(movementController, direction)
    self:SetActive(false)
    self.directionalInputEnabled = true
end
function ZO_GamepadFocus:InitializeMovementController(movementController, direction)
    self.movementController = movementController or ZO_MovementController:New(direction or MOVEMENT_CONTROLLER_DIRECTION_VERTICAL)
end
function ZO_GamepadFocus:SetActive(active, retainFocus)
    if self.active ~= active then
        self.active = active
        if self.active then
            self:SetFocusByIndex(self.savedIndex ~= 0 and self.savedIndex or 1)
            self:ValidateFocus()
            if self.directionalInputEnabled then
                DIRECTIONAL_INPUT:Activate(self, self.control)
            end
        else
            self.savedIndex = self.index
            if not retainFocus then
                self:ClearFocus()
            end
            DIRECTIONAL_INPUT:Deactivate(self)
        end
    end
end
function ZO_GamepadFocus:IsActive()
    return self.active
end
end
end
function ZO_GamepadFocus:Activate(retainFocus)
    self:SetActive(true, retainFocus)
end
function ZO_GamepadFocus:Deactivate(retainFocus)
    self:SetActive(false, retainFocus)
end
function ZO_GamepadFocus:AddEntry(entry)
    table.insert(self.data, entry)
    if not entry.highlightFadeAnimation and entry.highlight then
        entry.highlightFadeAnimation = ANIMATION_MANAGER:CreateTimelineFromVirtual("FocusAlphaFadeAnimation", entry.highlight)
    end
    if entry.control and entry.control.icon and entry.iconScaleAnimation == nil then
        entry.iconScaleAnimation = ANIMATION_MANAGER:CreateTimelineFromVirtual("FocusIconScaleAnimation", entry.control.icon)
    end
    if entry.highlightFadeAnimation then
        if entry.highlight then
            entry.highlight:SetHidden(false)
        end
        entry.highlightFadeAnimation:PlayInstantlyToStart()
    end
    if entry.iconScaleAnimation then
        entry.iconScaleAnimation:PlayInstantlyToStart()
    end
end
local function DefaultEqualityFunction(item, value)
    return value.control == item
end
function ZO_GamepadFocus:RemoveMatchingEntries(compareItem, equalityFunction)
    if not equalityFunction then
    end
    local focus = self:GetFocus()
    local shouldUpdateFocus = false
    for k, v in ipairs(self.data) do
        if equalityFunction(compareItem, v) then
            if focus and k <= focus then
                self:ClearFocus()
                shouldUpdateFocus = true
                -- k == focus is a special case
                if k < focus then
                    focus = focus - 1
                end
            end
            table.remove(self.data, k)
        end
    end
    if shouldUpdateFocus then
        self:SetFocusByIndex(zo_clamp(focus, 1, #self.data))
    end
end
function ZO_GamepadFocus:RemoveAllEntries()
    self:ClearFocus()
    for k in ipairs(self.data) do
        self.data[k] = nil
    end
    self.savedIndex = nil
end
local function EnableFocus(data, index)
    if index and #data > 0 and index <= #data then
        local item = data[index]
        if item.activate then
            item.activate(item.control, item.data)
        elseif item.control and (item.control.Activate ~= nil) then
            item.control:Activate()
        end
        if item.highlightFadeAnimation then
            item.highlightFadeAnimation:PlayForward()
        end
        if item.iconScaleAnimation then
            item.iconScaleAnimation:PlayForward()
        end
        return true
    end
end
local function DisableFocus(data, index, noAnimations)
    if index and #data > 0 and (index <= #data) then
        local item = data[index]
        if item.deactivate then
            item.deactivate(item.control, item.data)
        elseif item.control and (item.control.Deactivate ~= nil) then
            item.control:Deactivate()
        end
        if item.highlightFadeAnimation then
            if noAnimations then
                item.highlightFadeAnimation:PlayInstantlyToStart()
            else
                item.highlightFadeAnimation:PlayBackward()
            end
        end
        if item.iconScaleAnimation then
            if noAnimations then
                item.iconScaleAnimation:PlayInstantlyToStart()
            else
                item.iconScaleAnimation:PlayBackward()
            end
        end
        return true
    end
end
function ZO_GamepadFocus:GetFocusItem(includeSavedFocus)
    local focusIndex = self:GetFocus(includeSavedFocus)
    return self:GetItem(focusIndex)
end
function ZO_GamepadFocus:GetItem(index)
    if index then
        return self.data[index]
    end
    return nil
end
function ZO_GamepadFocus:GetItemCount()
    return #self.data
end
function ZO_GamepadFocus:GetNarrationText()
    local focusItem = self:GetFocusItem()
    if focusItem and focusItem.narrationText then
        return focusItem.narrationText(focusItem)
    end
end
function ZO_GamepadFocus:GetAdditionalInputNarrationFunction()
    local focusItem = self:GetFocusItem()
    if focusItem then
        return focusItem.additionalInputNarrationFunction
    end
end
function ZO_GamepadFocus:GetHeaderNarration()
    local focusItem = self:GetFocusItem()
    if focusItem and focusItem.headerNarrationFunction then
        return focusItem.headerNarrationFunction()
    end
end
function ZO_GamepadFocus:GetSubHeaderNarration()
    local focusItem = self:GetFocusItem()
    if focusItem and focusItem.subHeaderNarrationFunction then
        return focusItem.subHeaderNarrationFunction(focusItem)
    end
end
function ZO_GamepadFocus:GetFooterNarration()
    local focusItem = self:GetFocusItem()
    if focusItem and focusItem.footerNarrationFunction then
        return focusItem.footerNarrationFunction()
    end
end
function ZO_GamepadFocus:IsFocused(control)
    local isControlFocused = false
    local focusItem = self:GetFocusItem()
    if focusItem and focusItem.control and focusItem.control == control then
        isControlFocused = true
    end
    return isControlFocused
end
function ZO_GamepadFocus:SetFocusToMatchingEntry(compareItem, equalityFunction)
    local didSetFocus
    if not equalityFunction then
    end
    local focus = self:GetFocus()
    local shouldUpdateFocus = false
    for k, v in ipairs(self.data) do
        if equalityFunction(compareItem, v) then
            self:SetFocusByIndex(k)
            didSetFocus = true
            break
        end
    end
    return didSetFocus
end
function ZO_GamepadFocus:SetFocusToFirstEntry(setIfInactive)
    self:SetFocusByIndex(1, setIfInactive)
end
function ZO_GamepadFocus:SetFocusByIndex(newIndex, setIfInactive)
    if self.index then
        local oldIndex = self.index
        self.index = nil -- Set to nil before calling DisableFocus() to guard against recursion.
        DisableFocus(self.data, oldIndex)
    end
    -- DisableFocus() could have triggered a SetFocus(), so we need to check whether self.index is nil before enabling focus again.
    if newIndex and not self.index then
        if (not setIfInactive) and (not self.active) then
            self.savedIndex = newIndex
        elseif EnableFocus(self.data, newIndex) then
            -- EnableFocus() could have triggered a SetFocus, so we need to check self.index again.
            if not self.index then
                self.index = newIndex
                self.savedIndex = newIndex -- Needed if setIfInactive so that activate "restores" focus properly.
            end
        end
    end
    if self.onFocusChangedFunction then
    end
end
function ZO_GamepadFocus:SetSelectedIndex(newIndex, setIfInactive)
    self:SetFocusByIndex(newIndex, setIfInactive)
end
function ZO_GamepadFocus:GetFocus(includeSavedFocus)
    if self.active then
        return self.index
    elseif includeSavedFocus then
        return self.savedIndex
    end
end
function ZO_GamepadFocus:ClearFocus()
    if self.index then
        local oldIndex = self.index
        self.index = nil
        local DISABLE_ANIMATIONS = true
        DisableFocus(self.data, oldIndex, DISABLE_ANIMATIONS)
    end
    if self.onFocusChangedFunction then
    end
end
local function FindPrevFocusIndex(oldIndex, focusItems)
    if not oldIndex then
        return nil
    end
    local newIndex = oldIndex - 1
    while newIndex >= 1 do
        local data = focusItems[newIndex]
        if not data.canFocus or data.canFocus(data.control) then
            return newIndex
        end
        newIndex = newIndex - 1
    end
end
local function FindNextFocusIndex(oldIndex, focusItems)
    if not oldIndex then
        return nil
    end
    local newIndex = oldIndex + 1
    while newIndex <= #focusItems do
        local data = focusItems[newIndex]
        if not data.canFocus or data.canFocus(data.control) then
            return newIndex
        end
        newIndex = newIndex + 1
    end
end
function ZO_GamepadFocus:MovePrevious()
    local index = FindPrevFocusIndex(self.index, self.data)
    if index then
        self:SetFocusByIndex(index)
        self.onPlaySoundFunction(FOCUS_MOVEMENT_TYPES.MOVE_PREVIOUS)
        return true
    else
        if self.onLeaveFocusAtBeginningFunction then
            self.onLeaveFocusAtBeginningFunction()
        end
    end
    return false
end
function ZO_GamepadFocus:MoveNext()
    local index = FindNextFocusIndex(self.index, self.data)
    if index then
        self:SetFocusByIndex(index)
        self.onPlaySoundFunction(FOCUS_MOVEMENT_TYPES.MOVE_NEXT)
        return true
    end
    return false
end
 
function ZO_GamepadFocus:UpdateDirectionalInput()
    local result = self.movementController:CheckMovement()
    if result == MOVEMENT_CONTROLLER_MOVE_NEXT then
        self:MoveNext()
    elseif result == MOVEMENT_CONTROLLER_MOVE_PREVIOUS then
        self:MovePrevious()
    end
end
function ZO_GamepadFocus:SetPlaySoundFunction(fn)
end
function ZO_GamepadFocus:SetDirectionalInputEnabled(enabled)
    self.directionalInputEnabled = enabled
    if enabled then
        DIRECTIONAL_INPUT:Activate(self, self.control)
    else
        DIRECTIONAL_INPUT:Deactivate(self)
    end
end
function ZO_GamepadFocus:ValidateFocus()
    local data = self:GetFocusItem()
    --The entry that was already focused is no longer eligible for focus
    if data and data.canFocus and not data.canFocus(data.control) then
        --Try to select the previous thing
        if not self:MovePrevious() then
            --Nothing to select backward, so move forward
            if not self:MoveNext() then
                --We failed to select anything forward or backwards, so there is no valid focus
                return false
            end
        end
    end
    return true
end