ESO Lua File v100010

libraries/zo_templates/optionswindowtemplate.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
-- Control types used in the settings panels
OPTIONS_DROPDOWN = 1
OPTIONS_CHECKBOX = 2
OPTIONS_SECTION_TITLE = 3
OPTIONS_SLIDER = 4
OPTIONS_CUSTOM = 5
OPTIONS_HORIZONTAL_SCROLL_LIST = 6
OPTIONS_FINITE_LIST = 7
OPTIONS_INVOKE_CALLBACK = 8  --used for two special controls in gamepad pregame
local optionTypeControls =
{
    [OPTIONS_DROPDOWN] = true,
    [OPTIONS_CHECKBOX] = true,
    [OPTIONS_SLIDER] = true,
    [OPTIONS_HORIZONTAL_SCROLL_LIST] = true,
}
local function GetControlType(control)
    return control.optionsManager:GetControlTypeFromControl(control)
end
local function GetSettingFromControl(control)
    local data = control.data
    if data.GetSettingOverride then
        return data.GetSettingOverride(control)
    end
    if GetControlType(control) == OPTIONS_CHECKBOX then
        return GetSetting_Bool(data.system, data.settingId)
    end
    return GetSetting(data.system, data.settingId)
end
local function SetSettingFromControl(control, value)
    local data = control.data
    if data.SetSettingOverride then
        data.SetSettingOverride(control, value)
    end
    SetSetting(data.system, data.settingId, tostring(value))
end
SAVE_CURRENT_VALUES         = 1
DONT_SAVE_CURRENT_VALUES    = 2
    local data = control.data
    local controlType = GetControlType(control)
    return (controlType ~= nil) and (optionTypeControls[controlType] == true)
end
local ENABLED_STATE = 1
local DISABLED_STATE = .5
local activateOptionControl =
{
    [OPTIONS_DROPDOWN] =    function(control)
                                local dropdown = GetControl(control, "Dropdown")
                                ZO_ComboBox_Enable(dropdown)
                                GetControl(dropdown, "SelectedItemText"):SetAlpha(ENABLED_STATE)
                                GetControl(dropdown, "BG"):SetAlpha(ENABLED_STATE)
                                GetControl(dropdown, "OpenDropdown"):SetAlpha(ENABLED_STATE)
                            end,
    [OPTIONS_CHECKBOX] =    function(control)
                                local boxControl = GetControl(control, "Checkbox")
                                ZO_CheckButton_Enable(boxControl)
                                boxControl:SetAlpha(ENABLED_STATE)
                            end,
    [OPTIONS_SLIDER] =      function(control)
                                GetControl(control, "Slider"):SetEnabled(true)
                                GetControl(control, "SliderBackdrop"):SetAlpha(ENABLED_STATE)
                                GetControl(control, "ValueLabel"):SetAlpha(ENABLED_STATE)
                            end,
}
local deactivateOptionControl =
{
    [OPTIONS_DROPDOWN] =    function(control)
                                local dropdown = GetControl(control, "Dropdown")
                                ZO_ComboBox_Disable(dropdown)
                                GetControl(dropdown, "SelectedItemText"):SetAlpha(DISABLED_STATE)
                                GetControl(dropdown, "BG"):SetAlpha(DISABLED_STATE)
                                GetControl(dropdown, "OpenDropdown"):SetAlpha(DISABLED_STATE)
                            end,
    [OPTIONS_CHECKBOX] =    function(control)
                                local boxControl = GetControl(control, "Checkbox")
                                ZO_CheckButton_Disable(boxControl)
                                boxControl:SetAlpha(DISABLED_STATE)
                            end,
    [OPTIONS_SLIDER] =      function(control)
                                GetControl(control, "Slider"):SetEnabled(false)
                                GetControl(control, "SliderBackdrop"):SetAlpha(DISABLED_STATE)
                                GetControl(control, "ValueLabel"):SetAlpha(DISABLED_STATE)
                            end,
}
local function UpdateOptionControlState(control, updateTable, stateType)
    local data = control.data
    local controlType = GetControlType(control)
    local updateFn = updateTable[controlType]
    if updateFn then updateFn(control) end
    local nameControl = GetControl(control, "Name")
    if stateType == ENABLED_STATE then
        nameControl:SetColor(ZO_DEFAULT_ENABLED_COLOR:UnpackRGBA())
    else
        nameControl:SetColor(ZO_DEFAULT_DISABLED_COLOR:UnpackRGBA())
    end
    control.state = stateType
end
local function CheckEnableApplyButton(oldValue, currentValue)
    if oldValue ~= currentValue then
        GetControl(ZO_OptionsWindow, "ApplyButton"):SetHidden(false)
    end
end
    if control.optionsManager:IsGamepadOptions() then return end
    UpdateOptionControlState(control, activateOptionControl, ENABLED_STATE)
end
    if control.optionsManager:IsGamepadOptions() then return end
    UpdateOptionControlState(control, deactivateOptionControl, DISABLED_STATE)
end
    UpdateOptionControlState(control, active and activateOptionControl or deactivateOptionControl, active and ENABLED_STATE or DISABLED_STATE)
end
local function GetValidIndexFromCurrentChoice(valid, currentChoice)
    for i=1, #valid do
        if valid[i] == currentChoice then
            return i
        end
    end
    return -1
end
local DEFAULT_SLIDER_VALUE_STEP_PERCENT = 6.66
local updateControlFromSettings =
{
    [OPTIONS_DROPDOWN] = function(control)
                                local data = control.data
                                local currentSetting = GetSettingFromControl(control)
                                local currentChoice = tonumber(currentSetting) or currentSetting
                                local isValidNumber = type(currentChoice) == "number"
                                local dropdownControl = GetControl(control, "Dropdown")
                                local dropdown = ZO_ComboBox_ObjectFromContainer(dropdownControl)
                                if data.itemText then
                                    dropdown:SetSelectedItem(data.itemText[GetValidIndexFromCurrentChoice(data.valid, currentChoice)])
                                elseif data.valueStringPrefix and isValidNumber then
                                        dropdown:SetSelectedItem(GetString(data.valueStringPrefix, currentChoice))
                                elseif data.valueStrings then
                                    dropdown:SetSelectedItem(GetString(data.valueStrings[currentChoice]))                                
                                else
                                    dropdown:SetSelectedItem(tostring(currentChoice))
                                end
                                return currentChoice
                            end,
    [OPTIONS_HORIZONTAL_SCROLL_LIST] = function(control)
                            local data = control.data
                            local currentSetting = GetSettingFromControl(control)
                            local currentChoice = tonumber(currentSetting) or currentSetting
                            local index = 0
                            for i = 1, #data.valid do 
                                if currentChoice == data.valid[i] then
                                    index = i
                                    break
                                end
                            end
                            local allowEvenIfDisabled = true
                            local noAnimation = true
                            control.horizontalListObject:SetSelectedDataIndex(index, allowEvenIfDisabled, noAnimation)
                            return currentChoice
                        end,
    [OPTIONS_CHECKBOX] = function(control)
                                local currentChoice = GetSettingFromControl(control)
                                local checkBoxControl = GetControl(control, "Checkbox")
                                ZO_CheckButton_SetCheckState(checkBoxControl, currentChoice)
                                local mouseOverControl = WINDOW_MANAGER:GetMouseOverControl()
                                local nameControl = GetControl(control, "Name")
                                if not control.optionsManager:IsGamepadOptions() then
                                    if currentChoice then
                                        nameControl:SetColor(ZO_DEFAULT_ENABLED_COLOR:UnpackRGBA())
                                    elseif mouseOverControl == checkBoxControl or mouseOverControl == control then
                                        nameControl:SetColor(ZO_DEFAULT_DISABLED_MOUSEOVER_COLOR:UnpackRGBA())
                                    else
                                        nameControl:SetColor(ZO_DEFAULT_DISABLED_COLOR:UnpackRGBA())
                                    end
                                else
                                        local onLabel = GetControl(control, "On")
                                        local offLabel = GetControl(control, "Off")
                                        onLabel:SetColor((currentChoice and ZO_SELECTED_TEXT or ZO_DISABLED_TEXT):UnpackRGBA())
                                        offLabel:SetColor((currentChoice and ZO_DISABLED_TEXT or ZO_SELECTED_TEXT):UnpackRGBA())
                                        
                                        local selected = checkBoxControl.selected
                                        checkBoxControl:SetHidden(selected)   
                                        onLabel:SetHidden(not selected)   
                                        offLabel:SetHidden(not selected)    
                                end
                                return currentChoice
                            end,
    [OPTIONS_SLIDER] =   function(control)
                                local data = control.data
                                local currentChoice = tonumber(GetSettingFromControl(control))
                                
                                local slider = GetControl(control, "Slider")
                                --We remove the OnValueChanged handler while we set up the slider because
                                --SetMinMax, SetValue, and SetValueStep can all potentially fire the OnValueChanged event
                                --which fires a callback that will actually set whatever setting the slider is attached too.
                                slider:SetHandler("OnValueChanged", nil)
                                slider:SetMinMax(data.minValue, data.maxValue)
                                slider:SetValue(currentChoice)
                                if control.optionsManager:IsGamepadOptions() then
                                    local stepValue = (data.maxValue - data.minValue) * ((data.gamepadValueStepPercent or DEFAULT_SLIDER_VALUE_STEP_PERCENT) / 100 )
                                   slider:SetValueStep(stepValue)
                                end
                                slider:SetHandler("OnValueChanged", ZO_Options_SliderOnValueChanged)
                                local valueLabelControl = GetControl(control, "ValueLabel")
                                if data.showValue and valueLabelControl then
                                    if data.showValueFunc then
                                        valueLabelControl:SetText(data.showValueFunc(currentChoice))
                                    else
                                        local shownVal = currentChoice
                                        if data.showValueMin and data.showValueMax and data.showValueMax > data.showValueMin then
                                            local range = data.maxValue - data.minValue
                                            local percentage = (shownVal - data.minValue) / range
                                            local shownRange = data.showValueMax - data.showValueMin
                                            shownVal = data.showValueMin + percentage * shownRange
                                            shownVal = string.format("%d", shownVal)
                                        end
                                        if data.valueTextFormatter then
                                            valueLabelControl:SetText(zo_strformat(data.valueTextFormatter, shownVal))
                                        else
                                            valueLabelControl:SetText(shownVal)
                                        end
                                    end
                                end
                                return currentChoice
                            end,
}
    local data = control.data
    local controlType = GetControlType(control)
    local updateFn = updateControlFromSettings[controlType]
    local currentChoice
    
    -- If the control is inactive, activate it temporarily
    local saveCurrentState = control.state
    if saveCurrentState == DISABLED_STATE then
    end
    local previousChoice = data.currentChoice
    if updateFn then
        currentChoice = updateFn(control)
    end
    -- Restore the control's state
    if saveCurrentState == DISABLED_STATE then
    end
    -- Fire events
    if(currentChoice ~= previousChoice) then
        data.currentChoice = currentChoice
        if data.events and data.events[currentChoice] then
            CALLBACK_MANAGER:FireCallbacks(data.events[currentChoice])
        end
    end
    return currentChoice
end
-- Change the actual settings as they are changed...they are reverted if the player chooses not to save
local function OptionsDropdown_SelectChoice(control, index)
    local data = control.data    
    local oldValueString = GetSettingFromControl(control)
    
    local value = data.valid[index]
    local valueString = tostring(value)
    SetSettingFromControl(control, valueString)
    if data.mustPushApply then
        -- If this control needs to be applied, update the dropdown with the local value, because the setting hasn't been changed yet.
        local dropdownControl = GetControl(control, "Dropdown")
        local dropdown = ZO_ComboBox_ObjectFromContainer(dropdownControl)
        if data.itemText then
            dropdown:SetSelectedItem(data.itemText[index])
        elseif data.valueStringPrefix then
            dropdown:SetSelectedItem(GetString(data.valueStringPrefix, value))
        elseif data.valueStrings then
            dropdown:SetSelectedItem(GetString(data.valueStrings[value]))
        else
            dropdown:SetSelectedItem(valueString)
        end
        if data.events and data.events[value] then
            CALLBACK_MANAGER:FireCallbacks(data.events[value])
        end
        CheckEnableApplyButton(oldValueString, valueString)
    else
    end
    
    if data.mustReloadSettings then
        KEYBOARD_OPTIONS:UpdateCurrentPanelOptions(DONT_SAVE_CURRENT_VALUES)
    end
end
local function OptionsCheckBox_SelectChoice(control, boxIsChecked)
    local data = control.data
    local oldValue = GetSettingFromControl(control)
    local value = boxIsChecked
    if data.mustPushApply then
        local checkBoxControl = GetControl(control, "Checkbox")
        ZO_CheckButton_SetCheckState(checkBoxControl, boxIsChecked)
        local mouseOverControl = WINDOW_MANAGER:GetMouseOverControl()
        local nameControl = GetControl(control, "Name")
        
        if not control.optionsManager:IsGamepadOptions() then
            if boxIsChecked then
                nameControl:SetColor(ZO_DEFAULT_ENABLED_COLOR:UnpackRGBA())
            elseif mouseOverControl == checkBoxControl or mouseOverControl == control then
                nameControl:SetColor(ZO_DEFAULT_DISABLED_MOUSEOVER_COLOR:UnpackRGBA())
            else
                nameControl:SetColor(ZO_DEFAULT_DISABLED_COLOR:UnpackRGBA())
            end
        end
        if data.events and data.events[boxIsChecked] then
            CALLBACK_MANAGER:FireCallbacks(data.events[boxIsChecked])
        end
        CheckEnableApplyButton(oldValue, value)
    else
    end
    
    if data.mustReloadSettings then
        KEYBOARD_OPTIONS:UpdateCurrentPanelOptions(DONT_SAVE_CURRENT_VALUES)
    end
end
local function GetSliderOptionValues(control, value)
    local data = control.data
    local oldValueString = GetSettingFromControl(control)
    local valueFormat = data.valueFormat or "%d"
    local formattedValueString = string.format(valueFormat, value)
    local formattedValue = tonumber(formattedValueString)
    return oldValueString, formattedValueString, formattedValue
end
-- NOTE: Sliders do not support value-based events
local function OptionsSlider_SelectChoice(control, value, eventReason)
    local data = control.data
    local oldValueString, formattedValueString, formattedValue = GetSliderOptionValues(control, value)
    SetSettingFromControl(control, formattedValueString)
    if data.mustPushApply then
        GetControl(control, "Slider"):SetValue(formattedValue)
        CheckEnableApplyButton(oldValueString, formattedValueString)
    else
    end
    local valueLabelControl = GetControl(control, "ValueLabel")
    if data.showValue and valueLabelControl then
        if data.showValueFunc then
            valueLabelControl:SetText(data.showValueFunc(value))
        else
            local shownVal = formattedValue
            if data.showValueMin and data.showValueMax and data.showValueMax > data.showValueMin then
                local range = data.maxValue - data.minValue
                local percentage = (shownVal - data.minValue) / range
                local shownRange = data.showValueMax - data.showValueMin
                shownVal = data.showValueMin + percentage * shownRange
                shownVal = string.format("%d", shownVal)
            end
            if data.valueTextFormatter then
                valueLabelControl:SetText(zo_strformat(data.valueTextFormatter, shownVal))
            else
                valueLabelControl:SetText(shownVal)
            end
        end
    end
    if data.mustReloadSettings then
        KEYBOARD_OPTIONS:UpdateCurrentPanelOptions(DONT_SAVE_CURRENT_VALUES)
    end
end
    local data = control.data
    if data.onReleasedHandler then
        local oldValueString, formattedValueString, formattedValue = GetSliderOptionValues(control, value)
        if oldValueString ~= formattedValueString then
            data.onReleasedHandler(control, formattedValueString)
        end
    end
end
function ZO_Options_SliderOnValueChanged(sliderControl, value, eventReason)
    OptionsSlider_SelectChoice(sliderControl:GetParent(), value, eventReason)
end
function ZO_Options_SliderOnSliderReleased(sliderControl, value)
    OptionsSlider_OnReleased(sliderControl:GetParent(), value)
end
    local data = control.data
    -- Sliders need a min/max value so verify that they are set here
    data.minValue = data.minValue or 0
    data.maxValue = data.maxValue or 1
    local slider = GetControl(control, "Slider")
    if selected ~= nil then
        slider:SetActive(selected)
    end
    data.events = nil -- Sliders don't support events
        
    if data.defaultMarker and not control.optionsManager:IsGamepadOptions() then
        local defaultMarkerControl = CreateControlFromVirtual("$(parent)DefaultMarker", slider, "ZO_Options_DefaultMarker")
        local offsetX = zo_clampedPercentBetween(data.minValue, data.maxValue, data.defaultMarker) * slider:GetWidth()
        defaultMarkerControl:SetAnchor(TOP, slider, LEFT, offsetX + .25, 6)
        defaultMarkerControl:SetHandler("OnClicked", function(self, button)
            PlaySound(SOUNDS.SINGLE_SETTING_RESET_TO_DEFAULT)
            slider:SetValue(data.defaultMarker)
            ZO_Options_SliderOnValueChanged(slider, slider:GetValue())
        end)
    end
end
    local data = control.data
    local dropdownControl = GetControl(control, "Dropdown")
    local dropdown = ZO_ComboBox_ObjectFromContainer(dropdownControl)
    dropdown:ClearItems()
    dropdown.m_sortOrder = false        -- Add the valid items in the order they are added in the xml file (don't sort them)
    local optionString, optionLine
    for index = 1, #data.valid do
        if data.itemText then
            optionString = data.itemText[index]
        elseif data.valueStringPrefix then
            optionString = GetString(data.valueStringPrefix, data.valid[index])
        elseif data.valueStrings then
            optionString = GetString(data.valueStrings[data.valid[index]])
        else
            optionString = tostring(data.valid[index])
        end
        optionLine = ZO_ComboBox:CreateItemEntry(optionString, function() OptionsDropdown_SelectChoice(control, index) end)
        dropdown:AddItem(optionLine)
    end
end
    local callback = control.data.callback
    if callback then 
        callback() 
    end
end
local function OptionsScrollListSelectionChanged(selectedData, oldData, reselectingDuringRebuild)           
    if oldData ~= nil then  
        local value = selectedData.value
        local control = selectedData.parentControl
        SetSettingFromControl(control, value)
        local callback = selectedData.parentControl.data.scrollListChangedCallback
        if callback then
            callback()
        end
    end
end
    control.horizontalListObject:Clear()
    for i = 1, #control.data.valid do
        local entryData = 
        {
            text = GetString(control.data.valueStringPrefix, control.data.valid[i]),
            value = control.data.valid[i],
            parentControl = control
        }
        control.horizontalListObject:AddEntry(entryData)         
    end
    control.horizontalListObject:Commit()
    control.horizontalListObject:SetActive(selected)
end
local function CheckBoxToggleFunction(checkBoxControl, boxIsChecked)
    local control = checkBoxControl:GetParent()
    OptionsCheckBox_SelectChoice(control, boxIsChecked)
end
    local data = control.data
    local checkBoxControl = GetControl(control, "Checkbox")
end
    local nameControl = GetControl(control, "Name")
    local checkBoxControl = GetControl(control, "Checkbox")
    if checkBoxControl and nameControl then
        local currentState = checkBoxControl:GetState()
        if(currentState == BSTATE_NORMAL)
        then
            nameControl:SetColor(ZO_DEFAULT_DISABLED_MOUSEOVER_COLOR:UnpackRGBA())
        end
        checkBoxControl:SetPressedFontColor(GetInterfaceColor(INTERFACE_COLOR_TYPE_TEXT_COLORS, INTERFACE_TEXT_COLOR_HIGHLIGHT))
        checkBoxControl:SetNormalFontColor(GetInterfaceColor(INTERFACE_COLOR_TYPE_TEXT_COLORS, INTERFACE_TEXT_COLOR_HIGHLIGHT))
    end
end
    local nameControl = GetControl(control, "Name")
    local checkBoxControl = GetControl(control, "Checkbox")
    if checkBoxControl and nameControl then
        local currentState = checkBoxControl:GetState()
        if(currentState == BSTATE_NORMAL)
        then
            nameControl:SetColor(ZO_DEFAULT_DISABLED_COLOR:UnpackRGBA())
        end
        checkBoxControl:SetPressedFontColor(GetInterfaceColor(INTERFACE_COLOR_TYPE_TEXT_COLORS, INTERFACE_TEXT_COLOR_NORMAL))
        checkBoxControl:SetNormalFontColor(GetInterfaceColor(INTERFACE_COLOR_TYPE_TEXT_COLORS, INTERFACE_TEXT_COLOR_NORMAL))
    end
end
    local data = control.data
    local tooltipText = data.tooltipText
    if tooltipText ~= nil then
        if type(tooltipText) == "number" then
            tooltipText = GetString(tooltipText)
        end
        if tooltipText == "" then
            return
        end
        InitializeTooltip(InformationTooltip, control, BOTTOMLEFT, 0, -2, TOPLEFT)
        SetTooltipText(InformationTooltip, tooltipText)
    end
end
    ClearTooltip(InformationTooltip)
end