Control Types

The following control types are available:

• Slider
• Stepper
• Toggle

Slider

A slider allows the user to choose a value from a range. This control is intended for audio and graphics settings and is not recommended for gameplay settings.

{
  "text": "Demo Slider",
  "type": "slider",
  "help": "A slider that allows you to choose a value from 0 to 1.",
  "valueOptions": {
    "min": 0,
    "max": 1,
    "step": 0.05
  }
}

Stepper

A stepper allows the user to select one of multiple options. Its value is an integer indicating a 0-based index. A stepper's help property can be given as an array in order to display different help text depending on the selected option.

{
  "text": "Demo Stepper",
  "type": "stepper",
  "help": [
    "This setting is currently toggled ON.",
    "This setting is currently toggled OFF."
  ],
  "valueOptions": {
    "options": ["On", "Off"]
  }
}

Toggle

A toggle displays a checkbox and has a value of 0 or 1 indicating the checked state.

{
  "text": "Demo Toggle",
  "type": "toggle",
  "help": "A toggle that allows you to choose whether something is enabled or disabled."
}