Package VASSAL.counters
package VASSAL.counters
Provides classes that define game pieces.
-
Interface SummaryInterfaceDescriptionFor Visitors that are aware of
DecktypesIf class implementing GamePiece also implements the EditablePiece interface, then it can be manipulated from the Editor's Configuration Tree via thePieceDefinerdialog.Gives information about what kinds of events aGamePiecewill respond toInterface to deal with the behaviors of a physical component of the game, or a Trait of one.An interface that defines how to draw GamePieces that are selectedDefines ability of a player to access a GamePieceA filter for GamePieces Sample implementations include:PropertyExpression- used for "matching expressions" in Global Key Commands and the likeRangeFilter- filters for pieces within range of a pointBooleanOrPieceFilter- "OR"s two Filters together to make one Amazing Disjunctive FilterBooleanAndPieceFilter- "AND"s two Filters together and you'd better satisfy bothCounterDetailViewer.Filter- Filter created from Mouseover Stack Viewer settingsInventory.Selector- Layered filter for Piece Inventory windowThis interface defines selection criteria for finding a GamePiece in a MapFor implementing a somewhat modified Visitor pattern forGamePieces.Defines the properties expected to be defined in each GamePieceInterface for classes that can exporty the names and values of the properties they maintainGamePieces may implement this interface to implement "merge" functionality of their state. -
Class SummaryClassDescriptionA Trait (aka
Decoratorthat acts like a button on a GamePiece, such that clicking on a particular area of the piece invokes a key commandRegisters mouse listeners with Maps and other components.Basic class for representing a physical component of the game.Boolean and of two PieceFiltersBoolean Or of two PieceFiltersRecords the bounding boxes of GamePieces.Conditional Marker A marker with a variable value depending on conditions.Trait Editor implementationThis trait adds a command that creates a duplicate of the selected GamepieceTrait that sends a Key Command to other pieces, selected with various filters.A collection of pieces that behaves like a deck, i.e.: Doesn't move.An object that parses expression strings from the config windowCommand to set the contents of this deck from a saved file.For handling Visitors that are aware ofDecktypesThe abstract class describing a generic 'Trait' of a full GamePiece.This trait adds a command that creates a duplicate of the selected GamepieceImplements a trait to allow a piece to be deselected from the KeyBuffer in response to a Key Command.Trait that contains a property accessible via getProperty() and updatable dynamically via key commandsDynamicKeyCommand A class that represents an action to be performed on a Dynamic propertyDeprecated, for removal: This API element is subject to removal in a future version.The "Layer" trait.Return Property names exposed by this traitEmbellishment has been extensively re-written for Vassal 3.2 changing both the behavior and the visual look of the configurer.Displays a movement trail indicating where a piece has been movedKey Command Global Visibility Circle Radius Fill Color Line Color Selected Transparency Unselected Transparency Edge Buffer Display Limit Edge Buffer Point LimitA Decorator that rotates a GamePiece to an arbitrary angleThe heart of all the different forms of Global Key Command, GlobalCommand handles sending a key command to multiple pieces, potentially on multiple maps, as long as they match its filtering condition.GlobalCommandTarget configures and stores the "Fast Match" parameters of Global Key Commands, allowing certain simple filters to be "pre-matched" without having to initiate the (relatively slower) BeanShell filters.Adds a menu entry that fires a specified key event to the module window.Decorator that filters events to prevent a GamePiece from being selected and/or moved.The KeyBuffer is the list of "currently selected pieces" in the VASSAL UI (map windows).Represents a sub-menu in a GamePiece's right-click drop-down menuDisplays a text label, with content specified by the user at runtime.A generic Decorator that retains in its state the value of a property.Edits an entire set of GamePieces at onceClass to load a directory full of images and create countersThis trait adds a command that creates a duplicate of the selected GamepieceA GamePiece with this trait will automatically be marked whenever it is moved.A trait for assigning an arbitrary shape to aGamePieceGlobal utility class to temporarily restrict access to all pieceUtility class for cloningGamePiecesThis is the GamePiece designer dialog.A Dialog for editing an EditablePiece's propertiesContents of the Copy/Paste buffer for traits in the editorDeprecated.UseGamePieceOpinstead.An iterator for GamePieces.Sorts GamePieces according to their position: If on different Maps, order by Map id If in different Stacks order by Stack position on the Map If in the same Stack, order by position within the StackFor implementing a modified Visitor pattern onGamePieces.Provides commands to pivot a Game Piece around a given pointThis Decorator defines a key command to places another counter on top of this one.Access is granted ifGameModule.getUserId()matchesA trait that plays a sound clipAccepts pieces based on whether the piece has properties that match a given set of conditionsA Decorator class that endows a GamePiece with a dialog.Accepts all pieces within a specified range of a given point on a mapGamePiece trait that replaces a GamePiece with another oneA GamePiece with this trait will echo the piece's current name when any of a given key commands are pressed (and after they take effect)RestrictCommands Restrict the availability of Key Commands, depending on a Property Match String.A GamePiece with the Restricted trait can only be manipulated by the player playing a specific sideGamePiece trait that returns a piece to aDrawPileThis trait adds a command that sends a piece to another location.Access is granted ifPlayerRoster.getMySide()matchesAccess is granted ifPlayerRoster.getMySide()is in a specified listA Stack is a collection of pieces in the same location that can often be moved with a single drag-and-drop.A trait that groups menu items of other traits into a sub-menuA Decorator class that endows a GamePiece with an editable spreadsheet (i.e.A standardised Panel for use by Trait configurersA standardised MigLayout for use by Trait configurersA trait to expose a translated string as a readable/displayable property.Give a piece a command that moves it a fixed amount in a particular direction, optionally tracking the current rotation of the piece.Batches up all the movement commands resulting from a single KeyEvent and executes them at once.Macro Execute a series of Keystrokes against this same piece - Triggered by own KeyCommand or list of keystrokes - Match against an optional Property FilterThis trait is a placeholder for a pre-defined series of traits specified in aPrototypeDefinitionobject. -
Enum Class SummaryEnum ClassDescriptionComparison Modes for property matchSpecifies the type of GKC being configured (affects which Target options are allowed)Specifies the kind of target matching
DynamicKeyCommandConfigurer