VASSAL Reference Manual

Home > Module > Global Options


Global Options

The Global Options component allows you to define your own custom preferences for a module. It also contains other settings that apply to the module as a whole, as well as providing a location to configure button images and hotkeys for some of the basic Toolbar buttons. If an option has a Use Preferences Setting choice, selecting it will add an entry to the Preferences window to allow players to choose their own setting at game time.

Allow non-owners to unmask pieces:

By default, only the player who originally masked a piece (see the Mask trait for Game Pieces) is allowed to unmask it. This option allows other players to unmask a masked piece.

Center on opponent’s moves:

This option will center a map window on an opponent’s move when reading a logfile or receiving a move on the server. It is recommended that in most cases this be set to "Use Preferences" so that players can turn this behavior on and off themselves.

Auto-report moves:

This option will automatically report a text description (e.g. "3rd Cav moves A10 →B11") to the chat log of the control window whenever a player moves a piece in a Map Window.

Player Id format:

A Message Format that is used to identify players when typing chat text. It is available for use as a short-cut in other message formats such as move auto-reporting as well.

Enable HTML Support in Chat Log:

This option, if enabled, will allow messages sent to the Chat Log to include HTML tags. It is recommended that for new modules you set this option to Always, as the other settings exist only to maintain compatibility with VASSAL modules created before HTML support existed that might have included symbols in their text messages, e.g. < > which could otherwise be misinterpreted as HTML tags.

Toolbars On Closed Map Windows Accept Hotkeys:

This option, if enabled, will allow toolbar buttons and items (such as Global Key Commands, Dice rollers, and Global Property setters) to receive Global Hotkeys sent by Game Pieces even when their Map Window is currently closed. This option is "off" by default, meaning that the toolbar items on windows are disabled while the windows are closed.

Inventory can see into Private Windows not accessible to current player:

This option, if enabled, allows Inventory windows to see into private windows and hands even if the current player doesn’t normally have access to those windows.

Send-to-Location trait generates Movement Trails:

If this option is enabled, Send-to-Location traits generate Movement Trails (and mark pieces moved) when they cause a piece to move, assuming the piece in question has a Movement Trail trait of course.

Icons and hotkeys:

You can specify your own button icons and keyboard shortcuts for the logfile step/undo buttons and the button that shows/hides the server controls.

GlobalOptions


Sub-Components

You may add your own arbitrary preference settings to the global options. To add your own preferences, right-click on the [Global Options] component in the Editor and select one of the Add options. The different sub-components support different constraints on the values of the preference setting. The values of these preference setting are exposed as Properties.

You must save and re-load the module before these sub-components will show up in the Preferences window

String Preference

A simple string value.

Text Box Preference

A multi-line string value.

A drop-down from which the player selects from a list of specified values.

Whole Number

An integer value.

Decimal Number Preference

A floating-point value.

Checkbox Preference

A true/false value.

GlobalOptionsComponent