<option/> tag

Sets of key/value pairs that can be included in a page’s <head> element.

Any key/value pair is valid and will be stored in the document, for scripts or the system to use.

Options are declared inside <head> tag with the following syntax:

<option name="option name" value="option value" />

You can also omit the value

<option name="option name"/>

When you access an option with an omitted value (with document.getOption(name: string) for example) it will return an empty string. If several values for the same option are set in a page, the last valid one is used.

Attributes

AttributeValueDescription
nameoption nameOption name
valueoption valueOption value

Supported options

List of options supported/used by the system.

Option nameValueDescriptionExampleDefault Value
required-pluginsplugin-listSpace-separated list of plugins that must be enabled before a page is loaded. If any of the plugins are missing, document parsing fails.Plugin1 Plugin2None
screen-widthnumber or defaultThe width of the screen the content is rendered to.
Clamped to range [1..10]
33
screen-heightnumber or defaultThe height of the screen the content is rendered to.
Clamped to range [1..10]
22
minimum-game-versionminecraft versionThe minimum version of minecraft required to open the page.1.21None
advanced-item-tooltipstrue or falseIf item tooltips use advanced tooltips. (Including the F3+H information). This option can also be set as an attribute on each <item> element.truefalse
interaction-distancenumberThe maximum distance that a player can interact with the screen from.15.7510