SettingsManager

Summary

Methods

Method	Returns
DeclareBool(name: string, default: bool, options: SettingOptions)	ModSetting
DeclareNumber(name: string, default: float, min: float, max: float, options: SettingOptions)	ModSetting
DeclareKeybind(name: string, default: InputDeviceKeys, options: SettingOptions)	ModSetting
DeclareMultiKeybind(name: string, default: InputDeviceKeys{}, options: SettingOptions)	ModSetting
DeclareString(name: string, default: string, minLength: int, maxLength: int, options: SettingOptions)	ModSetting
DeclareOption(name: string, default: string | nil, optionNames: string{}, allowEmpty: bool, options: SettingOptions)	ModSetting
GetSetting(name: string)	ModSetting | nil
DeleteSetting(name: string)	void

Methods

DeclareBool

DeclareBool(name: string, default: bool, options: SettingOptions): ModSetting

Parameters

Name	Type	Description
name	string
default	bool
options	SettingOptions

Returns

Type	Description
ModSetting

DeclareNumber

DeclareNumber(name: string, default: float, min: float, max: float, options: SettingOptions): ModSetting

Parameters

Name	Type	Description
name	string
default	float
min	float
max	float
options	SettingOptions

Returns

Type	Description
ModSetting

DeclareKeybind

DeclareKeybind(name: string, default: InputDeviceKeys, options: SettingOptions): ModSetting

Parameters

Name	Type	Description
name	string
default	InputDeviceKeys
options	SettingOptions

Returns

Type	Description
ModSetting

DeclareMultiKeybind

DeclareMultiKeybind(name: string, default: InputDeviceKeys{}, options: SettingOptions): ModSetting

Parameters

Name	Type	Description
name	string
default	InputDeviceKeys{}
options	SettingOptions

Returns

Type	Description
ModSetting

DeclareString

DeclareString(name: string, default: string, minLength: int, maxLength: int, options: SettingOptions): ModSetting

Parameters

Name	Type	Description
name	string
default	string
minLength	int
maxLength	int
options	SettingOptions

Returns

Type	Description
ModSetting

DeclareOption

DeclareOption(name: string, default: string | nil, optionNames: string{}, allowEmpty: bool, options: SettingOptions): ModSetting

Parameters

Name	Type	Description
name	string
default	string | nil
optionNames	string{}
allowEmpty	bool
options	SettingOptions

Returns

Type	Description
ModSetting

GetSetting

GetSetting(name: string): ModSetting | nil

Parameters

Name	Type	Description
name	string

Returns

Type	Description
ModSetting | nil

DeleteSetting

DeleteSetting(name: string)

Parameters

Name	Type	Description
name	string