Package VASSAL.build.module.map

Contains classes that may be added to a Map.

See:
Description

Interface Summary

Drawable	A component may implement the Drawable interface if it has graphical information the should be drawn whenever the Map is drawn.
PieceCollection	Manages a collection of GamePieces in a Map

Class Summary

BoardPicker	This class is responsible for maintaining the Boards on a Map.
BoardPicker.SetBoards
CounterDetailViewer	This is a Drawable class that draws the counters horizontally when the mouse is held over a stack with the control key down.
DefaultPieceCollection	Default implementation of PieceCollection separates pieces into two layers: stacking pieces always above non-stacking pieces
DrawPile
DrawPile.AssignedDeckPrompt	generates a prompt with the names of all decks already defined
DrawPile.FormattedStringConfig
DrawPile.PlaceDeck	Only necessary for backward compatibility
DrawPile.Prompt
ForwardToChatter	This KeyListener forwards key event from a Map to the Chatter The event is forwarded only if not consumed
ForwardToKeyBuffer	This KeyListener forwards key event from a Map to the KeyBuffer, where it is given to selected GamePieces to interpret.
GlobalMap	This is scaled version of a Map that gives an overview.
GlobalMap.IconConfig
HandMetrics	Handles the drawing of cards in a PlayerHand.
HidePiecesButton	This removes all game pieces from the (@link Map) therefore providing an un-cluttered view.
HidePiecesButton.HiddenIconConfig
HidePiecesButton.ShowingIconConfig
ImageSaver	This allows the user to capture a snapshot of the entire map into a PNG file
KeyBufferer	This component listens for mouse clicks on a map.
LOS_Thread	A class that allows the user to draw a straight line on a Map (LOS = Line Of Sight).
MapCenterer	Centers the map when user right-clicks on an empty hex
MassKeyCommand	Adds a button to a map window toolbar.
MassKeyCommand.IconConfig
MassKeyCommand.Prompt
MassKeyCommand.ReportFormatConfig
MenuDisplayer
MineaturesPieceMover	Moves pieces on a map with an interface appropriate for mineatures-type games.
PieceMover	This is a MouseListener that moves pieces onto a Map window
PieceMover.DragHandler	Implements a psudo-cursor that follows the mouse cursor when user drags gamepieces.
Scroller	This component listens to key events on a Map window and scrolls the map.
SetupStack	This is the "At-Start Stack" component, which initializes a Map or Board with a specified stack.
SetupStack.MarkInitialized	This command indicates that a Stack has been created already in a saved game, so there is no need to initialized a new one when the game is opened.
SetupStack.OwningBoardPrompt
SimplePieceCollection	Stores GamePieces in a simple array
SmallList
StackExpander
StackMetrics	Encapsulates information on how to draw expanded and unexpanded views of a stack
TextSaver
Zoomer	Controls the zooming in/out of a Map Window

Package VASSAL.build.module.map Description

Contains classes that may be added to a Map.