Setting

Members


type

integer

integer

name

string

The display name of the setting

saveName

string

The name used to save/load this Setting, no spaces

visible

boolean

Should show in the ui

value

any

boolean|integer|number|Vector2|ColorSetting The value of the setting

default

any

boolean|integer|number|Vector2|ColorSetting The default value of the setting

min

any

integer|number|Vector2|nil Minimum value of the setting

max

any

integer|number|Vector2|nil Maximum value of the setting

scale

number

The scale of info settings

parent

Module

the parent module

enumValues

table

table of tables, e.g. { {value, name}, {value2, name2} }

textbox

Textbox

The textbox of the setting




Obtaining

The following functions can return this type.

[Setting] colorSetting = gui.showColorPicker(setting, positionX, positionY, yOffset) [Setting] setting = client.setting.addNamelessEnum(name, defaultValue, enumValues) [Setting] setting = client.setting.addEnum(name, variableName, enumValues) [Setting] setting = client.setting.addFloat(name, variableName, minimum, maximum) [Setting] setting = client.setting.addCustom(name, CustomSettingTypeId, defaultValue) [Setting] setting = client.setting.addNamelessInt(name, minimum, maximum, defaultValue) [Setting] setting = client.setting.addInfo(variableName) [Setting] setting = client.setting.addNamelessKeybind(name, defaultValue) [Setting] setting = client.setting.addNamelessTextbox(name, defaultValue, maxCharacters) [Setting] setting = client.setting.addCategory(name, settingCount) [Setting] setting = client.setting.addInt(name, variableName, minimum, maximum) [Setting] setting = client.setting.addAir(space) [Setting] setting = client.setting.addTextbox(name, variableName, maxCharacters) [Setting] setting = client.setting.addTitle(variableName) [Setting] setting = client.setting.addBool(name, variableName) [Setting] setting = client.setting.addKeybind(name, variableName) [Setting] setting = client.setting.addColor(name, variableName) [Setting] setting = client.setting.addFunction(name, variableName, buttonName) [Setting] setting = client.setting.addNamelessBool(name, defaultValue) [Setting] setting = client.setting.addNamelessFloat(name, minimum, maximum, defaultValue) [Setting] setting = client.setting.addNamelessColor(name, defaultValue)