Options

EEex_Options_AddTab

Warning

This function is currently undocumented.

EEex_Options_Check

Summary

Checks if the option with the given id exists and is equal to the given value.

Parameters:

Name	Type	Default Value	Description
id	string		The id of the option whose value is to be checked.
value	`<non-nil>`		The value to check against the option.

Return Values:

Type	Description
boolean	`true` if the option with `id` exists and it is equal to the given `value`; `false` otherwise.

EEex_Options_Close

Summary

Closes the "EEex Options" menu if it is currently open.

EEex_Options_Get

Summary

Returns the option object with the given id.

Parameters:

Name	Type	Default Value	Description
id	string		The id of the option to be fetched.

Return Values:

Type	Description
EEex_Options_Option \| nil	See summary / The Option Table for more details.

EEex_Options_MarshalKeybind

Summary

Returns a string representing the given keybind table.

Parameters:

Name	Type	Default Value	Description
keybind	table		A table representing the keybind to marshal. See The Keybind Table for more details.

Return Values:

Type	Description
string	See summary.

EEex_Options_Open

Summary

Opens the "EEex Options" menu if it is currently closed.

EEex_Options_Option.new

Summary

Creates a new EEex_Options_Option instance.

Parameters:

Name	Type	Default Value	Description
o	table	`{}`	The object to become the `EEex_Options_Option` instance. See The Option Table for more details.

Return Values:

Type	Description
EEex_Options_Option	See summary.

The Option Table

Key	Value Type	Description
accessor	EEex_Options_Accessor	This field is currently undocumented.
default	`<non-nil>`	This field is currently undocumented.
requiresRestart	boolean	This field is currently undocumented.
storage	EEex_Options_Private_Storage	This field is currently undocumented.

EEex_Options_Option:get()

Summary

Returns the current, in-effect value of the option.

Note

Some options delay applying changes made to their value; these changes will only be visible at a later time, such as after a restart.

Return Values:

Type	Description
`<non-nil>`	See summary.

EEex_Options_Option:getDefault()

Summary

Returns the default value of the option.

Return Values:

Type	Description
`<non-nil>`	See summary.

EEex_Options_Option:set()

Summary

Sets the value of the option.

Note

Some options delay applying changes made to their value; these changes will only be visible at a later time, such as after a restart.

Parameters:

Name	Type	Default Value	Description
newValue	`<any>`		The value to set the option to. If `nil`, sets the option to its default value.

Return Values:

Type	Description
`<non-nil>`	Returns the value the option was set to after constraints were applied to `newValue`.

EEex_Options_Register

Summary

Registers option under id. Options must be registered to be functional.

Parameters:

Name	Type	Default Value	Description
id	string		The unique id to register `option` under.
option	EEex_Options_Option		The option being registered.

Return Values:

Type	Description
EEex_Options_Option	Returns `option`.

EEex_Options_Set

Summary

If it exists, sets the option with the given id to value.

Parameters:

Name	Type	Default Value	Description
id	string		The id of the option whose value is to be set.
value	`<non-nil>`		The value to set the option to. If `nil`, sets the option to its default value.

Return Values:

Type	Description
`<any>`	The new value of the option, or `nil` if the option did not exist.

EEex_Options_UnmarshalKeybind

Summary

Returns a table representing the given keybindStr string.

Parameters:

Name	Type	Default Value	Description
keybindStr	string		A string representing the keybind to unmarshal. This string is of the format `<SDL key name>+<SDL key name>...\|<UP or DOWN>`

Return Values:

Type	Description
table	See summary / The Keybind Table for more details.