.. _option:

option
======

Defines a custom sandbox option for a mod.


Hierarchy
---------

**Valid Parent Blocks:**

- :ref:`root-sandboxoptions`


ID Properties
-------------

This block should have an ID.


Parameters
----------

.. _option-default:

**default** `🔗 <#option-default>`_
   Type: ``Any``

   No description

.. _option-max:

**max** `🔗 <#option-max>`_
   Type: ``float``

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

.. _option-min:

**min** `🔗 <#option-min>`_
   Type: ``float``

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

.. _option-page:

**page** `🔗 <#option-page>`_
   Type: ``string``

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

.. _option-translation:

**translation** `🔗 <#option-translation>`_
   Type: ``string``

   The translation key for the option's name.

.. _option-type:

**type** `🔗 <#option-type>`_
   Type: ``string`` *(required)*

   The type of the option.

   Allowed values:

   - ``boolean``
   - ``integer``
   - ``double``
   - ``string``
   - ``enum``