SetGlobalProperty

From VASSAL
Jump to: navigation, search

VASSAL Reference Manual

Home > Module > Game Piece Palette >' Game Piece > Set Global' Property


Set Global Property

This trait allows a Game Piece to change the value of a Global Property.

Description A descriptive name for reference in the editor.

Global Property Name The name of the property to be set. You can include $xxxx$ variables.

Locate Property starting in the   You may name a Zone or Map containing the Global Property to be set, or you may set the property based on the piece's current location, looking for the occupied Zone or Map before defaulting to the Module. You can include $xxxx$ variables in the name of the Zone or Map.

Is Numeric If true, then changes to the value of the property will be restricted to integer values.

Minimum Value Numeric values will be restricted to no less than this number.

Maximum Value Numeric values will be restricted to no more than this number.

Wrap Around If true, then when incrementing this numeric property, values will wrap around from the maximum to the minimum.

Key Commands Adds any number of commands to the right-click drop-down menu for this Game Piece.

Hit the New button to add a new command and the Remove button to remove one.

For each command, specify the text of the drop-down menu entry and the keyboard shortcut.

The type defines how the property value should change:

Set value directly sets the property to a fixed value, after substituting values of other Properties defined for this Game Piece.

Increment numeric value adds a fixed value to the property, after substituting values of Properties.

Prompt user pops up a dialog for the user to type in a new value.

Prompt user to select from list pops up a dialog with a drop-down menu for the user to select from.