The goal of this is to automatically generate the Client_PresentConfigureUI, Client_SaveConfigureUI and Client_PresentSettingsUI lua files. All files other than __settings.lua are not meant to be edited. __settings.lua is where to define settings.

__settings.lua

The file must have a getSettings function. returns array of setting

setting is a table which is generated from the addSetting and addSettingTemplate functions

addSetting

Arguments:

name - string - name of the setting. all names must be unique to function correctly
label - string - summery of what the setting does
inputType - one of 'int', 'float', 'bool' or 'text'
defaultValue - same type as inputType - the default value for the setting's value in Client_PresentConfigureUI
otherProps - table or nil - if table then these keys are optional:
- help - function(parent) - gives a more detailed explanation of what the setting does when a help button (?) is clicked
- labelColor - string - color of the setting's label text

inputType

Depending on the inputType certain keys on otherProps are forced and some become optional

int

Forced keys:

minValue - number - the lowest the setting's value can be
maxValue - number - the highest the setting's value can be while using the setting slider

Optional keys:

absoluteMax - number - allows user to enter a higher number than maxValue

float

Forced keys:

dp - number - the number of decimal places to round the setting's value when saving the settings
minValue - number - the lowest the setting's value can be
maxValue - number - the highest the setting's value can be while using the setting slider

Optional keys:

absoluteMax - number - allows user to enter a higher number than maxValue

bool

Optional keys:

subsettings - table or nil. if table then is an array of setting

text

Optional keys:

placeholder - string - the placeholder text
charLimit - number - the maximum number of characters that can be entered

addSettingTemplate

In the event of wanting to have infinite groups of settings, setting templates can be used.

Arguments:

name - string - name of the setting. all names must be unique to function correctly
btnText - string - text that goes on a button that user presses to add a new group of settings
options - nil or table with keys:
- btnColor - nil or string - color of the button; nil = #00FF05
- btnTextColor - nil or string - color of btnText; nil = wz default
- bkwrds - nil or int - for if the mod is public and goes from limited to unlimited amounts of setting groups. bkwrds number of setting groups will be generated. to avoid nil in Client_PresentSettingsUI
get(n) - function - n starts at 1. get must return table with keys:
- label - string - description of the setting group
- labelColor - nil or string - color of the label; nil = wz default
- settings - array of setting

Accessing setting values

Each setting is written to Mod.Settings[name]. name in addSettingTemplate is altered to only apply to the correct setting group. Use the getSetting(name, template) function defined in _settings.lua. Returns the value stored in Mod.Settings

name string - name of the setting, same as what was used in addSetting or addSettingTemplate

template - nil or table - containing the following keys: