VASSAL Reference Manual

Mat

Mats are generally larger pieces that are designed to have smaller pieces (Mat Cargo) placed on top of them, and for the cargo pieces to move along with the Mat and maintain their relative position.

When a Game Piece with this trait is selected by left-clicking on it, any game pieces with the Mat Cargo trait that have been placed on top of the Mat piece will also become selected automatically. Therefore if the Mat game piece is then moved with a drag-and-drop, the cargo pieces conveniently move along with it and maintain their relative positions.

Similarly, when a Mat piece is moved with a Send to Location trait or a Move Fixed Distance trait, cargo pieces on top of it will follow.

If a Mat piece is rotated or pivoted, any cargo pieces on top can also match their facing to the Mat, if that option is selected in the Mat Cargo trait.

Mat name:

An identifier for the Mat. This is exposed to the module via the MatName property, and is also used when filling the CurrentMat property of Mat Cargo pieces.

Description:

Description of the trait - displayed only in the Editor, in the piece definer dialog.

Mat

Mat2

A Mat and its Mat Cargo pieces rotated 45 degrees in Almoravid

Properties

A Mat trait exposes the following Properties:

  • MatName contains the name of the Mat, taken from the Mat Name field.

  • MatID contains a unique identifying string for the Mat piece: even two pieces sharing the same Mat Name will have different Mat ID’s.

  • MatNumCargo contains the number of Mat Cargo pieces currently sitting on this mat.