VASSAL Reference Manual

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.

• 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
• CurrentX returns the current map X co-ordinate
• CurrentY returns the current map Y co-ordinate
• DeckName returns the name of the Deck if the piece is currently stacked in one
• Selected returns true when the piece has been selected with the mouse
• PieceId returns a string that uniquely defines the source of the piece. All pieces sourced from the same GamePiece Palette slot will have the same PieceId string.

• OldLocationName returns the name of the previous location, as determined by the local grid
  
• OldMap returns the name of the previous Map Window
  
• OldBoard returns the name of the previous Board
• OldZone returns the name of the previous Zone
• OldX returns the previous map X co-ordinate
• OldY returns the previous map Y co-ordinate