bitsquid_dt/Darktide-Mod-Framework
bitsquid_dt/Darktide-Mod-Framework
2
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Var Dump: 
dumpVar: only available in dev mode
Mailing List

[Options] Refactoring and more checks

Browse source
This commit is contained in:
Azumgi 2018-09-09 20:28:39 +03:00
parent 991e5fcbe9
commit 9ce4e9cafc
2 changed files with 292 additions and 274 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
vmf/scripts/mods/vmf/modules/core/misc.lua
View file

@ -18,3 +18,7 @@ function vmf.check_wrong_argument_type(mod, vmf_function_name, argument_name, ar
table.concat(allowed_types, "/"), argument_type) table.concat(allowed_types, "/"), argument_type)
return true return true
end end
function vmf.throw_error(error_message, ...)
error(string.format(error_message, ...), 0)
end

562
vmf/scripts/mods/vmf/modules/core/options.lua
View file

@ -4,17 +4,13 @@ local vmf = get_mod("VMF")
-- require it to be dumped to game log. -- require it to be dumped to game log.
local _unfolded_raw_widgets_data local _unfolded_raw_widgets_data
-- Saves used setting_ids for initializable mod. Is used to detect if 2 widgets use the same setting_id -- Stores used setting_ids for initializable mod. Is used to detect if 2 widgets use the same setting_id
local _defined_mod_settings local _defined_mod_settings
-- ##################################################################################################################### -- #####################################################################################################################
-- ##### Local functions ############################################################################################### -- ##### Local functions ###############################################################################################
-- ##################################################################################################################### -- #####################################################################################################################
local function throw_error(error_message, ...)
error(string.format(error_message, ...), 0)
end
-- ############################# -- #############################
-- # Default collapsed widgets # -- # Default collapsed widgets #
-- ############################# -- #############################
@ -27,7 +23,7 @@ local function initialize_collapsed_widgets(mod, collapsed_widgets)
if type(collapsed_widget_name) == "string" then if type(collapsed_widget_name) == "string" then
new_collapsed_widgets[collapsed_widget_name] = true new_collapsed_widgets[collapsed_widget_name] = true
else else
throw_error("'collapsed_widgets[%d]' is not a string", i) vmf.throw_error("'collapsed_widgets[%d]' is not a string", i)
end end
end end
@ -40,255 +36,9 @@ end
-- # Widgets data # -- # Widgets data #
-- ################ -- ################
---------------- -- ---------------------------------------------------------------------------------------------------------------------
-- VALIDATION -- -- ----| Header |-------------------------------------------------------------------------------------------------------
---------------- -- ---------------------------------------------------------------------------------------------------------------------
local function validate_generic_widget_data(data)
local setting_id = data.setting_id
if type(setting_id) ~= "string" then
vmf:dump(_unfolded_raw_widgets_data, "widgets", 1)
throw_error("[widget#%d (%s)]: 'setting_id' field is required and must have 'string' type. " ..
"See dumped table in game log for reference.", data.index, data.type)
end
if not data.localize and not data.title then
throw_error("[widget \"%s\" (%s)]: lacks 'title' field (localization is disabled)", setting_id, data.type)
end
if data.title and type(data.title) ~= "string" then
throw_error("[widget \"%s\" (%s)]: 'title' field must have 'string' type", setting_id, data.type)
end
if data.tooltip and type(data.tooltip) ~= "string" then
throw_error("[widget \"%s\" (%s)]: 'tooltip' field must have 'string' type", setting_id, data.type)
end
if _defined_mod_settings[setting_id] then
vmf:dump(_unfolded_raw_widgets_data, "widgets", 1)
throw_error("Widgets %d and %d have the same setting_id (\"%s\"). See dumped table in game log for reference.",
_defined_mod_settings[setting_id], data.index, setting_id)
else
_defined_mod_settings[setting_id] = data.index
end
end
local function validate_checkbox_data(data)
if type(data.default_value) ~= "boolean" then
throw_error("[widget \"%s\" (checkbox)]: 'default_value' field is required and must have 'boolean' type",
data.setting_id)
end
end
local allowed_dropdown_values = {
boolean = true,
string = true,
number = true
}
local function validate_dropdown_data(data)
if not allowed_dropdown_values[type(data.default_value)] then
throw_error("[widget \"%s\" (dropdown)]: 'default_value' field is required and must have 'string', " ..
"'number' or 'boolean' type", data.setting_id)
end
if type(data.options) ~= "table" then
throw_error("[widget \"%s\" (dropdown)]: 'options' field is required and must have 'table' type", data.setting_id)
end
local default_value = data.default_value
local default_value_match = false
local used_values = {}
for i, option in ipairs(data.options) do
local option_value = option.value
if type(option.text) ~= "string" then
throw_error("[widget \"%s\" (dropdown)]: 'options[%d]'-> 'text' field is required and must have 'string' type",
data.setting_id, i)
end
if not allowed_dropdown_values[type(option_value)] then
throw_error("[widget \"%s\" (dropdown)]: 'options[%d]'-> 'value' field is required and must have 'string', " ..
"'number' or 'boolean' type", data.setting_id, i)
end
if option.show_widgets and type(option.show_widgets) ~= "table" then
throw_error("[widget \"%s\" (dropdown)]: 'options[%d]'-> 'show_widgets' field must have 'table' type",
data.setting_id, i)
end
if used_values[option_value] then
throw_error("[widget \"%s\" (dropdown)]: 'options[%d]' has 'value' field set to the same value " ..
"as one of previous options", data.setting_id, i)
end
used_values[option_value] = true
if default_value == option_value then
default_value_match = true
end
end
if not default_value_match then
throw_error("[widget \"%s\" (dropdown)]: 'default_value' field contains value not defined in 'options' field",
data.setting_id)
end
end
local allowed_keybind_triggers = {
pressed = true,
released = true,
held = true
}
local allowed_keybind_types = {
action_call = true,
view_toggle = true,
mod_toggle = true
}
local allowed_special_keys = {
ctrl = true,
alt = true,
shift = true
}
local function validate_keybind_data(data)
if data.keybind_global and type(data.keybind_global) ~= "boolean" then
throw_error("[widget \"%s\" (keybind)]: 'keybind_global' field must have 'boolean' type", data.setting_id)
end
if not allowed_keybind_triggers[data.keybind_trigger] then
throw_error("[widget \"%s\" (keybind)]: 'keybind_trigger' field is required and must contain string " ..
"\"action_call\", \"view_toggle\" or \"mod_toggle\"", data.setting_id)
end
local keybind_type = data.keybind_type
if not allowed_keybind_types[keybind_type] then
throw_error("[widget \"%s\" (keybind)]: 'keybind_type' field is required and must contain string " ..
"\"pressed\", \"released\" or \"held\"", data.setting_id)
end
if keybind_type == "action_call" and type(data.action_name) ~= "string" then
throw_error("[widget \"%s\" (keybind)]: 'keybind_type' is set to \"action_call\" so 'action_name' " ..
"field is required and must have 'string' type", data.setting_id)
end
if keybind_type == "view_toggle" and type(data.view_name) ~= "string" then
throw_error("[widget \"%s\" (keybind)]: 'keybind_type' is set to \"view_toggle\" so 'view_name' " ..
"field is required and must have 'string' type", data.setting_id)
end
local default_value = data.default_value
if type(default_value) ~= "table" then
throw_error("[widget \"%s\" (keybind)]: 'default_value' field is required and must have 'table' type",
data.setting_id)
end
if #default_value > 4 then
throw_error("[widget \"%s\" (keybind)]: table stored in 'default_value' field can't exceed 4 elements",
data.setting_id)
end
if default_value[1] and (not vmf.readable_key_names[default_value[1]] or allowed_special_keys[default_value[1]]) then
throw_error("[widget \"%s\" (keybind)]: 'default_value[1]' must be a valid key name", data.setting_id)
end
if default_value[2] and not allowed_special_keys[default_value[2]] or
default_value[3] and not allowed_special_keys[default_value[3]] or
default_value[4] and not allowed_special_keys[default_value[4]]
then
throw_error("[widget \"%s\" (keybind)]: 'default_value [2], [3] and [4]' can be only strings: \"ctrl\", " ..
"\"alt\" and \"shift\" (in no particular order)", data.setting_id)
end
local used_keys = {}
for _, key in ipairs(default_value) do
if used_keys[key] then
throw_error("[widget \"%s\" (keybind)]: you can't define the same key in 'default_value' table twice",
data.setting_id)
end
used_keys[key] = true
end
end
local function validate_numeric_data(data)
if data.unit_text and type(data.unit_text) ~= "string" then
throw_error("[widget \"%s\" (numeric)]: 'unit_text' field must have 'string' type", data.setting_id)
end
if type(data.decimals_number) ~= "number" then
throw_error("[widget \"%s\" (numeric)]: 'decimals_number' field must have 'number' type", data.setting_id)
end
if data.decimals_number < 0 then -- @TODO: eventually do max cap as well
throw_error("[widget \"%s\" (numeric)]: 'decimals_number' value can't be lower than zero", data.setting_id)
end
local range = data.range
if type(range) ~= "table" then
throw_error("[widget \"%s\" (numeric)]: 'range' field is required and must have 'table' type", data.setting_id)
end
if #range ~= 2 then
throw_error("[widget \"%s\" (numeric)]: 'range' field must contain an array-like table with 2 elements",
data.setting_id)
end
local range_min = range[1]
local range_max = range[2]
if type(range_min) ~= "number" or type(range_max) ~= "number" then
throw_error("[widget \"%s\" (numeric)]: table stored in 'range' field must contain only numbers",
data.setting_id)
end
if range_min > range_max then
throw_error("[widget \"%s\" (numeric)]: 'range[2]' must be bigger than 'range[1]'", data.setting_id)
end
local default_value = data.default_value
if type(default_value) ~= "number" then
throw_error("[widget \"%s\" (numeric)]: 'default_value' field is required and must have 'number' type",
data.setting_id)
end
if default_value < range_min or default_value > range_max then
throw_error("[widget \"%s\" (numeric)]: 'default_value' field must contain number fitting set 'range'",
data.setting_id)
end
end
------------------
-- LOCALIZATION --
------------------
local function localize_generic_widget_data(mod, data)
if data.localize then
data.title = mod:localize(data.title or data.setting_id)
if data.tooltip then
data.tooltip = mod:localize(data.tooltip)
else
data.tooltip = vmf.quick_localize(mod, data.setting_id .. "_description")
end
end
end
local function localize_dropdown_data(mod, data)
local options = data.options
local localize = data.localize
if options.localize ~= nil then
localize = options.localize
end
if localize then
for _, option in ipairs(options) do
option.text = mod:localize(option.text)
end
end
end
local function localize_numeric_data(mod, data)
if data.localize and data.unit_text then
data.unit_text = mod:localize(data.unit_text)
end
end
--------------------
-- INITIALIZATION --
--------------------
local function initialize_header_data(mod, data) local function initialize_header_data(mod, data)
local new_data = {} local new_data = {}
@ -309,6 +59,52 @@ local function initialize_header_data(mod, data)
return new_data return new_data
end end
-- ---------------------------------------------------------------------------------------------------------------------
-- ----| Generic |------------------------------------------------------------------------------------------------------
-- ---------------------------------------------------------------------------------------------------------------------
local function validate_generic_widget_data(data)
local setting_id = data.setting_id
if type(setting_id) ~= "string" then
vmf:dump(_unfolded_raw_widgets_data, "widgets", 1)
vmf.throw_error("[widget#%d (%s)]: 'setting_id' field is required and must have 'string' type. " ..
"See dumped table in game log for reference.", data.index, data.type)
end
if not data.localize and not data.title then
vmf.throw_error("[widget \"%s\" (%s)]: lacks 'title' field (localization is disabled)", setting_id, data.type)
end
if data.title and type(data.title) ~= "string" then
vmf.throw_error("[widget \"%s\" (%s)]: 'title' field must have 'string' type", setting_id, data.type)
end
if data.tooltip and type(data.tooltip) ~= "string" then
vmf.throw_error("[widget \"%s\" (%s)]: 'tooltip' field must have 'string' type", setting_id, data.type)
end
if _defined_mod_settings[setting_id] then
vmf:dump(_unfolded_raw_widgets_data, "widgets", 1)
vmf.throw_error("Widgets %d and %d have the same setting_id (\"%s\"). See dumped table in game log for reference.",
_defined_mod_settings[setting_id], data.index, setting_id)
else
_defined_mod_settings[setting_id] = data.index
end
end
local function localize_generic_widget_data(mod, data)
if data.localize then
data.title = mod:localize(data.title or data.setting_id)
if data.tooltip then
data.tooltip = mod:localize(data.tooltip)
else
data.tooltip = vmf.quick_localize(mod, data.setting_id .. "_description")
end
end
end
-- The data that applies to any widget, except for header -- The data that applies to any widget, except for header
local function initialize_generic_widget_data(mod, data, localize) local function initialize_generic_widget_data(mod, data, localize)
@ -342,6 +138,9 @@ local function initialize_generic_widget_data(mod, data, localize)
return new_data return new_data
end end
-- ---------------------------------------------------------------------------------------------------------------------
-- ----| Group |--------------------------------------------------------------------------------------------------------
-- ---------------------------------------------------------------------------------------------------------------------
local function initialize_group_data(mod, data, localize, collapsed_widgets) local function initialize_group_data(mod, data, localize, collapsed_widgets)
local new_data = initialize_generic_widget_data(mod, data, localize) local new_data = initialize_generic_widget_data(mod, data, localize)
@ -351,6 +150,17 @@ local function initialize_group_data(mod, data, localize, collapsed_widgets)
return new_data return new_data
end end
-- ---------------------------------------------------------------------------------------------------------------------
-- ----| Checkbox |-----------------------------------------------------------------------------------------------------
-- ---------------------------------------------------------------------------------------------------------------------
local function validate_checkbox_data(data)
if type(data.default_value) ~= "boolean" then
vmf.throw_error("[widget \"%s\" (checkbox)]: 'default_value' field is required and must have 'boolean' type",
data.setting_id)
end
end
local function initialize_checkbox_data(mod, data, localize, collapsed_widgets) local function initialize_checkbox_data(mod, data, localize, collapsed_widgets)
local new_data = initialize_generic_widget_data(mod, data, localize) local new_data = initialize_generic_widget_data(mod, data, localize)
@ -362,6 +172,80 @@ local function initialize_checkbox_data(mod, data, localize, collapsed_widgets)
return new_data return new_data
end end
-- ---------------------------------------------------------------------------------------------------------------------
-- ----| Dropdown |-----------------------------------------------------------------------------------------------------
-- ---------------------------------------------------------------------------------------------------------------------
local allowed_dropdown_values = {
boolean = true,
string = true,
number = true
}
local function validate_dropdown_data(data)
if not allowed_dropdown_values[type(data.default_value)] then
vmf.throw_error("[widget \"%s\" (dropdown)]: 'default_value' field is required and must have 'string', " ..
"'number' or 'boolean' type", data.setting_id)
end
if type(data.options) ~= "table" then
vmf.throw_error("[widget \"%s\" (dropdown)]: 'options' field is required and must have 'table' type",
data.setting_id)
end
local default_value = data.default_value
local default_value_match = false
local used_values = {}
for i, option in ipairs(data.options) do
local option_value = option.value
if type(option.text) ~= "string" then
vmf.throw_error("[widget \"%s\" (dropdown)]: 'options[%d]'-> 'text' field is required and must have " ..
"'string' type", data.setting_id, i)
end
if not allowed_dropdown_values[type(option_value)] then
vmf.throw_error("[widget \"%s\" (dropdown)]: 'options[%d]'-> 'value' field is required and must have " ..
"'string', 'number' or 'boolean' type", data.setting_id, i)
end
if option.show_widgets and type(option.show_widgets) ~= "table" then
vmf.throw_error("[widget \"%s\" (dropdown)]: 'options[%d]'-> 'show_widgets' field must have 'table' type",
data.setting_id, i)
end
if used_values[option_value] then
vmf.throw_error("[widget \"%s\" (dropdown)]: 'options[%d]' has 'value' field set to the same value " ..
"as one of previous options", data.setting_id, i)
end
used_values[option_value] = true
if default_value == option_value then
default_value_match = true
end
end
if not default_value_match then
vmf.throw_error("[widget \"%s\" (dropdown)]: 'default_value' field contains value not defined in 'options' field",
data.setting_id)
end
end
local function localize_dropdown_data(mod, data)
local options = data.options
local localize = data.localize
if options.localize ~= nil then
localize = options.localize
end
if localize then
for _, option in ipairs(options) do
option.text = mod:localize(option.text)
end
end
end
local function initialize_dropdown_data(mod, data, localize, collapsed_widgets) local function initialize_dropdown_data(mod, data, localize, collapsed_widgets)
local new_data = initialize_generic_widget_data(mod, data, localize) local new_data = initialize_generic_widget_data(mod, data, localize)
@ -383,8 +267,8 @@ local function initialize_dropdown_data(mod, data, localize, collapsed_widgets)
if data.sub_widgets[sub_widget_index] then if data.sub_widgets[sub_widget_index] then
new_show_widgets[data.sub_widgets[sub_widget_index].index] = true new_show_widgets[data.sub_widgets[sub_widget_index].index] = true
else else
throw_error("[widget \"%s\" (dropdown)]: 'options -> [%d] -> show_widgets -> [%d] \"%s\"' points" .. vmf.throw_error("[widget \"%s\" (dropdown)]: 'options -> [%d] -> show_widgets -> [%d] \"%s\"' points " ..
" to non-existing sub_widget", data.setting_id, i, j, sub_widget_index) "to non-existing sub_widget", data.setting_id, i, j, sub_widget_index)
end end
end end
option.show_widgets = new_show_widgets option.show_widgets = new_show_widgets
@ -395,28 +279,153 @@ local function initialize_dropdown_data(mod, data, localize, collapsed_widgets)
return new_data return new_data
end end
-- ---------------------------------------------------------------------------------------------------------------------
-- ----| Keybind |------------------------------------------------------------------------------------------------------
-- ---------------------------------------------------------------------------------------------------------------------
local allowed_keybind_triggers = {
pressed = true,
released = true,
held = true
}
local allowed_keybind_types = {
action_call = true,
view_toggle = true,
mod_toggle = true
}
local allowed_special_keys = {
ctrl = true,
alt = true,
shift = true
}
local function validate_keybind_data(data)
if data.keybind_global and type(data.keybind_global) ~= "boolean" then
vmf.throw_error("[widget \"%s\" (keybind)]: 'keybind_global' field must have 'boolean' type", data.setting_id)
end
if not allowed_keybind_triggers[data.keybind_trigger] then
vmf.throw_error("[widget \"%s\" (keybind)]: 'keybind_trigger' field is required and must contain string " ..
"\"action_call\", \"view_toggle\" or \"mod_toggle\"", data.setting_id)
end
local keybind_type = data.keybind_type
if not allowed_keybind_types[keybind_type] then
vmf.throw_error("[widget \"%s\" (keybind)]: 'keybind_type' field is required and must contain string " ..
"\"pressed\", \"released\" or \"held\"", data.setting_id)
end
if keybind_type == "action_call" and type(data.action_name) ~= "string" then
vmf.throw_error("[widget \"%s\" (keybind)]: 'keybind_type' is set to \"action_call\" so 'action_name' " ..
"field is required and must have 'string' type", data.setting_id)
end
if keybind_type == "view_toggle" and type(data.view_name) ~= "string" then
vmf.throw_error("[widget \"%s\" (keybind)]: 'keybind_type' is set to \"view_toggle\" so 'view_name' " ..
"field is required and must have 'string' type", data.setting_id)
end
local default_value = data.default_value
if type(default_value) ~= "table" then
vmf.throw_error("[widget \"%s\" (keybind)]: 'default_value' field is required and must have 'table' type",
data.setting_id)
end
if #default_value > 4 then
vmf.throw_error("[widget \"%s\" (keybind)]: table stored in 'default_value' field can't exceed 4 elements",
data.setting_id)
end
if default_value[1] and (not vmf.readable_key_names[default_value[1]] or allowed_special_keys[default_value[1]]) then
vmf.throw_error("[widget \"%s\" (keybind)]: 'default_value[1]' must be a valid key name", data.setting_id)
end
if default_value[2] and not allowed_special_keys[default_value[2]] or
default_value[3] and not allowed_special_keys[default_value[3]] or
default_value[4] and not allowed_special_keys[default_value[4]]
then
vmf.throw_error("[widget \"%s\" (keybind)]: 'default_value [2], [3] and [4]' can be only strings: \"ctrl\", " ..
"\"alt\" and \"shift\" (in no particular order)", data.setting_id)
end
local used_keys = {}
for _, key in ipairs(default_value) do
if used_keys[key] then
vmf.throw_error("[widget \"%s\" (keybind)]: you can't define the same key in 'default_value' table twice",
data.setting_id)
end
used_keys[key] = true
end
end
local function initialize_keybind_data(mod, data, localize) local function initialize_keybind_data(mod, data, localize)
local new_data = initialize_generic_widget_data(mod, data, localize) local new_data = initialize_generic_widget_data(mod, data, localize)
new_data.keybind_global = data.keybind_global new_data.keybind_global = data.keybind_global -- optional
new_data.keybind_trigger = data.keybind_trigger new_data.keybind_trigger = data.keybind_trigger
new_data.keybind_type = data.keybind_type new_data.keybind_type = data.keybind_type
new_data.action_name = data.action_name new_data.action_name = data.action_name -- required, if (keybind_type == "action_call")
new_data.view_name = data.view_name new_data.view_name = data.view_name -- required, if (keybind_type == "view_toggle")
validate_keybind_data(new_data) validate_keybind_data(new_data)
return new_data return new_data
end end
-- ---------------------------------------------------------------------------------------------------------------------
-- ----| Numeric |------------------------------------------------------------------------------------------------------
-- ---------------------------------------------------------------------------------------------------------------------
local function validate_numeric_data(data)
if data.unit_text and type(data.unit_text) ~= "string" then
vmf.throw_error("[widget \"%s\" (numeric)]: 'unit_text' field must have 'string' type", data.setting_id)
end
if type(data.decimals_number) ~= "number" then
vmf.throw_error("[widget \"%s\" (numeric)]: 'decimals_number' field must have 'number' type", data.setting_id)
end
if data.decimals_number < 0 then -- @TODO: eventually do max cap as well
vmf.throw_error("[widget \"%s\" (numeric)]: 'decimals_number' value can't be lower than zero", data.setting_id)
end
local range = data.range
if type(range) ~= "table" then
vmf.throw_error("[widget \"%s\" (numeric)]: 'range' field is required and must have 'table' type", data.setting_id)
end
if #range ~= 2 then
vmf.throw_error("[widget \"%s\" (numeric)]: 'range' field must contain an array-like table with 2 elements",
data.setting_id)
end
local range_min = range[1]
local range_max = range[2]
if type(range_min) ~= "number" or type(range_max) ~= "number" then
vmf.throw_error("[widget \"%s\" (numeric)]: table stored in 'range' field must contain only numbers",
data.setting_id)
end
if range_min > range_max then
vmf.throw_error("[widget \"%s\" (numeric)]: 'range[2]' must be bigger than 'range[1]'", data.setting_id)
end
local default_value = data.default_value
if type(default_value) ~= "number" then
vmf.throw_error("[widget \"%s\" (numeric)]: 'default_value' field is required and must have 'number' type",
data.setting_id)
end
if default_value < range_min or default_value > range_max then
vmf.throw_error("[widget \"%s\" (numeric)]: 'default_value' field must contain number fitting set 'range'",
data.setting_id)
end
end
local function localize_numeric_data(mod, data)
if data.localize and data.unit_text then
data.unit_text = mod:localize(data.unit_text)
end
end
local function initialize_numeric_data(mod, data, localize) local function initialize_numeric_data(mod, data, localize)
local new_data = initialize_generic_widget_data(mod, data, localize) local new_data = initialize_generic_widget_data(mod, data, localize)
new_data.unit_text = data.unit_text new_data.unit_text = data.unit_text -- optional
new_data.range = data.range new_data.range = data.range
new_data.decimals_number = data.decimals_number or 0 new_data.decimals_number = data.decimals_number or 0 -- optional
validate_numeric_data(new_data) validate_numeric_data(new_data)
localize_numeric_data(mod, new_data) localize_numeric_data(mod, new_data)
@ -424,6 +433,9 @@ local function initialize_numeric_data(mod, data, localize)
return new_data return new_data
end end
-- ---------------------------------------------------------------------------------------------------------------------
-- ----| Other function |-----------------------------------------------------------------------------------------------
-- ---------------------------------------------------------------------------------------------------------------------
local function initialize_widget_data(mod, data, localize, collapsed_widgets) local function initialize_widget_data(mod, data, localize, collapsed_widgets)
if data.type == "header" then if data.type == "header" then
@ -442,10 +454,12 @@ local function initialize_widget_data(mod, data, localize, collapsed_widgets)
-- if data.type is incorrect, returns nil -- if data.type is incorrect, returns nil
end end
----------- local allowed_parent_widget_types = {
-- OTHER -- header = true,
----------- group = true,
checkbox = true,
dropdown = true
}
local function unfold_table(unfolded_table, unfoldable_table, parent_index, depth) local function unfold_table(unfolded_table, unfoldable_table, parent_index, depth)
for i = 1, #unfoldable_table do for i = 1, #unfoldable_table do
local nested_table = unfoldable_table[i] local nested_table = unfoldable_table[i]
@ -454,20 +468,20 @@ local function unfold_table(unfolded_table, unfoldable_table, parent_index, dept
nested_table.depth = depth nested_table.depth = depth
nested_table.index = #unfolded_table nested_table.index = #unfolded_table
nested_table.parent_index = parent_index nested_table.parent_index = parent_index
local nested_table_sub_widgets = nested_table.sub_widgets local nested_table_sub_widgets = allowed_parent_widget_types[nested_table.type] and nested_table.sub_widgets
if nested_table_sub_widgets then if nested_table_sub_widgets then
if type(nested_table_sub_widgets) == "table" then if type(nested_table_sub_widgets) == "table" then
unfold_table(unfolded_table, nested_table_sub_widgets, #unfolded_table, depth + 1) unfold_table(unfolded_table, nested_table_sub_widgets, #unfolded_table, depth + 1)
else else
vmf:dump(unfolded_table, "widgets", 1) vmf:dump(unfolded_table, "widgets", 1)
throw_error("'sub_widgets' field of widget [%d] is not a table, it's %s. " .. vmf.throw_error("'sub_widgets' field of widget [%d] is not a table, it's %s. See dumped table in game log " ..
"See dumped table in game log for reference.", #unfolded_table, type(nested_table_sub_widgets)) "for reference.", #unfolded_table, type(nested_table_sub_widgets))
end end
end end
else else
vmf:dump(unfolded_table, "widgets", 1) vmf:dump(unfolded_table, "widgets", 1)
throw_error("sub_widget#%d of widget [%d] is not a table, it's %s. " .. vmf.throw_error("sub_widget#%d of widget [%d] is not a table, it's %s. " ..
"See dumped table in game log for reference.", i, parent_index, type(nested_table)) "See dumped table in game log for reference.", i, parent_index, type(nested_table))
end end
end end
return unfolded_table return unfolded_table
@ -500,8 +514,8 @@ local function initialize_mod_options_widgets_data(mod, widgets_data, localize)
table.insert(initialized_data, initialized_widget_data) table.insert(initialized_data, initialized_widget_data)
else else
vmf:dump(_unfolded_raw_widgets_data, "widgets", 1) vmf:dump(_unfolded_raw_widgets_data, "widgets", 1)
throw_error("[widget#%d]: 'type' field must contain valid widget type name. " .. vmf.throw_error("[widget#%d]: 'type' field must contain valid widget type name. " ..
"See dumped table in game log for reference.", widget_data.index, widget_data.type) "See dumped table in game log for reference.", widget_data.index, widget_data.type)
end end
end end
@ -515,7 +529,7 @@ end
local function initialize_default_settings_and_keybinds(mod, initialized_widgets_data) local function initialize_default_settings_and_keybinds(mod, initialized_widgets_data)
for i = 2, #initialized_widgets_data do for i = 2, #initialized_widgets_data do
local data = initialized_widgets_data[i] local data = initialized_widgets_data[i]
if mod:get(data.setting_id) == nil then if mod:get(data.setting_id) == nil and data.type ~= "group" then
mod:set(data.setting_id, data.default_value) mod:set(data.setting_id, data.default_value)
end end
if data.type == "keybind" then if data.type == "keybind" then