Package VASSAL.build.module.map
package VASSAL.build.module.map
Contains classes that may be added to a
Map.
-
Interface SummaryInterfaceDescriptionA component may implement the Drawable interface if it has graphical information the should be drawn whenever the Map is drawn.Pieces that contribute to shading must implement this interface
-
Class SummaryClassDescriptionBase class for PieceCollection implementation that organizes
GamePieces -- a category which in this case also includes Decks and Stacks, in addition to ordinary pieces -- into distinct visual layers.This is aDrawableclass that draws the counters horizontally when the mouse is held over a stack with the control key down.This version ofMassKeyCommandis added to aDrawPile(which holds aDeck) and applies to pieces/cards currently in the deck.Maps now start with a Game Piece Layers component (i.e.generates a prompt with the names of all decks already definedAllows 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).A configurer for different combinations of modifier keyA configurer for our reportFormat, which includes the unique $FlareLocation$, $FlareZone$, $FlareMap$ properties as well as $PlayerName$ and $PlayerSide$ in the "Insert" pulldown.This is scaled version of aMapthat gives an overview.Handles the drawing of cards in aPlayerHand.This removes all game pieces from the (@link Map) therefore providing an un-cluttered view.This allows the user to capture a snapshot of the entire map into a PNG file.Deprecated, for removal: This API element is subject to removal in a future version.Selects and unselects pieces on the map, using the mouse.Adds a button to the toolbar to manipulate Game Piece LayersThe 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 theMapto which a LayeredPieceCollection has been added.A class that allows the user to draw a straight line on a Map (LOS = Line Of Sight).Deprecated, for removal: This API element is subject to removal in a future version.Centers the map when user right-clicks on an empty hexDraw shaded regions on a map.Deprecated, for removal: This API element is subject to removal in a future version.Adds a button to a map window toolbar.Deprecated, for removal: This API element is subject to removal in a future version.Builds an auto-report message for a collection of Move CommandsA version of the MovementReporter for reporting the movement of Invisible pieces.PieceMover 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.Special MacOSX variant of DragHandler, because of differences in how device scaling is handled.Fallback drag-handler when DragImage not supported by JRE.Adds a button to a Maps toolbar that adjusts the positions of all pieces so that their centroid is at the center of the mapDeprecated, for removal: This API element is subject to removal in a future version.This component listens to key events on a Map window and scrolls the map.This is the "At-Start Stack" component, which initializes a Map or Board with a specified stack.A SimplePieceCollection is used within aCompoundPieceCollectionto maintain an array of the pieces/stacks/decks (GamePiece) within a single visual layer.Bogus extension of list that takes up less space.StackMetrics provides the [Stacking options] component of aMap.Deprecated, for removal: This API element is subject to removal in a future version.Controls the zooming in/out of aMapwindow.Stores the state information for theZoomer.