<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
| Attribute | Value | Description |
|---|---|---|
name | option name | Option name |
value | option value | Option value |
Supported options
List of options supported/used by the system.
| Option name | Value | Description | Example | Default Value |
|---|---|---|---|---|
required-plugins | plugin-list | Space-separated list of plugins that must be enabled before a page is loaded. If any of the plugins are missing, document parsing fails. | Plugin1 Plugin2 | None |
screen-width | number or default | The width of the screen the content is rendered to. Clamped to range [1..10] | 3 | 3 |
screen-height | number or default | The height of the screen the content is rendered to. Clamped to range [1..10] | 2 | 2 |
minimum-game-version | minecraft version | The minimum version of minecraft required to open the page. | 1.21 | None |
advanced-item-tooltips | true or false | If item tooltips use advanced tooltips. (Including the F3+H information). This option can also be set as an attribute on each <item> element. | true | false |
interaction-distance | number | The maximum distance that a player can interact with the screen from. | 15.75 | 10 |