option

Defines a custom sandbox option for a mod. You can find more information about sandbox options here.

Hierarchy

Valid Parent Blocks:

• ROOT-SandboxOptions

ID Properties

This block should have an ID.

Parameters

default

Type:

Any

Needs:

type

The default value of the option. The type of the value must match the type of the option.

max

Type:

float

Needs:

type = integer, double

The maximum value the option can have. Only for integer and double types.

min

Type:

float

Needs:

type = integer, double

The minimum value the option can have. Only for integer and double types.

page

Type:

string

The sandbox option to add the option to. Can be a custom page.

translation

Type:

string

The translation key for the option’s name. The translation key in the Sandbox translation file should have the prefix Sandbox_.

For example, with the translation parameter as such:

translation = MyMod_MyOption

The translation key in the Sandbox translation file should be:

"Sandbox_MyMod_MyOption": "My Option"

type

Type:

string (required)

The type of the option.

Allowed values:

• boolean

• integer

• double

• string

• enum