Skip to main content

group

This type extends from setting​

Wrapper for group settings

Functions​

All functions in this type

is_expanded(): void​

Returns true if the setting is expanded

get_setting(): type​

Gives a setting from the group setting

pluto
get_setting(setting: string): type

Parameters​

  • setting (string): The setting requested

register_setting(): type​

Registers a setting to the group setting and returns it

pluto
register_setting(module: string, type: string, name: string, value: any, ...args): type

Parameters​

  • module (string): The targeted module's name
  • type (string): The type of setting wanted
  • value (any): The default value of the setting
  • args (...): Parameters required by the setting

Types​

  • boolean

    Parameters​
    • value: The default boolean value

  • color

    Parameters​
    • value: The default rgb color value in number

  • string

    Parameters​
    • value: The default string value

  • mode

    Parameters​
    • value: The default string value
    • modes: The modes available in a list of strings.

  • multimode

    Parameters​
    • value: The default list of strings value
    • modes: The modes available in a list of strings.

  • number

    Parameters​
    • value: The default number value
    • range: The range of the setting in a list of 2 numbers.
    • step: The increment between each value available

  • range

    Parameters​
    • value: The default range value in a list of 2 numbers.
    • range: The range of the setting in a list of 2 numbers.
    • step: The increment between each value available

remove_setting(): void​

Removes a setting from the group setting

pluto
remove_setting(setting: type): void
remove_setting(setting_name: string): void

Parameters​

  • setting (type): The setting type
  • setting_name (string): The setting name

Properties​

All properties in this type

value: table​

The current value set to a list of setting