option¶
- Soft Override:
Unknown
Defines a custom sandbox option for a mod. You can find more information about sandbox options here.
Hierarchy¶
This block can be a child of the following blocks:
ID¶
This block can have an ID.
- Optional:
False
- Can have spaces:
False
Parameters¶
- default
- Type:
Unknown
The default value of the option. The type of the value must match the type of the option.
- max
- Type:
float
The maximum value the option can have. Only for integer and double types.
- min
- Type:
float
The minimum value the option can have. Only for integer and double types.
- page
- Type:
translation
The sandbox option to add the option to. Can be a custom page.
- translation
- Type:
translation
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:
True
- Allowed values:
boolean|double|enum|integer|string
The type of the option.