Back to Home

ESO Lua File v100031

pregame/charactercreate/gamepad/zo_charactercreateselector_gamepad.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
GAMEPAD_SELECTOR_STRIDE = 3
GAMEPAD_SELECTOR_IGNORE_POSITION = -1
--
-- Character Creation Generic Selector
--
ZO_CharacterCreateSelector_Gamepad = ZO_Object:Subclass()
function ZO_CharacterCreateSelector_Gamepad:New(control)
    local object = ZO_Object.New(self)
    object:Initialize(control)
    return object
end
function ZO_CharacterCreateSelector_Gamepad:Initialize(control)
    control.sliderObject = self
    self.control = control
    self.activeButtonControls = {}
    self.selectionName = control:GetNamedChild("SelectionName")
    self.highlightControl = CreateControlFromVirtual("$(parent)Highlight", control, "ZO_CharacterCreateSelectorHighlight_Gamepad")
    self.selectedControl = CreateControlFromVirtual("$(parent)Selected", control, "ZO_CharacterCreateSelectorSelected_Gamepad")
    self.showKeybind = true
    self.stride = GAMEPAD_SELECTOR_STRIDE
    self.focusEnabled = false
    self.currentHighlight = GAMEPAD_SELECTOR_IGNORE_POSITION -- we start off with no highlight because we have no controls to highlight yet
    self.lastHighlight = 1
end
function ZO_CharacterCreateSelector_Gamepad:SetActiveButtonControls(activeButtonControls)
    self.activeButtonControls = activeButtonControls
end
function ZO_CharacterCreateSelector_Gamepad:GetNumActiveButtons()
    return #self.activeButtonControls
end
function ZO_CharacterCreateSelector_Gamepad:SetHighlight(index)
    self.currentHighlight = index
    local control = self:GetCurrentButton()
    self.buttonHighlighted = control ~= nil
    local highlight = self.highlightControl
    if self.buttonHighlighted then
        highlight:SetParent(control)
        highlight:SetAnchor(CENTER, control, CENTER, 0, 0)
        local bannerText = self:GetBannerText(control)
        self.selectionName:SetText(bannerText)
    end
    highlight:SetHidden(not self.buttonHighlighted)
    local buttonInfo = self:GetButtonInfo(index)
    self:OnButtonHighlighted(buttonInfo)
end
function ZO_CharacterCreateSelector_Gamepad:GetFocusIndex()
    return self.control.sliderObject.info.index
end
function ZO_CharacterCreateSelector_Gamepad:GetSelectedIndex()
    return self.selectedPosition
end
function ZO_CharacterCreateSelector_Gamepad:UpdateButtons()
    local selectedControl = self.selectedControl
    local bannerText = nil
    for _, info in ipairs(self:GetSelectionInfo()) do
        local button = self:GetButton(info.gamepadPosition)
        if button == nil then
            -- Ignore
        elseif button:GetState() == BSTATE_PRESSED then
            -- If the button is selected
            if bannerText == nil then
                bannerText = self:GetBannerText(button)
            end
            selectedControl:SetParent(button)
            selectedControl:SetAnchor(CENTER, control, CENTER, 0, 0)
            selectedControl:SetHidden(false)
            self.selectedPosition = info.gamepadPosition
        elseif info.gamepadPosition == self.currentHighlight and self.buttonHighlighted then
            -- If we have the button highlighted (in focus)
            bannerText = self:GetBannerText(button)
        else
            -- Unselected and unhighlighted
        end
    end
    self.selectionName:SetText(bannerText)
end
function ZO_CharacterCreateSelector_Gamepad:EnableFocus(enabled)
    local nameControl = self.control:GetNamedChild("Name")
    if nameControl then
        local fontColor
        local nameFont
        if enabled then
            fontColor = ZO_SELECTED_TEXT
            nameFont = "ZoFontGamepad42"
        else
            fontColor = ZO_DISABLED_TEXT
            nameFont = "ZoFontGamepad34"
        end
        nameControl:SetColor(fontColor:UnpackRGB())
        nameControl:SetFont(nameFont)
        self.selectionName:SetColor(fontColor:UnpackRGB())
    end
    self.focusEnabled = enabled
    if enabled then
        -- if we are enabling then we need to make sure the highlight is initialized/reenabled
        local highlightIndex = self.currentHighlight
        if highlightIndex == GAMEPAD_SELECTOR_IGNORE_POSITION then
            highlightIndex = self.lastHighlight
        end
        self:SetHighlight(highlightIndex)
    else
        -- if we are disabling then we need to make sure the highlight is disabled
        -- and we need to set our selection text to the text of the selected control instead of the highlight
        self.buttonHighlighted = false
        local button = self:GetButton(self.selectedPosition)
        if button then
            local bannerText = self:GetBannerText(button)
            self.selectionName:SetText(bannerText)
        end
        self.lastHighlight = self.currentHighlight
        self:SetHighlight(GAMEPAD_SELECTOR_IGNORE_POSITION)
    end
end
function ZO_CharacterCreateSelector_Gamepad:OnPrimaryButtonPressed()
    local control = self:GetCurrentButton()
    if control then
    else
        local name = self.control and self.control:GetName() or "Unspecified"
        local numRadioButtons = self:GetNumActiveButtons()
        local errorString = string.format("ZO_CharacterCreateSelector_Gamepad:OnPrimaryButtonPressed, controlName = %s, currentHighlight = %d, lastHighlight = %d, totalButtonCount = %d", name, self.currentHighlight, self.lastHighlight, numRadioButtons)
        internalassert(false, errorString)
    end
end
function ZO_CharacterCreateSelector_Gamepad:GetButton(gamepadPosition)
    if gamepadPosition == GAMEPAD_SELECTOR_IGNORE_POSITION then
        return nil
    end
    return self.activeButtonControls[gamepadPosition]
end
function ZO_CharacterCreateSelector_Gamepad:GetCurrentButton()
    return self:GetButton(self.currentHighlight)
end
function ZO_CharacterCreateSelector_Gamepad:GetButtonInfo(gamepadPosition)
    local buttonControl = self:GetButton(gamepadPosition)
    return buttonControl and buttonControl.selectorData
end
function ZO_CharacterCreateSelector_Gamepad:MoveNext()
    local count =  self:GetNumActiveButtons() - self.currentHighlight
    local newHighlight = self.currentHighlight
    while count > 0 do
        newHighlight = math.min(newHighlight + 1, self:GetNumActiveButtons())
        if self.currentHighlight % self.stride ~= 0 and self:IsValidButtonAtIndex(newHighlight) then
            self:SetHighlight(newHighlight)
            PlaySound(SOUNDS.HOR_LIST_ITEM_SELECTED)
            break
        end
        count = count - 1
    end
end
function ZO_CharacterCreateSelector_Gamepad:MovePrevious()
    local count = self.currentHighlight - 1
    local newHighlight = self.currentHighlight
    while count > 0 do
        newHighlight = math.max(newHighlight - 1, 1)
        
        if self.currentHighlight % self.stride ~= 1 and self:IsValidButtonAtIndex(newHighlight) then
            self:SetHighlight(newHighlight)
            PlaySound(SOUNDS.HOR_LIST_ITEM_SELECTED)
            break
        end
        count = count - 1
    end
end
function ZO_CharacterCreateSelector_Gamepad:GetNearestValidIndex(index, minIndex, maxIndex)
    if not self:IsValidButtonAtIndex(index) then
        index = maxIndex
        while index > minIndex and not self:IsValidButtonAtIndex(index) do
            index = index - 1
        end
    end
    return index
end
function ZO_CharacterCreateSelector_Gamepad:IsValidButtonAtIndex(buttonIndex)
    local button = self:GetButton(buttonIndex)
    return button ~= nil
end
function ZO_CharacterCreateSelector_Gamepad:ProcessUpDownMove(move)
    local currentHighlight = self.currentHighlight
    local newHighlight = currentHighlight
    -- Button layout is similar to
    -- 1 2 3
    -- or
    -- 1 2 3
    -- 4
    -- or
    -- 1 2 3
    -- 4 5
    local maxHighlightIndex = self:GetMaxHighlightIndex()
    local lastRowLeftIndex = zo_ceil(maxHighlightIndex / self.stride) * self.stride - self.stride + 1
    if move == MOVEMENT_CONTROLLER_MOVE_NEXT then
        -- Moving Down
        if currentHighlight >= lastRowLeftIndex then
            -- If we are in the bottom row, there's no moving down
            return nil
        else
            -- Move straight down, but make sure we move down to a valid button
            local targetHighlight = currentHighlight + self.stride
            local leftmostHighlight = targetHighlight - (targetHighlight - 1) % self.stride
            local rightmostHighlight = targetHighlight
            newHighlight = self:GetNearestValidIndex(targetHighlight, leftmostHighlight, rightmostHighlight, move)
        end
    elseif move == MOVEMENT_CONTROLLER_MOVE_PREVIOUS then
        -- Moving Up
        if currentHighlight <= self.stride then
            -- If we are in the top row, there's no moving up
            return nil
        else
            -- Move straight up
            newHighlight = currentHighlight - self.stride
            if currentHighlight == maxHighlightIndex and maxHighlightIndex % self.stride == 1 then
                -- If the button is being centered in the final rows
                -- straight up needs to be offset to the right to match the same column
                newHighlight = newHighlight + zo_floor(self.stride / 2)
            end
        end
    else
        return nil
    end
    if self:IsValidButtonAtIndex(newHighlight) then
        if move == MOVEMENT_CONTROLLER_MOVE_NEXT then
            PlaySound(SOUNDS.GAMEPAD_MENU_DOWN)
        elseif move == MOVEMENT_CONTROLLER_MOVE_PREVIOUS then
            PlaySound(SOUNDS.GAMEPAD_MENU_UP)
        end
        return newHighlight
    end
    return nil
end
function ZO_CharacterCreateSelector_Gamepad:FocusUpdate(move)
    -- Up/down movement
    local newHighlight = self:ProcessUpDownMove(move)
    if newHighlight then
        self:SetHighlight(newHighlight)
        return true
    end
    return false
end
function ZO_CharacterCreateSelector_Gamepad:GetColumnFromIndex(index)
    local maxIndex = self:GetMaxHighlightIndex()
    -- If we have a set of buttons, such that there will be one button on the last row
    -- it will be centered in the middle instead of being all the way on the left
    if maxIndex % self.stride == 1 then
        if index == maxIndex then
            local centerColumnIndex = zo_ceil(self.stride / 2)
            return centerColumnIndex
        end
    end
    return (index - 1) % self.stride + 1
end
function ZO_CharacterCreateSelector_Gamepad:GetHighlightColumn()
    return self:GetColumnFromIndex(self.currentHighlight)
end
function ZO_CharacterCreateSelector_Gamepad:GetMaxHighlightIndex()
    return #self:GetSelectionInfo()
end
function ZO_CharacterCreateSelector_Gamepad:GetBannerText(control)
    -- To be overridden
end
function ZO_CharacterCreateSelector_Gamepad:SetHighlightIndexByColumn(index, moveDown)
    -- To be overridden
end
function ZO_CharacterCreateSelector_Gamepad:GetInformationTooltipStrings(buttonInfo)
    -- Optional override
    local title = ""
    local description = ""
    return title, description
end
function ZO_CharacterCreateSelector_Gamepad:OnButtonHighlighted(buttonInfo)
    if buttonInfo then
        local title, description = self:GetInformationTooltipStrings(buttonInfo)
        if title ~= "" or description ~= "" then
            GAMEPAD_CHARACTER_CREATE_MANAGER:ShowInformationTooltip(title, description)
            return
        end
    end
    GAMEPAD_CHARACTER_CREATE_MANAGER:HideInformationTooltip()
end
--
-- Character Creation Alliance
--
ZO_CharacterCreateAllianceSelector_Gamepad = ZO_CharacterCreateSelector_Gamepad:Subclass()
function ZO_CharacterCreateAllianceSelector_Gamepad:New(control)
    return ZO_CharacterCreateSelector_Gamepad.New(self, control)
end
function ZO_CharacterCreateAllianceSelector_Gamepad:GetSelectionInfo(control)
    return GAMEPAD_CHARACTER_CREATE_MANAGER.characterData:GetAllianceInfo()
end
function ZO_CharacterCreateAllianceSelector_Gamepad:GetBannerText(control)
    return zo_strformat(SI_ALLIANCE_NAME, GetAllianceName(control.defId))
end
function ZO_CharacterCreateAllianceSelector_Gamepad:SetHighlightIndexByColumn(index, moveDown)
    self:SetHighlight(index)
end
function ZO_CharacterCreateAllianceSelector_Gamepad:EnableFocus(enabled)
    if enabled then
        GAMEPAD_CHARACTER_CREATE_MANAGER:ShowLoreInfo(GAMEPAD_BUCKET_CUSTOM_CONTROL_ALLIANCE)
    else
        GAMEPAD_CHARACTER_CREATE_MANAGER:HideLoreInfo()
    end
    ZO_CharacterCreateSelector_Gamepad.EnableFocus(self, enabled)
end
--
-- Character Creation Race
--
ZO_CharacterCreateRaceSelector_Gamepad = ZO_CharacterCreateSelector_Gamepad:Subclass()
function ZO_CharacterCreateRaceSelector_Gamepad:New(...)
    return ZO_CharacterCreateSelector_Gamepad.New(self, ...)
end
function ZO_CharacterCreateRaceSelector_Gamepad:Initialize(control)
    ZO_CharacterCreateSelector_Gamepad.Initialize(self, control)
    control.preSelectedOffsetAdditionalPadding = -20
end
function ZO_CharacterCreateRaceSelector_Gamepad:IsValidButtonAtIndex(buttonIndex)
    if ZO_CharacterCreateSelector_Gamepad.IsValidButtonAtIndex(self, buttonIndex) then
        local button = self:GetButton(buttonIndex)
        return self:IsValidRaceForAlliance(button.alliance)
    else
        return false
    end
end
function ZO_CharacterCreateRaceSelector_Gamepad:IsValidRaceForAlliance(alliance)
    if alliance == 0 then
        -- If there is no alliance restriction, then it's fine
        return true
    end
    local characterMode = ZO_CHARACTERCREATE_MANAGER:GetCharacterMode()
    local selectedAlliance = CharacterCreateGetAlliance(characterMode)
    return alliance == selectedAlliance or CanPlayAnyRaceAsAnyAlliance()
end
function ZO_CharacterCreateRaceSelector_Gamepad:GetSelectionInfo(control)
    return GAMEPAD_CHARACTER_CREATE_MANAGER.characterData:GetRaceInfo()
end
function ZO_CharacterCreateRaceSelector_Gamepad:GetBannerText(control)
    local characterMode = ZO_CHARACTERCREATE_MANAGER:GetCharacterMode()
    local currentGender = CharacterCreateGetGender(characterMode)
    return zo_strformat(SI_RACE_NAME, GetRaceName(currentGender, control.defId))
end
function ZO_CharacterCreateRaceSelector_Gamepad:GetMaxHighlightIndex()
    return self.control.numButtons
end
function ZO_CharacterCreateRaceSelector_Gamepad:SetHighlightIndexByColumn(index, moveDown)
    if not moveDown then
        local currentIndex = self:GetMaxHighlightIndex()
        while currentIndex > 0 do
            if self:GetColumnFromIndex(currentIndex) == index and self:IsValidButtonAtIndex(currentIndex) then
                self:SetHighlight(currentIndex)
                return
            end
            currentIndex = currentIndex - 1
        end
    end
    self:SetHighlight(index)
end
function ZO_CharacterCreateRaceSelector_Gamepad:EnableFocus(enabled)
    if enabled then
        GAMEPAD_CHARACTER_CREATE_MANAGER:ShowLoreInfo(GAMEPAD_BUCKET_CUSTOM_CONTROL_RACE)
    else
        GAMEPAD_CHARACTER_CREATE_MANAGER:HideLoreInfo()
    end
    ZO_CharacterCreateSelector_Gamepad.EnableFocus(self, enabled)
end
function ZO_CharacterCreateRaceSelector_Gamepad:GetInformationTooltipStrings(buttonInfo)
    local title = ""
    local description = ""
    if buttonInfo and not buttonInfo.isSelectable then
        local buttonPosition = buttonInfo.gamepadPosition
        local buttonControl = self:GetButton(buttonPosition)
        if internalassert(buttonControl, "missing control for button") then
            local restrictionReason, restrictingCollectible = GetRaceRestrictionReason(buttonControl.defId)
            description = ZO_CHARACTERCREATE_MANAGER.GetOptionRestrictionString(restrictionReason, restrictingCollectible)
            if description ~= "" then
                if restrictingCollectible ~= 0 and IsCollectiblePurchasable(restrictingCollectible) then
                    description = string.format("%s\n\n%s", description, GetString(SI_CHARACTER_CREATE_RESTRICTION_COLLECTIBLE_PURCHASABLE))
                end
                title = self:GetBannerText(buttonControl)
            end
        end
    end
    return title, description
end
--
-- Character Creation Class
--
ZO_CharacterCreateClassSelector_Gamepad = ZO_CharacterCreateSelector_Gamepad:Subclass()
function ZO_CharacterCreateClassSelector_Gamepad:New(...)
    return ZO_CharacterCreateSelector_Gamepad.New(self, ...)
end
function ZO_CharacterCreateClassSelector_Gamepad:GetSelectionInfo(control)
    return GAMEPAD_CHARACTER_CREATE_MANAGER.characterData:GetClassInfo()
end
function ZO_CharacterCreateClassSelector_Gamepad:GetBannerText(control)
    local characterMode = ZO_CHARACTERCREATE_MANAGER:GetCharacterMode()
    local currentGender = CharacterCreateGetGender(characterMode)
    return zo_strformat(SI_CLASS_NAME, GetClassName(currentGender, control.defId))
end
function ZO_CharacterCreateClassSelector_Gamepad:SetHighlightIndexByColumn(index, moveDown)
    self:SetHighlight(index)
end
function ZO_CharacterCreateClassSelector_Gamepad:EnableFocus(enabled)
    if enabled then
        GAMEPAD_CHARACTER_CREATE_MANAGER:ShowLoreInfo(GAMEPAD_BUCKET_CUSTOM_CONTROL_CLASS)
    else
        GAMEPAD_CHARACTER_CREATE_MANAGER:HideLoreInfo()
    end
    ZO_CharacterCreateSelector_Gamepad.EnableFocus(self, enabled)
end
function ZO_CharacterCreateClassSelector_Gamepad:GetInformationTooltipStrings(buttonInfo)
    local title = ""
    local description = ""
    if buttonInfo and not buttonInfo.isSelectable then
        local buttonPosition = buttonInfo.gamepadPosition
        local buttonControl = self:GetButton(buttonPosition)
        if internalassert(buttonControl, "missing control for button") then
            local restrictionReason, restrictingCollectible = GetClassRestrictionReason(buttonControl.defId)
            description = ZO_CHARACTERCREATE_MANAGER.GetOptionRestrictionString(restrictionReason, restrictingCollectible)
            if description ~= "" then
                if restrictingCollectible ~= 0 and IsCollectiblePurchasable(restrictingCollectible) then
                    description = string.format("%s\n\n%s", description, GetString(SI_CHARACTER_CREATE_RESTRICTION_COLLECTIBLE_PURCHASABLE))
                end
                title = self:GetBannerText(buttonControl)
            end
        end
    end
    return title, description
end