VASSAL Reference Manual

Home > Module > Game Piece Inventory Window

Game Piece Inventory Window

Places a button in the module’s Toolbar. Clicking the button will open a window that organizes and summarizes the pieces in the game in a tree view (similar to browsing a file system, or indeed the VASSAL Editor). You can define exactly which pieces are included in the window and how they are organized.


A short description of this component for your own reference.

Button text:

Text for the button on the module’s Toolbar.

Tooltip text:

Text displayed when the cursor hovers over the Toolbar button.


Keyboard or Named Command for the Toolbar button.

Toolbar button can be disabled by a property:

If this box is checked, you will be able to enable/disable the Toolbar Button by changing the value of a Global Property. See also: Toolbar Configuration

Global Property to disable this button when "true"

The name of a Global Property that will control when this Toolbar Button is enabled or disabled. If the property contains the string true, the button will be disabled; if it contains any other value the button will be enabled.

Button Icon when disabled:

If you select an alternative icon here, then that icon will be used when the button is currently disabled. If you leave the icon empty, then the normal icon, if any, will stay in place. Any button text for the toolbar button will be greyed out when the button is disabled, regardless of your choice in this field.

Show only pieces matching these properties:

A Property Match Expression to filter which Game Pieces appear in the window. The window will only summarize pieces for which the matching expression evaluates to true. Properties of the pieces can be used in the expression to create the desired set of summaries.

(Examples: limit the pieces to a single map with the CurrentMap property, e.g. { CurrentMap == "Main Map" }, or only select pieces with a given value of a Marker trait, e.g. { Type == "Infantry" })

Sort and group by properties:

A list of Property names. Pieces with the same value of a given property will be grouped together at the same level.

(Example: listing the CurrentBoard and LocationName properties will give a top-level folder for each board and a second-level folder for each location that contains a piece.)

Label for folders:

A Message Format specifying the text used to label each folder in the tree. The PropertyValue property gives the value of the property that defines its group.

(for example, CurrentBoard for the board name or LocationName for the location name). Any property of the form sum_XXX will be replaced with the sum of Property XXX for all pieces within that folder. Any property of the form count_XXX will be replaced with count of pieces where Property XXX is defined (value doesn’t matter) for all pieces within that folder.

( Example: A Game Piece uses a Layer trait named Manpower, giving it an automatic property named Manpower_Level. Using the sum_Manpower_Level property in the folder label will report the total manpower for all pieces inside that folder.

Show only folders:

If selected, then individual pieces within a folder will not be shown in the view.

Label for pieces:

A Message Format specifying the text used to label each piece in the tree.


If selected, then sort pieces.

Label for sort:

A Message Format specifying the text by which pieces are sorted.

(Example: A piece is named 3rd Bn, 4th Reg, 3rd Div; for sorting the markers $div$ $reg$ $bn$ are used rather than the pieces name)

Sorting method:

alpha sorts the inventory tree alphabetically, numeric by the value of the first integer found, and length uses the string length first. When two entries are equal for numeric and length, alpha is used for sorting.

(Example: $id$ is the Label for sort. Three gamepieces have the ids 'a', 'aa', and 'b'. Sorting by alpha and numeric is ['a', 'aa', 'b']. Sorting by length is ['a', 'b', 'aa']. Three gamepieces have the ids 'a3', 'b2', 'c-4'. Sorting by alpha and length is ['a3', 'b2', 'c-4']. Sorting by numeric is ['c-4', 'b2', 'a3'].)

Center on selected piece:

If selected, then clicking on a piece in the tree will center the map on that piece.

Forward key strokes to selected piece:

If selected, then any keys pressed in the window will be sent as key commands to the selected piece. Selecting a folder will send the command to all pieces within that folder.

Show right-click menu of piece:

If selected, then right-clicking on a piece in the tree will display its context menu, which can be used to modify the piece or give it a command.

Draw piece images:

If selected, the tree will draw reduced-size images of the piece at the specified zoom factor.

Show zoom in/out buttons:

If selected, + and - buttons will be shown, allowing the user to zoom in/out the size of any icons shown in the inventory window.

Zoom factor:

The magnification factor for drawing pieces in the tree.

Available to these sides:

The Toolbar button will only be visible to the player sides listed here. An empty list makes the button visible to all players.

Refresh hotkey:

Keyboard or Named Command to refresh the display of the Inventory window.