PieceWindow

From VASSAL
Jump to: navigation, search

VASSAL Reference Manual

Home > Module > Game Piece Palette


Game Piece Palette

The Game Piece Palette is a panel that contains game pieces which the players may drag to the playing area during a game.   An unlimited supply of each Game Piece is available through the palette  If you need to limit the number of pieces available during play, use a Deck, an At-Start Stack, or Default Setups.

If the player has the Use combined application window preference checked, then the first Game Piece Palette in the module will dock into the main controls window to the left of the chat area.   All others will appear in their own window.

Name:   If the palette appears in its own window, this will be used for the title.
Hidden:   If checked, then this Game Piece Palette will not appear at all during play.   This is useful if you need to define pieces for a Default Setup but don't want to allow players to create new pieces during play.   You must restart VASSAL for this change to take effect.
Button Text:   The text on the toolbar button that shows and hides the Game Piece Palette.
Button Icon:  
The icon image on the toolbar button.
Hotkey:   A keyboard shortcut for the toolbar button.

The Game Piece Palette is highly configurable, and can can contain any combination of tabs, lists, and pull-down menus containing individual Game Pieces.   For example, the window may contain a tabbed pane with two entries, called "Info" and "Armies", each of which contain a list of pieces.   Every component in the toolbar should end with a Single Piece.   Since a typical game has many pieces that differ in only minor ways, you may find it convenient to clone Single Pieces.   Also, the order of the pieces can be changed by dragging them within the configuration tree.


PieceWindow.png


Single Piece

A Game Piece that can be dragged onto a playing area. Cannot contain any sub-components.

Container Components

NameFieldOnly.png
Container components can contain any combination of each other
Each container component of a Game Piece Palette can contain any combination of the other sub-components. They can only take one option; the "Name" field.

Pull-down menu

A pull-down menu in which each menu item corresponds to a subcomponent.  The name of the menu item will be the name of the subcomponent.

Scrollable List

A scroll list in which each entry corresponds to a subcomponent.  The name of the entry will be the name of the subcomponent.

Tabbed Pane

A panel with tabs, each of which corresponds to a Chart, Panel, or other Tabbed Pane subcomponent.  The label of the tab will be the name of the subcomponent.
PanelWidget.png
PanelWidget2.png

Panel

A panel that can contain Single Pieces, , Tabbed Panes, or other panels.  The "Fixed cell size" box allows you to specify a fixed number of columns that the panel will have.  Otherwise, the subcomponents will appear in a single row, or a single column if the "Vertical layout" box is checked.