Back to Home

ESO Lua File v101050

pregameandingame/zo_options/zo_sharedoptions.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
-- this table stores everything needed to setup every setting control
-- each OptionsPanel_Whatever.lua file creates a table and adds itself to this one.
ZO_SharedOptions_SettingsData  = {} 
SETTING_TYPE_CUSTOM = 5000 --this must be bigger than EsoGameDataEnums::cSettingSystemTypeSize
internalassert(SETTING_TYPE_CUSTOM > (SETTING_TYPE_MAX_VALUE + 1))
ZO_SharedOptions = ZO_InitializingObject:Subclass()
function ZO_SharedOptions:Initialize()
    self.controlTable = {}
    self.panelNames = {}
    self.isGamepadOptions = false
end
function ZO_SharedOptions:IsGamepadOptions()
    return self.isGamepadOptions
end
function ZO_SharedOptions:SaveCachedSettings()
    -- We only care about saving cached setting messages ingame
    end
end
function ZO_SharedOptions:GetControlTypeFromControl(control)
    local data = control.data
    if data.controlType == OPTIONS_FINITE_LIST then
        if self:IsGamepadOptions() then
            return OPTIONS_HORIZONTAL_SCROLL_LIST
        else
            return OPTIONS_DROPDOWN
        end
    end
    return data.controlType
end
function ZO_SharedOptions:GetControlType(controlType)
    if controlType == OPTIONS_FINITE_LIST then
        if self:IsGamepadOptions() then
            return OPTIONS_HORIZONTAL_SCROLL_LIST
        else
            return OPTIONS_DROPDOWN
        end
    end
    return controlType
end
function ZO_SharedOptions:GetTextEntry(textEntry, control)
    local text
    if type(textEntry) == "string" then
        text = textEntry
    elseif type(textEntry) == "function" then
        text = textEntry(control)
    else
        text = GetString(textEntry)
    end
    return text
end
function ZO_SharedOptions:InitializeControl(control, selected, isKeyboardControl)
    local data = control.data
    local text = self:GetTextEntry(data.text, control)
    local controlType = self:GetControlTypeFromControl(control)
    control.optionsManager = self
    if controlType == OPTIONS_SECTION_TITLE then
        control:GetNamedChild("Label"):SetText(text)
    elseif controlType == OPTIONS_DROPDOWN then
        control:GetNamedChild("Name"):SetText(text)
    elseif controlType == OPTIONS_HORIZONTAL_SCROLL_LIST then
        control:GetNamedChild("Name"):SetText(text)
        ZO_Options_SetupScrollList(control, selected)
    elseif controlType == OPTIONS_CHECKBOX then
        control:GetNamedChild("Name"):SetText(text)
    elseif controlType == OPTIONS_SLIDER then
        control:GetNamedChild("Name"):SetText(text)
        ZO_Options_SetupSlider(control, selected)
    elseif controlType == OPTIONS_INVOKE_CALLBACK  then
        ZO_Options_SetupInvokeCallback(control, selected, text)
    elseif controlType == OPTIONS_COLOR then
        control:GetNamedChild("Name"):SetText(text)
    elseif controlType == OPTIONS_CHAT_COLOR then
        control:GetNamedChild("Name"):SetText(text)
    elseif controlType == OPTIONS_CUSTOM then
        if data.customSetupFunction then
            data.customSetupFunction(control, selected)
        end
    end
    if data.onInitializeFunction then
        data.onInitializeFunction(control, isKeyboardControl)
    end
end
do
    local OPTION_CONTROL_TYPES =
    {
        [OPTIONS_DROPDOWN] = true,
        [OPTIONS_CHECKBOX] = true,
        [OPTIONS_SLIDER] = true,
        [OPTIONS_HORIZONTAL_SCROLL_LIST] = true,
        [OPTIONS_COLOR] = true,
        [OPTIONS_CHAT_COLOR] = true,
    }
    function ZO_SharedOptions:IsControlTypeAnOption(data)
        local controlType = self:GetControlType(data.controlType)
        return OPTION_CONTROL_TYPES[controlType]
    end
end
function ZO_SharedOptions:DoesSettingExist(settingData)
    local existsValueOrCallback
    if self:IsGamepadOptions() then
        existsValueOrCallback = settingData.existsOnGamepad or settingData.exists
    else
        existsValueOrCallback = settingData.exists
    end
    if existsValueOrCallback == nil then
        return true -- default is existence
    elseif type(existsValueOrCallback) == "function" then
        return existsValueOrCallback()
    else
        return existsValueOrCallback
    end
end
function ZO_SharedOptions:LoadDefaults(control, settingData)
    if self:DoesSettingExist(settingData) then
        if settingData.customResetToDefaultsFunction then
            settingData.customResetToDefaultsFunction(control, settingData)
        elseif self:IsControlTypeAnOption(settingData) then
            if not settingData.excludeFromResetToDefault then
                ResetSettingToDefault(settingData.system, settingData.settingId)
            end
        end
    end
end
function ZO_SharedOptions:GetSettingsData(panel, system, settingId)
    return ZO_SharedOptions_SettingsData[panel][system][settingId]
end
function ZO_SharedOptions.AddTableToPanel(panel, table)
    for settingType, entry in pairs(table) do
        if ZO_SharedOptions_SettingsData[panel] == nil then
            ZO_SharedOptions_SettingsData[panel] = {}
        end
        local existingEntry = ZO_SharedOptions_SettingsData[panel][settingType]
        if existingEntry then
            for settingId, settingData in pairs(entry) do
                if existingEntry[settingId] then
                    assert(false, string.format("Settings option %d shared between pregame and ingame is being duplicated in one of those guis!", GetString(settingData.text)))
                else
                    existingEntry[settingId] = settingData
                end
            end
        else
            ZO_SharedOptions_SettingsData[panel][settingType] = entry
        end
    end
end
function ZO_SharedOptions.AddTableToSystem(panel, settingType, table)
    for key, entry in pairs(table) do
        if ZO_SharedOptions_SettingsData[panel] == nil then
            ZO_SharedOptions_SettingsData[panel] = {}
        end
        if ZO_SharedOptions_SettingsData[panel][settingType] == nil then
            ZO_SharedOptions_SettingsData[panel][settingType] = {}
        end
        ZO_SharedOptions_SettingsData[panel][settingType][key] = entry
    end
end
function ZO_SharedOptions:ApplySettings(control)
    -- optional override
end
function ZO_SharedOptions:EnableApplyButton()
    -- optional override
end
function ZO_SharedOptions.GetColorOptionHighlight()
    -- optional override
end
do
    local SETTING_PANEL_DISABLES_SHARE_FEATURES =
    {
        [SETTING_PANEL_ACCOUNT] = true,
    }
    function ZO_SharedOptions.DoesPanelDisableShareFeatures(panel)
        return SETTING_PANEL_DISABLES_SHARE_FEATURES[panel] == true
    end
end