ESO Lua File v100010

common/zo_gamepad/zo_gamepadtemplatescommon.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
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
--
-- Global Gamepad Entry Template Setup
--
local NEW_ICON_TEXTURE = "EsoUI/Art/Miscellaneous/Gamepad/gp_icon_new.dds"
local STOLEN_ICON_TEXTURE = "EsoUI/Art/Inventory/inventory_stolenItem_icon.dds"
local EQUIPPED_THIS_SLOT_TEXTURE = "EsoUI/Art/Inventory/Gamepad/gp_inventory_icon_equipped.dds"
local EQUIPPED_OTHER_SLOT_TEXTURE = "EsoUI/Art/Inventory/Gamepad/gp_inventory_icon_equipped.dds"    --same for now
local MAIL_ATTACHED_TEXTURE = "EsoUI/Art/Miscellaneous/Gamepad/check.dds"
local TRADE_ITEM_TEXTURE = "EsoUI/Art/Miscellaneous/Gamepad/check.dds" -- TODO: This will probably be a different icon.
local ACHIEVEMENT_EARNED_TEXTURE = "EsoUI/Art/Miscellaneous/Gamepad/check.dds" -- TODO: This will probably be a different icon.
local CAN_LEVEL_TEXTURE = "EsoUI/Art/MenuBar/Gamepad/gp_playerMenu_statusIcon_pointsToSpend.dds"
local UPGRADE_SKILL_TEXTURE = "EsoUI/Art/Progression/Gamepad/gp_purchase.dds"
local ASSISTED_TEXTURE = "EsoUI/Art/Journal/Gamepad/gp_trackedQuestIcon.dds"
    --icon and highlights
    control.icon = control:GetNamedChild("Icon")
    if control.icon then
        control.highlight = control.icon:GetNamedChild("Highlight")
        control.stackCountLabel = control.icon:GetNamedChild("StackCount")
    end
    control.checkBox = control:GetNamedChild("CheckBox")
    control.label = control:GetNamedChild("Label")
    control.header = control:GetNamedChild("Header")  
    --cooldown timer
    control.cooldown = control:GetNamedChild("Cooldown")
    --general item indicators
    control.statusIndicator = control:GetNamedChild("StatusIndicator")
end
    control.description = control:GetNamedChild("Description")
end
    local trait1 = control:GetNamedChild("Trait1")
    local trait2 = control:GetNamedChild("Trait2")
    local trait3 = control:GetNamedChild("Trait3")
    local trait4 = control:GetNamedChild("Trait4")
    if trait1 then 
        control.traits =
        {
            trait1,
            trait2,
            trait3,
            trait4,
        }
    end
end
    control.craftingInfo = control:GetNamedChild("CraftingInfo")
    control.selectedItems = control:GetNamedChild("Selected")
    control.unselectedItems = control:GetNamedChild("Unselected")
    control.descriptionLabel = control:GetNamedChild("DescriptionLabel")
    
    local subLabel = control:GetNamedChild("SubLabel1")
    local subLabel2 = control:GetNamedChild("SubLabel2")
    if subLabel2 then 
        control.subLabelCount = 2
        control.subLabels = {}
        table.insert(control.subLabels, subLabel)
        table.insert(control.subLabels, subLabel2)
    else
        control.subLabel = subLabel
    end
    control.numInfoLabelsUsed = 0
    control.optionEnabledIcon = control:GetNamedChild("EnabledIcon")
end
    control.barContainer = control:GetNamedChild("BarContainer")
    --skill lines
    control.rank = control:GetNamedChild("Rank")
    --abilities
    control.alert = control:GetNamedChild("Alert")
    control.lock = control:GetNamedChild("Lock")
    control.frame = control:GetNamedChild("Frame") --not sure if still needed by other menus
    control.circleFrame = control:GetNamedChild("CircleFrame")
    control.edgeFrame = control:GetNamedChild("EdgeFrame")
    control.skillRankHeader = control:GetNamedChild("SkillRankHeader")
    control.keybind = control:GetNamedChild("Keybind")
end
    control.readyForTrain = control:GetNamedChild("ReadyForTrain")
    control.spinner = control:GetNamedChild("Spinner")
    if(control.spinner ~= nil) then
        control.spinnerDecrease = control.spinner:GetNamedChild("Decrease")
        control.spinnerIncrease = control.spinner:GetNamedChild("Increase")
    end
    local dropdown = control:GetNamedChild("Dropdown")
    if(dropdown ~= nil) then
        control.dropdown = ZO_ComboBox_ObjectFromContainer(dropdown)
    end
end
--Height Computers
-------------------------------
--Resize to fit controls have a bad interaction with labels where they cannot instantly determine their height. This is a problem when the parametric
--scroll list sets up an entry and then queries its height right afterwards, before the height is resolved. For this reason, when label height is the
--determining factor for the height of an entry, we replace the GetHeight function with our own function that uses GetTextHeight (which does resolve
--instantly). The GetHeight function should be able to compute what the height of the entry will be.
do
    local function ComputeHeightFromLabel(control)
        return control.label:GetTextHeight()
    end
    end
end
do
    local function ComputeHeightFromLabelAndSubLabels(control)
        local height = control.label:GetTextHeight()
        for i = 1, control.subLabelCount do
            local subLabelControl = control:GetNamedChild("SubLabel"..i)
            if not subLabelControl:IsHidden() then
                height = height + subLabelControl:GetTextHeight()
            end
        end
        return height
    end
    end
end
--Setup Subfunctions
local function ZO_SharedGamepadEntryLabelSetup(label, data, selected)
    if label then
        if data.fontScaleOnSelection then 
            SetMenuEntryFontFace(label, selected)
        end
        label:SetText(data.text)
        local labelColor = data:GetNameColor(selected)
        if type(labelColor) == "function" then
            labelColor = labelColor(data)
        end
        label:SetColor(labelColor:UnpackRGBA())
        if ZO_ItemSlot_SetupTextUsableAndLockedColor then -- Not available pre-game.
            ZO_ItemSlot_SetupTextUsableAndLockedColor(label, data.meetsUsageRequirements)
        end
    end
end
    local GAMEPAD_DEFAULT_COOLDOWN_TEXTURE = "EsoUI/Art/Mounts/timer_icon.dds"
    if control.cooldown then
        local currentTime = GetFrameTimeMilliseconds()
        local timeOffset = currentTime - (data.timeCooldownRecorded or 0)
        local remaining = (data.cooldownRemaining or 0) - timeOffset
        local duration = (data.cooldownDuration or 0) - timeOffset
        local wasInCooldown = control.inCooldown
        control.inCooldown = (remaining > 0) and (duration > 0)
        control.cooldown:SetTexture(data.cooldownIcon or GAMEPAD_DEFAULT_COOLDOWN_TEXTURE)
        if control.inCooldown then
            if not wasInCooldown then
                control.cooldown:StartCooldown(remaining, duration, CD_TYPE_RADIAL, CD_TIME_TYPE_TIME_UNTIL, NO_LEADING_EDGE)
            end
        else
            control.cooldown:ResetCooldown()
        end
        control.cooldown:SetHidden(not control.inCooldown)
    end
end
local function ZO_SharedGamepadEntryIconSetup(icon, stackCountLabel, data, selected)
    if icon then
        if data.iconUpdateFn then
            data.iconUpdateFn()
        end
        --multi-icons control their own alpha, don't set it directly on the icon if you're using a multi-icon
        local numIcons = data:GetNumIcons()
        if data.maxIconAlpha then
            icon:SetMaxAlpha(data.maxIconAlpha)
        end
        icon:ClearIcons()
        if numIcons > 0 then
            for i = 1, numIcons do
                local iconTexture = data:GetIcon(i, selected)
                icon:AddIcon(iconTexture)
            end
            icon:Show()
            if data.iconDesaturation then
                icon:SetDesaturation(data.iconDesaturation)
            end
            if stackCountLabel then
                if data.stackCount and data.stackCount > 1 then
                    stackCountLabel:SetText(data.stackCount)
                else
                    stackCountLabel:SetText("")
                end
            end
            local r, g, b = 1, 1, 1
            if data.enabled then
                if selected and data.selectedIconTint then
                    r, g, b = data.selectedIconTint:UnpackRGBA()
                elseif (not selected) and data.unselectedIconTint then
                    r, g, b = data.unselectedIconTint:UnpackRGBA()
                end
            else
                if selected and data.selectedIconDisabledTint then
                    r, g, b = data.selectedIconDisabledTint:UnpackRGBA()
                elseif (not selected) and data.unselectedIconDisabledTint then
                    r, g, b = data.unselectedIconDisabledTint:UnpackRGBA()
                end
            end
            if data.meetsUsageRequirement == false then
                icon:SetColor(r, 0, 0, icon:GetControlAlpha())
            else 
                icon:SetColor(r, g, b, icon:GetControlAlpha())
            end
        end
    end
end
local function ZO_SharedGamepadEntryStatusIndicatorSetup(statusIndicator, data)
    if statusIndicator then
        --multi-icons control their own alpha, don't set it directly on the icon if you're using a multi-icon
        statusIndicator:ClearIcons()
        
        if data.isEquippedInCurrentCategory then
            statusIndicator:AddIcon(EQUIPPED_THIS_SLOT_TEXTURE)
        elseif data.isEquippedInAnotherCategory then
            statusIndicator:AddIcon(EQUIPPED_OTHER_SLOT_TEXTURE)
        end
        local isItemNew
        if type(data.brandNew) == "function" then
            isItemNew = data.brandNew()
        else 
            isItemNew = data.brandNew
        end
        if isItemNew and data.enabled then
            statusIndicator:AddIcon(NEW_ICON_TEXTURE)
        end
        if (data.stolen) then
            statusIndicator:AddIcon(STOLEN_ICON_TEXTURE)
        end
        if data.isMailAttached then
            statusIndicator:AddIcon(MAIL_ATTACHED_TEXTURE)
        end
        if data.isTradeItem then
            statusIndicator:AddIcon(TRADE_ITEM_TEXTURE)
        end
                
        if data.isEarnedAchievement then
            statusIndicator:AddIcon(ACHIEVEMENT_EARNED_TEXTURE)
        end
        if data.canLevel and data.canLevel() then
            statusIndicator:AddIcon(CAN_LEVEL_TEXTURE)
        end
        if data.isSkillTrainable then
            statusIndicator:AddIcon(UPGRADE_SKILL_TEXTURE)
        end
        
        if data.isAssisted then
            statusIndicator:AddIcon(ASSISTED_TEXTURE)
        end
        statusIndicator:Show()
    end
end
--NOTE: This is the beginning of the gamepad template setup refactor.
--The data received by this function is an object defined in ZO_GamepadEntryData,
--creating a new one will get you everything needed for a basic entry.
--To add further visual data you need to define a Initialize helper function
--similar to InitializeInventoryVisualData().
    control.guildName = control:GetNamedChild("GuildName")
    control.guildMaster = control:GetNamedChild("GuildMaster")
    control.membersOnline = control:GetNamedChild("MembersOnline")
    local bankIconContainer = control:GetNamedChild("BankIconContainer")
    if(bankIconContainer ~= nil) then
        control.bankIcon = bankIconContainer:GetNamedChild("Bank")
    end
    
    local heraldryIconContainer = control:GetNamedChild("HeraldryIconContainer")
    if(heraldryIconContainer ~= nil) then
        control.heraldryIcon = heraldryIconContainer:GetNamedChild("Heraldry")
    end
    
    local storeIconContainer = control:GetNamedChild("StoreIconContainer")
    if(storeIconContainer ~= nil) then
        control.tradingHouseIcon = storeIconContainer:GetNamedChild("TradingHouse")
    end
end
--
--This function is intended to only set visual information about the entryData,
--which is should have stored on it from your helper function.
--
--If you find yourself adding something specific to your new system see if it
--can be created in a generic way and added to the GamepadEntryData class.
--For instance control.craftingInfo was turned into a subLabel for
--future use by other systems and Timer/TimerOverlay was turned into control.cooldown
function ZO_SharedGamepadEntry_OnSetup(control, data, selected, reselectingDuringRebuild, enabled, active)
    
    if data.heightScaleOnSelection then
        control:SetDimensions(ZO_GAMEPAD_DEFAULT_LIST_ENTRY_WIDTH, selected and ZO_GAMEPAD_DEFAULT_LIST_ENTRY_SELECTED_HEIGHT or ZO_GAMEPAD_DEFAULT_LIST_ENTRY_HEIGHT)
    end
    if data.alphaChangeOnSelection or data.disabled then
    else
        control:SetAlpha(1)
    end
    
    
    ZO_SharedGamepadEntryIconSetup(control.icon, control.stackCountLabel, data, selected)
    if control.highlight then
        if selected and data.highlight then
            control.highlight:SetTexture(data.highlight)
        end
        control.highlight:SetHidden(not selected or not data.highlight)
    end
    if control.subLabel and data.custom then
        if not selected then
            control.subLabel:SetText(nil)
        else
            control.subLabel:SetText(data.custom)
            local labelColor = data:GetSubLabelColor(selected)
            if type(labelColor) == "function" then
                labelColor = labelColor(data)
            end
            control.subLabel:SetColor(labelColor:UnpackRGBA())
        end
    end
    if control.subLabelCount then
        local labelColor = data:GetSubLabelColor(selected)
        if type(labelColor) == "function" then
            labelColor = labelColor(data)
        end
        for i=1, control.subLabelCount do
            local label = control:GetNamedChild("SubLabel"..i)
            if label then
                local text
                if data.subLabels then
                    text = data.subLabels[i]
                end
                if (selected or data.showUnselectedSublabels) and text then
                    label:SetText(text)
                    label:SetHidden(false)
                    label:SetColor(labelColor:UnpackRGBA())
                else
                    label:SetHidden(true)
                end
            end
        end
    end
end
--[[ Global Helper Functions ]]--
GAMEPAD_HEADER_DEFAULT_PADDING = 80
GAMEPAD_HEADER_SELECTED_PADDING = -40
GAMEPAD_DEFAULT_POST_PADDING = 16
function SetDefaultColorOnLabel(label, selected)
    local r, g, b = (selected and ZO_SELECTED_TEXT or ZO_DISABLED_TEXT):UnpackRGB()
    label:SetColor(r, g, b, 1)
end
local function SetDefaultColorOnCheckbox(checkbox, selected)
    local r, g, b = (selected and ZO_SELECTED_TEXT or ZO_DISABLED_TEXT):UnpackRGB()
    ZO_CheckButtonLabel_SetTextColor(checkbox, r, g, b)
end
function SetMenuEntryFontFace(label, selected)
    label:SetFont(selected and "ZoFontGamepad42" or "ZoFontGamepad34")
end
    label:SetFont(selected and "ZoFontGamepad27" or "ZoFontGamepad20")
end
    if disabled then
        return selected and .64 or .64
    else   
        return selected and 1 or .64
    end
end
function SharedGamepadEntryTemplateSetup(control, text, pressedTexture, normalTexture, highlightTexture, selected, activated, stackCount)
    if text then
        control.label:SetText(text)
    end
    if control.label then
        SetDefaultColorOnLabel(control.label, selected)
    end
    if control.icon then
        if pressedTexture and normalTexture then
            control.icon:SetHidden(false)
            control.icon:SetTexture(selected and pressedTexture or normalTexture)
        else
            control.icon:SetHidden(true)
        end
        if control.stackCountLabel then
            if stackCount and stackCount > 1 then
                control.stackCountLabel:SetText(stackCount)
            else
                control.stackCountLabel:SetText("")
            end
        end
    end
    if control.highlight then
        if selected and highlightTexture then
            control.highlight:SetTexture(highlightTexture)
        end
        control.highlight:SetHidden(not selected or not highlightTexture)
    end
end
function ZO_GamepadMenuEntryTemplate_Setup(control, text, pressedTexture, normalTexture, highlightTexture, selected, activated, stackCount)
    SharedGamepadEntryTemplateSetup(control, text, pressedTexture, normalTexture, highlightTexture, selected, activated, stackCount)
end
    if not control.focusedChangedAnimation then
        control.focusedChangedAnimation = ANIMATION_MANAGER:CreateTimelineFromVirtual("GamepadMenuEntryFocusedAnimation", control)
    end
    
    if activated then
        control.focusedChangedAnimation:PlayForward()
    else
        control.focusedChangedAnimation:PlayBackward()
    end
end
end
-- Checkbox
    control.checkBox = control:GetNamedChild("CheckBox")
end
function ZO_GamepadCheckBoxTemplate_Setup(control, data, selected, selectedDuringRebuild, enabled, activated)
    local text = data.text
    if type(text) == "function" then
        text = text(data)
    end
    control.checkBox.toggleFunction = data.setChecked
    if data.checked ~= nil then
        local checked = data.checked
        if type(checked) == "function" then
            checked = checked(data)
        end
        if checked == true then
            ZO_CheckButton_SetChecked(control.checkBox)
        else
            ZO_CheckButton_SetUnchecked(control.checkBox)
        end
    end
end
end
    return ZO_CheckButton_IsChecked(control.checkBox)
end
-- Header Label
    control.text = control:GetNamedChild("Label")
end
function ZO_GamepadMenuHeaderTemplate_Setup(control, data, selected, selectedDuringRebuild, enabled, activated)
    -- The header can not be selected, unless explicitly overriden by the user.
    if data.canSelect == nil then
        data.canSelect = false 
    end
    -- Set the header's text. If it is a function, call it and use it's return value.
    local text = data.text or ""
    if type(text) == "function" then
        text = text(data)
    end
    if text then
        control.text:SetText(text)
    end
    -- Set the header's text color. If it is a function, call it and use it's return value.
    local color = data.color
    if type(color) == "function" then
        color = color(data)
    end
    if color then
        if type(color) == "table" then
            control.text:SetColor(unpack(color))
        else
            control.text:SetColor(color)
        end
    end
end
end
function ZO_GamepadTabBarTemplate_Setup(control, data, selected, selectedDuringRebuild, enabled, activated)
    if data.canSelect == nil then
        data.canSelect = true
    end
    ZO_GamepadMenuHeaderTemplate_Setup(control, data, selected, selectedDuringRebuild, enabled, activated)
end
--[[ Pip Code ]]--
ZO_GamepadPipCreator = ZO_Object:Subclass()
function ZO_GamepadPipCreator:New(control, drawLayer)
    local pipCreator = ZO_Object.New(self)
    pipCreator.control = control
    pipCreator.pool = ZO_ControlPool:New("ZO_GamepadTabBarPip", control)
    pipCreator.drawLayer = drawLayer
    return pipCreator
end
function ZO_GamepadPipCreator:RefreshPips(numPips, activePipIndex)
    self.pool:ReleaseAllObjects()
    if (not numPips) or (numPips == 0) then
        return
    end
    for i = 1,numPips do
        local pip = self.pool:AcquireObject()
        pip:SetParent(self.control)
        pip:SetAnchor(CENTER, self.control, CENTER, (i - 1 - (numPips - 1) / 2) * 20, 0)
        local active = (activePipIndex == i)
        if active then
            pip:SetScale(0.8)
        else
            pip:SetScale(0.6)
        end
        pip:GetNamedChild("Active"):SetHidden(not active)
        pip:GetNamedChild("Inactive"):SetHidden(active)
        if self.drawLayer then
            pip:GetNamedChild("Active"):SetDrawLayer(self.drawLayer)
            pip:GetNamedChild("Inactive"):SetDrawLayer(self.drawLayer)
        end
    end
end
function ZO_GetPlatformTemplate(baseTemplate)
    return IsInGamepadPreferredMode() and baseTemplate.."_Gamepad_Template" or baseTemplate.."_Keyboard_Template"
end