Package VASSAL.build.module.map
Contains classes that may be added to a
Map.
-
Interface Summary Interface Description Drawable A component may implement the Drawable interface if it has graphical information the should be drawn whenever the Map is drawn.MapShader.ShadedPiece Pieces that contribute to shading must implement this interfacePieceCollection -
Class Summary Class Description BoardPicker BoardPicker.SetBoards CompoundPieceCollection Base class for PieceCollection implementation that organizesGamePieces -- a category which in this case also includes Decks and Stacks, in addition to ordinary pieces -- into distinct visual layers.CounterDetailViewer This is aDrawableclass that draws the counters horizontally when the mouse is held over a stack with the control key down.CounterDetailViewer.CounterFormatConfig CounterDetailViewer.DisplayConfig CounterDetailViewer.EmptyFormatConfig CounterDetailViewer.MinConfig CounterDetailViewer.ReportFormatConfig CounterDetailViewer.Visitor DeckGlobalKeyCommand This version ofMassKeyCommandis added to aDrawPile(which holds aDeck) and applies to pieces/cards currently in the deck.DeckGlobalKeyCommand.DeckGlobalCommand DeckGlobalKeyCommand.DeckPolicyConfig2 DefaultPieceCollection Maps now start with a Game Piece Layers component (i.e.DrawPile DrawPile.AssignedDeckPrompt generates a prompt with the names of all decks already definedDrawPile.FormattedStringConfig DrawPile.PiecePropertyConfig DrawPile.Prompt Flare Allows 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).Flare.FlareKeyConfig A configurer for different combinations of modifier keyFlare.ReportFormatConfig A configurer for our reportFormat, which includes the unique $FlareLocation$, $FlareZone$, $FlareMap$ properties as well as $PlayerName$ and $PlayerSide$ in the "Insert" pulldown.ForwardToChatter ForwardToKeyBuffer GlobalMap This is scaled version of aMapthat gives an overview.GlobalMap.IconConfig HandMetrics Handles the drawing of cards in aPlayerHand.HidePiecesButton This removes all game pieces from the (@link Map) therefore providing an un-cluttered view.HidePiecesButton.HiddenIconConfig HidePiecesButton.ShowingIconConfig HighlightLastMoved ImageSaver This allows the user to capture a snapshot of the entire map into a PNG file.ImageSaver.IconConfig Deprecated, for removal: This API element is subject to removal in a future version. KeyBufferer Selects and unselects pieces on the map, using the mouse.LayerControl Adds a button to the toolbar to manipulate Game Piece LayersLayerControl.CommandConfig LayeredPieceCollection The 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.LayeredPieceCollection.Collection The PieceCollection class used by theMapto which a LayeredPieceCollection has been added.LOS_Thread A class that allows the user to draw a straight line on a Map (LOS = Line Of Sight).LOS_Thread.GlobalOptions LOS_Thread.IconConfig Deprecated, for removal: This API element is subject to removal in a future version. LOS_Thread.LOSCommand LOS_Thread.PersistenceOptions LOS_Thread.ReportFormatConfig LOS_Thread.RoundingOptions MapCenterer Centers the map when user right-clicks on an empty hexMapShader Draw shaded regions on a map.MapShader.BoardPrompt MapShader.IconConfig Deprecated, for removal: This API element is subject to removal in a future version. MapShader.PatternPrompt MapShader.TypePrompt MassKeyCommand Adds a button to a map window toolbar.MassKeyCommand.DeckPolicyConfig MassKeyCommand.IconConfig Deprecated, for removal: This API element is subject to removal in a future version. MassKeyCommand.Prompt MassKeyCommand.ReportFormatConfig MenuDisplayer MovementReporter Builds an auto-report message for a collection of Move CommandsMovementReporter.HiddenMovementReporter A version of the MovementReporter for reporting the movement of Invisible pieces.MovementReporter.HiddenMoveSummary MovementReporter.MoveSummary PieceMover PieceMover handles the "Drag and Drop" of pieces and stacks, onto or within a Map window.PieceMover.AbstractDragHandler Common functionality for DragHandler for cases with and without drag image support.PieceMover.DragHandler VASSAL's front-line drag handler for drag-and-drop of pieces.PieceMover.DragHandlerMacOSX Special MacOSX variant of DragHandler, because of differences in how device scaling is handled.PieceMover.DragHandlerNoImage Fallback drag-handler when DragImage not supported by JRE.PieceRecenterer Adds a button to a Maps toolbar that adjusts the positions of all pieces so that their centroid is at the center of the mapPieceRecenterer.IconConfig Deprecated, for removal: This API element is subject to removal in a future version. Scroller This component listens to key events on a Map window and scrolls the map.SelectionHighlighter SelectionHighlighter.IconConfig SelectionHighlighters SetupStack This is the "At-Start Stack" component, which initializes a Map or Board with a specified stack.SetupStack.OwningBoardPrompt SetupStack.View SimplePieceCollection A SimplePieceCollection is used within aCompoundPieceCollectionto maintain an array of the pieces/stacks/decks (GamePiece) within a single visual layer.SmallList Bogus extension of list that takes up less space.StackExpander StackMetrics StackMetrics provides the [Stacking options] component of aMap.TextSaver TextSaver.IconConfig Deprecated, for removal: This API element is subject to removal in a future version. Zoomer Controls the zooming in/out of aMapwindow.Zoomer.InIconConfig Zoomer.LevelConfig Zoomer.LevelConfigurer Zoomer.OutIconConfig Zoomer.PickIconConfig Zoomer.State Stores the state information for theZoomer.