Package VASSAL.counters

Provides classes that define game pieces.

See Also:

GamePiece, Decorator

Interface Summary

Interface	Description
CounterNames
DeckVisitor	For Visitors that are aware of Deck types
EditablePiece	If class implementing GamePiece also implements the EditablePiece interface, then it can be manipulated from the Editor's Configuration Tree via the PieceDefiner dialog.
EventFilter	Gives information about what kinds of events a GamePiece will respond to
GamePiece	Interface to deal with the behaviors of a physical component of the game, or a Trait of one.
Highlighter	An interface that defines how to draw GamePieces that are selected
PieceAccess	Defines ability of a player to access a GamePiece
PieceEditor
PieceFilter	A filter for GamePieces Sample implementations include: PropertyExpression - used for "matching expressions" in Global Key Commands and the like RangeFilter - filters for pieces within range of a point BooleanOrPieceFilter - "OR"s two Filters together to make one Amazing Disjunctive Filter BooleanAndPieceFilter - "AND"s two Filters together and you'd better satisfy both CounterDetailViewer.Filter - Filter created from Mouseover Stack Viewer settings Inventory.Selector - Layered filter for Piece Inventory window
PieceFinder	This interface defines selection criteria for finding a GamePiece in a Map
PieceVisitor	For implementing a somewhat modified Visitor pattern for GamePieces.
Properties	Defines the properties expected to be defined in each GamePiece
PropertyExporter	Interface for classes that can exporty the names and values of the properties they maintain
StateMergeable	GamePieces may implement this interface to implement "merge" functionality of their state.

Class Summary

Class	Description
ActionButton	A Trait (aka Decorator that acts like a button on a GamePiece, such that clicking on a particular area of the piece invokes a key command
ActionButton.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.
BooleanAndPieceFilter	Boolean and of two PieceFilters
BooleanOrPieceFilter	Boolean Or of two PieceFilters
BoundsTracker	Records the bounding boxes of GamePieces.
CalculatedProperty	Conditional Marker A marker with a variable value depending on conditions.
CalculatedProperty.Ed	Trait Editor implementation
Clone	This trait adds a command that creates a duplicate of the selected Gamepiece
Clone.Ed
ColoredBorder
CounterGlobalKeyCommand	Trait that sends a Key Command to other pieces, selected with various filters.
CounterGlobalKeyCommand.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 window
Deck.LoadDeckCommand	Command to set the contents of this deck from a saved file.
DeckVisitorDispatcher	For handling Visitors that are aware of Deck types
Decorator	The abstract class describing a generic 'Trait' of a full GamePiece.
Delete	This trait adds a command that creates a duplicate of the selected Gamepiece
Delete.Ed
Deselect	Implements a trait to allow a piece to be deselected from the KeyBuffer in response to a Key Command.
Deselect.Ed
DragBuffer
DynamicProperty	Trait that contains a property accessible via getProperty() and updatable dynamically via key commands
DynamicProperty.DynamicKeyCommand	DynamicKeyCommand A class that represents an action to be performed on a Dynamic property
DynamicProperty.DynamicKeyCommandConfigurer	Deprecated, for removal: This API element is subject to removal in a future version. Use DynamicKeyCommandConfigurer
DynamicProperty.Ed
Embellishment	The "Layer" trait.
Embellishment.Ed	Return Property names exposed by this trait
Embellishment0	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 moved
Footprint.Ed	Key Command Global Visibility Circle Radius Fill Color Line Color Selected Transparency Unselected Transparency Edge Buffer Display Limit Edge Buffer Point Limit
FreeRotator	A Decorator that rotates a GamePiece to an arbitrary angle
GlobalCommand	The 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	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.
GlobalHotKey	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	The KeyBuffer is the list of "currently selected pieces" in the VASSAL UI (map windows).
KeyCommand
KeyCommandSubMenu	Represents a sub-menu in a GamePiece's right-click drop-down menu
KeySpecifier
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 once
MassPieceLoader	Class to load a directory full of images and create counters
MenuSeparator	This trait adds a command that creates a duplicate of the selected Gamepiece
MenuSeparator.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 a GamePiece
Obscurable
PieceAccess.GlobalAccess	Global utility class to temporarily restrict access to all piece
PieceCloner	Utility class for cloning GamePieces
PieceDefiner	This is the GamePiece designer dialog.
PieceDefiner.Ed	A Dialog for editing an EditablePiece's properties
PieceFinder.DeckOrPieceInStack
PieceFinder.Movable
PieceFinder.PieceInStack
PieceFinder.StackOnly
PieceImage	Deprecated. Use GamePieceOp instead.
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 Stack
PieceVisitorDispatcher	For implementing a modified Visitor pattern on GamePieces.
Pivot	Provides commands to pivot a Game Piece around a given point
Pivot.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 if GameModule.getUserId() matches
PlaySound	A trait that plays a sound clip
PlaySound.Ed
PropertiesPieceFilter	Accepts pieces based on whether the piece has properties that match a given set of conditions
PropertySheet	A Decorator class that endows a GamePiece with a dialog.
RangeFilter	Accepts all pieces within a specified range of a given point on a map
Replace	GamePiece trait that replaces a GamePiece with another one
Replace.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 side
Restricted.Ed
ReturnToDeck	GamePiece trait that returns a piece to a DrawPile
SendToLocation	This trait adds a command that sends a piece to another location.
SendToLocation.Ed
SetGlobalProperty
SetGlobalProperty.Ed
SideAccess	Access is granted if PlayerRoster.getMySide() matches
SimplePieceEditor
SpecifiedSideAccess	Access is granted if PlayerRoster.getMySide() is in a specified list
Stack	A Stack is a collection of pieces in the same location that can often be moved with a single drag-and-drop.
SubMenu	A trait that groups menu items of other traits into a sub-menu
SubMenu.Editor
TableInfo	A Decorator class that endows a GamePiece with an editable spreadsheet (i.e.
TraitConfigPanel	A standardised Panel for use by Trait configurers
TraitLayout	A standardised MigLayout for use by Trait configurers
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 Filter
TriggerAction.Ed
UsePrototype	This trait is a placeholder for a pre-defined series of traits specified in a PrototypeDefinition object.
UsePrototype.Editor

Enum Summary

Enum	Description
GlobalCommandTarget.CompareMode	Comparison Modes for property match
GlobalCommandTarget.GKCtype	Specifies the type of GKC being configured (affects which Target options are allowed)
GlobalCommandTarget.Target	Specifies the kind of target matching