VASSAL Reference Manual

Home > Module > Game Piece Palette > Game Piece > Basic Piece

Basic Piece

The simplest game piece consists of an image and a name.  Select the image by double-clicking on the box to the left, or select an image that has already been added from the drop-down menu.




The following Properties are defined in a Basic Piece:
  • BasicName returns the name of Basic Piece trait, as specified in the properties
  • PieceName returns the full name of the piece, including all traits
  • PlayerSide returns the side of the current player, as specified in the Definition of Player Sides
  • LocationName returns the name of the current location, as determined by the local grid
  • CurrentMap returns the name of the current Map Window
  • CurrentBoard returns the name of the current Board
  • CurrentZone returns the name of the current Zone
  • Selected returns true when the piece has been selected with the mouse