types.neon_feature

A wrapper for interacting with Neon features
Note: The mode field in setting parameter tables is optional.

Functions

get_name(): string

Returns the feature name

• returns (string) The feature name

is_enabled(): boolean

Returns whether the feature is enabled or not

• returns (bool) The enabled state

toggle(state : boolean)

Toggles the feature on or off

• state (bool) The enabled state

get_mode(): string

Gets the current mode name from the feature

• returns (string) The current mode name

set_mode(mode_name : string)

Sets the current mode of the feature

• mode_name (string) The name of the mode to set

get_boolean_setting(params : table): boolean

Gets a boolean setting value

• params (table) The parameters table (setting, mode)
• returns (bool) The boolean setting value

set_boolean_setting(params : table)

Sets a boolean setting value

• params (table) The parameters table (setting, mode, value)

get_number_setting(params : table): number

Gets a number setting value

• params (table) The parameters table (setting, mode)
• returns (number) The number setting value

set_number_setting(params : table)

Sets a number setting value

• params (table) The parameters table (setting, mode, value)

get_string_setting(params : table): string

Gets a string setting value

• params (table) The parameters table (setting, mode)
• returns (string) The string setting value

set_string_setting(params : table)

Sets a string setting value

• params (table) The parameters table (setting, mode, value)

get_enum_setting(params : table): string

Gets an enum setting value

• params (table) The parameters table (setting, mode)
• returns (string) The enum setting value name

set_enum_setting(params : table)

Sets an enum setting value

• params (table) The parameters table (setting, mode, value)

get_multi_select_setting(params : table): table

Gets a multi select setting value

• params (table) The parameters table (setting, mode)
• returns (table) The list of selected values

set_multi_select_setting(params : table)

Sets a multi select setting value

• params (table) The parameters table (setting, mode, value)

is_multi_select_selected(params : table): boolean

Returns whether a multi select setting value is selected

• params (table) The parameters table (setting, mode, value)
• returns (boolean) True if selected, false otherwise

get_color_setting(params : table): types.color

Gets a color setting value

• params (table) The parameters table (setting, mode)
• returns (types.color) The color setting value

set_color_setting(params : table)

Sets a color setting value

• params (table) The parameters table (setting, mode, value)

get_number_range_setting(params : table): table

Gets a number range setting value

• params (table) The parameters table (setting, mode)
• returns (table) The number range setting value (min, max)

set_number_range_setting(params : table)

Sets a number range setting value

• params (table) The parameters table (setting, mode, min, max)