Uses of Package
VASSAL.build.module.map
Package
Description
Contains classes that may be added to a
GameModule
.Contains classes that may be added to a
Map
.Contains classes that may be added to a
BoardPicker
.Provides classes that implement the "Command" design pattern.
Provides classes that define game pieces.
-
ClassDescriptionA component may implement the Drawable interface if it has graphical information the should be drawn whenever the Map is drawn.Selects and unselects pieces on the map, using the mouse.Adds a button to a map window toolbar.PieceMover handles the "Drag and Drop" of pieces and stacks, onto or within a Map window.StackMetrics provides the [Stacking options] component of a
Map
.Controls the zooming in/out of aMap
window. -
ClassDescriptionBase class for PieceCollection implementation that organizes
GamePiece
s -- a category which in this case also includes Decks and Stacks, in addition to ordinary pieces -- into distinct visual layers.This is aDrawable
class that draws the counters horizontally when the mouse is held over a stack with the control key down.Utility class to select the pieces we wish to view.This version ofMassKeyCommand
is added to aDrawPile
(which holds aDeck
) and applies to pieces/cards currently in the deck.A component may implement the Drawable interface if it has graphical information the should be drawn whenever the Map is drawn.The Map view that appears inside the ScrollPaneThe optional "Game Piece Layers" component of a Map which allows pieces on the map to be assigned to an arbitrary number of visual layers according to a property setting.The PieceCollection class used by theMap
to which a LayeredPieceCollection has been added.A class that allows the user to draw a straight line on a Map (LOS = Line Of Sight).Draw shaded regions on a map.Adds a button to a map window toolbar.Builds an auto-report message for a collection of Move CommandsPieceMover handles the "Drag and Drop" of pieces and stacks, onto or within a Map window.Common functionality for DragHandler for cases with and without drag image support.VASSAL's front-line drag handler for drag-and-drop of pieces.This is the "At-Start Stack" component, which initializes a Map or Board with a specified stack.A SimplePieceCollection is used within aCompoundPieceCollection
to maintain an array of the pieces/stacks/decks (GamePiece
) within a single visual layer.StackMetrics provides the [Stacking options] component of aMap
.Controls the zooming in/out of aMap
window.Stores the state information for theZoomer
.The menu which displays zoom levels. -
-
ClassDescriptionAllows a player to ping a location ("send up a flare") by clicking on a map with the correct modifier key combination held down (default: Alt+LeftClick).
-
ClassDescriptionThis version of
MassKeyCommand
is added to aDrawPile
(which holds aDeck
) and applies to pieces/cards currently in the deck.A component may implement the Drawable interface if it has graphical information the should be drawn whenever the Map is drawn.Draw shaded regions on a map.Pieces that contribute to shading must implement this interfaceStackMetrics provides the [Stacking options] component of aMap
. -
ClassDescriptionThe optional "Game Piece Layers" component of a Map which allows pieces on the map to be assigned to an arbitrary number of visual layers according to a property setting.
-
ClassDescriptionThis is the "At-Start Stack" component, which initializes a Map or Board with a specified stack.