Interface Options

public interface Options
Constants for options supported/reserved by the DOM

  • Field Details

    • REQUIRED_PLUGINS

      static final String REQUIRED_PLUGINS
      A space-separated list of plugins that must be enabled for a page to be successfully opened.

      This option is validated during document parsing, and if any of the plugins are missing or not enabled, the parsing stops and loading fails.

      Example: <option name="required-plugins" value="Essentials WorldEdit WorldGuard"/>

      See Also:

    • SCREEN_WIDTH

      static final String SCREEN_WIDTH
      Screen width option. By default, the value of this option is Screen.DEFAULT_WIDTH

      Modifying this option when a page is already open, will cause the screen's size to change

      Example: <option name="screen-width" value="3"/>

      See Also:

    • SCREEN_HEIGHT

      static final String SCREEN_HEIGHT
      Screen height option. By default, the value of this option is Screen.DEFAULT_HEIGHT

      Modifying this option when a page is already open, will cause the screen's size to change

      Example: <option name="screen-height" value="2"/>

      See Also:

    • ADVANCED_ITEM_TOOLTIPS

      static final String ADVANCED_ITEM_TOOLTIPS
      If item tooltips use advanced tooltips. (Including the F3+H debug information). This option can also be set as an attribute on each <item> element.

      By default, the value of this option is "false"

      Example: <option name="advanced-item-tooltips" value="true"/>

      See Also:

    • IGNORE_PLAYER_PITCH

      static final String IGNORE_PLAYER_PITCH
      Ignore the pitch of the player when opening the screen. Setting this to false means the screen will spawn in front of the player regardless of what direction they're looking in.

      If the value is true, then the screen will be spawned in front of the player at their eye level without any X-axis rotation.

      By default, the value of the option is true

      Example: <option name="ignore-player-pitch" value="false" />

      See Also:

    • MINIMUM_GAME_VERSION

      static final String MINIMUM_GAME_VERSION
      Minimum version of the game required to open the page. If the page is opened on an older version than specified by the option, the page will fail to open.

      This option expects values to be semantic versions (major.minor.patch?), anything else causes the system to fall back to a simple string comparison of the specified version and the current game version, which can result in inaccurate results if the amount of digits differs between the option's value and the game version.

      By default, this option has no value.

      Example: <option name="minimum-game-version" value="1.21.4"/>

      See Also: