Package VASSAL.counters
Provides classes that define game pieces.
-
Interface Summary Interface Description CounterNames DeckVisitor For Visitors that are aware ofDecktypesEditablePiece If a GamePiece implements the EditablePiece interface, then it can be manipulated from the Configuration Tree via the PieceDefiner dialog.EventFilter Gives information about what kinds of events aGamePiecewill respond toGamePiece Basic class for representing a physical component of the gameHighlighter An interface that defines how to draw GamePieces that are selectedPieceAccess Defines ability of a player to access a GamePiecePieceEditor PieceFilter A filter for GamePiecesPieceFinder This interface defines selection criteria for finding a GamePiece in a MapPieceVisitor For implementing a somewhat modified Visitor pattern forGamePieces.Properties Defines the properties expected to be defined in each GamePiecePropertyExporter Interface for classes that can exporty the names and values of the properties they maintainStateMergeable GamePieces may implement this interface to implement "merge" functionality of their state. -
Class Summary Class Description ActionButton A trait that acts like a button on a GamePiece, such that clicking on a particular area of the piece invokes a keyboard commandActionButton.ButtonPusher Registers mouse listeners with Maps and other components.ActionButton.Ed AreaOfEffect AreaOfEffect.TraitEditor BasicPiece Basic class for representing a physical component of the game Can be a counter, a card, or an overlayBooleanAndPieceFilter Boolean and of two PieceFiltersBooleanOrPieceFilter Boolean Or of two PieceFiltersBoundsTracker Records the bounding boxes of GamePieces.CalculatedProperty Conditional Marker A marker with a variable value depending on conditions.CalculatedProperty.Ed Trait Editor implementationClone This trait adds a command that creates a duplicate of the selected GamepieceClone.Ed ColoredBorder CounterGlobalKeyCommand Adds a menu item that applies aGlobalCommandto other piecesCounterGlobalKeyCommand.Ed Deck A collection of pieces that behaves like a deck, i.e.: Doesn't move.Deck.CountExpression An object that parses expression strings from the config windowDeck.LoadDeckCommand Command to set the contents of this deck from a saved file.DeckVisitorDispatcher For handling Visitors that are aware ofDecktypesDecorator The abstract class describing a generic 'trait' of a GamePiece.Delete This trait adds a command that creates a duplicate of the selected GamepieceDelete.Ed DragBuffer DynamicProperty Trait that contains a property accessible via getProperty() and updateable dynamically via key commandsDynamicProperty.DynamicKeyCommand DynamicKeyCommand A class that represents an action to be performed on a Dynamic propertyDynamicProperty.DynamicKeyCommandConfigurer Configure a single Dynamic Key Command lineDynamicProperty.Ed Embellishment The "Layer" trait.Embellishment.Ed Return Property names exposed by this traitEmbellishment0 Embellishment has been extensively re-written for Vassal 3.2 changing both the behavior and the visual look of the configurer.Footprint Displays a movement trail indicating where a piece has been movedFootprint.Ed Key Command Global Visibility Circle Radius Fill Color Line Color Selected Transparency Unselected Transparency Edge Buffer Display Limit Edge Buffer Point LimitFreeRotator A Decorator that rotates a GamePiece to an arbitrary angleGlobalCommand Applies a given keyboard command to all counters on a mapGlobalHotKey Adds a menu entry that fires a specified key event to the module window.GlobalHotKey.Ed Hideable Hideable.Ed ImagePicker Immobilized Decorator that filters events to prevent a GamePiece from being selected and/or moved.KeyBuffer KeyCommand KeyCommandSubMenu Represents a sub-menu in a GamePiece's right-click drop-down menuKeySpecifier Labeler Displays a text label, with content specified by the user at runtime.Labeler.HTMLLabelOp Labeler.LabelOp Marker A generic Decorator that retains in its state the value of a property.MassPieceDefiner Edits an entire set of GamePieces at onceMassPieceLoader Class to load a directory full of images and create countersMenuSeparator This trait adds a command that creates a duplicate of the selected GamepieceMenuSeparator.Ed MovementMarkable A GamePiece with this trait will automatically be marked whenever it is moved.MultiImagePicker NonRectangular A trait for assigning an arbitrary shape to aGamePieceObscurable PieceAccess.GlobalAccess Global utility class to temporarily restrict access to all piecePieceCloner Utility class for cloningGamePiecesPieceDefiner This is the GamePiece designer dialog.PieceDefiner.Ed A Dialog for editing an EditablePiece's propertiesPieceFinder.DeckOrPieceInStack PieceFinder.Movable PieceFinder.PieceInStack PieceFinder.StackOnly PieceImage Deprecated. PieceIterator An iterator for GamePieces.PieceSorter 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 StackPieceVisitorDispatcher For implementing a modified Visitor pattern onGamePieces.Pivot Provides commands to pivot a Game Piece around a given pointPivot.Ed PlaceMarker This Decorator defines a key command to places another counter on top of this one.PlaceMarker.Ed PlaceMarker.Ed.ChoosePieceDialog PlayerAccess Access is granted ifGameModule.getUserId()matchesPlaySound A trait that plays a sound clipPlaySound.Ed PropertiesPieceFilter Accepts pieces based on whether the piece has properties that match a given set of conditionsPropertySheet A Decorator class that endows a GamePiece with a dialog.RangeFilter Accepts all pieces within a specified range of a given point on a mapReplace GamePiece trait that replaces a GamePiece with another oneReplace.Ed ReportState A 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)ReportState.Ed RestrictCommands RestrictCommands Restrict the availability of Key Commands, depending on a Property Match String.RestrictCommands.Ed Restricted A GamePiece with the Restricted trait can only be manipulated by the player playing a specific sideRestricted.Ed ReturnToDeck GamePiece trait that returns a piece to aDrawPileSendToLocation This trait adds a command that sends a piece to another location.SendToLocation.Ed SetGlobalProperty SetGlobalProperty.Ed SideAccess Access is granted ifPlayerRoster.getMySide()matchesSimplePieceEditor SpecifiedSideAccess Access is granted ifPlayerRoster.getMySide()is in a specified listStack A collection of GamePieces which can be moved as a single unitSubMenu A trait that groups menu items of other traits into a sub-menuSubMenu.Editor TableInfo A Decorator class that endows a GamePiece with an editable spreadsheet (i.e.Translate Give a piece a command that moves it a fixed amount in a particular direction, optionally tracking the current rotation of the piece.Translate.Editor Translate.MoveExecuter Batches up all the movement commands resulting from a single KeyEvent and executes them at once.TriggerAction Macro Execute a series of Keystrokes against this same piece - Triggered by own KeyCommand or list of keystrokes - Match against an optional Property FilterTriggerAction.Ed UsePrototype This trait is a placeholder for a pre-defined series of traits specified in aPrototypeDefinitionobject.UsePrototype.Editor
GamePieceOpinstead.