Handy Combined List of VASSAL-defined Properties for Game Pieces
Property |
Trait |
Description |
BasicName |
Basic Piece |
The basic name of the piece. |
ClickedX | Basic
Piece | Map X-coordinate where player last right-clicked on piece to bring up context menu (or 0 if never). |
ClickedY | Basic
Piece | Map Y-coordinate where player last right-clicked on piece to bring up context menu (or 0 if never). |
CurrentBoard
| Basic Piece |
Current Board name or "" if not on a map. |
CurrentMap | Basic
Piece | Current Map name or "" if not on a map. |
CurrentX | Basic
Piece | Current X-coordinate of the piece. |
CurrentY | Basic
Piece | Current Y-coordinate of the piece. |
CurrentZone | Basic
Piece | Current Zone name if the current map has a multi-zoned grid, or "" if
the piece is not in any zone, or not on a map. |
DeckName | Basic
Piece | Current Deck name if stacked in a
Deck, or "" if not in a Deck. |
IgnoreGrid | Does not stack | "true" if this piece ignores the map grid when moving. |
Immobile | Does not stack | "true" if this piece cannot be moved by drag and drop. |
Invisible | Invisible | "true" if this piece is invisible to the current player. |
InvisibleToOthers | Invisible | "true" if this piece is invisible to
other players. |
LocationName |
Basic Piece | Name of the piece's current location, as determined by the map's Zone
(if any) and grid settings. |
Moved | Mark When Moved | "true" if this piece has moved since the last time its movement
history was cleared. |
NoStack | Does not stack | "true" if this piece cannot stack with other pieces. |
Obscured | Mask | "true" if this piece is masked from the current player. |
ObscuredToOthers |
Mask | "true" if this piece is masked from other players. |
OldBoard | Basic
Piece | Board name prior to most recent movement. |
OldLocationName |
Basic Piece | Location name prior to most recent movement. |
OldMap | Basic
Piece | Map name prior to most recent movement. |
OldX | Basic Piece
| X coordinate prior to most recent movement. |
OldY | Basic Piece
| Y coordinate prior to most recent movement. |
OldZone | Basic
Piece | Zone name prior to most recent movement. |
PieceName | Basic
Piece | Full piece name including both Basic Name and all additional strings provided by traits. |
playerSide | Basic
Piece | Side of the current player (not the side of the piece). |
Restricted | Restricted Access | "true" if there are restrictions as to who can access
this piece. |
Selected | Basic
Piece | "true" if the piece is currently selected. |
<property_name> | PropertySheet | The value of each property on
the Property Sheet can be accessed via the property name. |
<layername>_Active | Layer | "true" if the Layer <layername> is
currently active. |
<layername>_Image | Layer | The image name of the currently active layer
for Layer <layername>. |
<layername>_Level | Layer | The level number of the currently active layer
for Layer
<layername>. |
<layername>_Name | Layer | The level name of the currently active layer
for Layer <layername>. |
<rotatename>_Facing | Can Rotate | The current facing number (1, 2, etc) for
the Can Rotate trait <rotatename>. |
<rotatename>_Degrees | Can Rotate | The current degrees of rotation for the
Can Rotate trait <name>. |
<Property Name> | Text Label | If the "Property Name" field in the trait
is filled out, then a property with that name will be filled with the current value of the Text Label
trait's Text field. |
<deckname>_numPieces | Deck (Map level property) | Number of pieces/"cards" in
the Deck <deckname>. |
<deckname>_<expression_name> | Deck (Map level property) | The number of pieces/"cards"
for which the named expression evaluates to true in the Deck <deckname>. |