Uses of Package
VASSAL.counters

Packages that use VASSAL.counters

Package	Description
VASSAL.build	Provides classes for building Java instances automatically from XML files.
VASSAL.build.module	Contains classes that may be added to a GameModule.
VASSAL.build.module.index
VASSAL.build.module.map	Contains classes that may be added to a Map.
VASSAL.build.module.map.deck
VASSAL.build.module.properties
VASSAL.build.module.turn
VASSAL.build.widget	Contains classes that can be added to a Widget.
VASSAL.command	Provides classes that implement the "Command" design pattern.
VASSAL.configure	Provides classes for building "Edit Property" dialogs, and for editing GameModule's and ModuleExtension's.
VASSAL.counters	Provides classes that define game pieces.
VASSAL.i18n
VASSAL.script
VASSAL.script.expression
VASSAL.script.proxy
VASSAL.tools	Contains various utility classes.
VASSAL.tools.imageop
VASSAL.tools.imports.adc2

Classes in VASSAL.counters used by VASSAL.build

Class	Description
DeckManager
Decorator	The abstract class describing a generic 'Trait' of a full GamePiece.
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.
GamePiece	Interface to deal with the behaviors of a physical component of the game, or a Trait of one.
KeyCommand

Classes in VASSAL.counters used by VASSAL.build.module

Class	Description
Attachment	Trait allowing creation of an "attachment" to one or more other pieces, which can then be sent GKCs very swiftly and whose properties can be easily read (and if a Dynamic Property can also be set with a Set Global Property trait)
Deck	A collection of pieces that behaves like a deck, i.e.: Doesn't move.
DeckVisitor	For Visitors that are aware of Deck types
Decorator	The abstract class describing a generic 'Trait' of a full GamePiece.
GamePiece	Interface to deal with the behaviors of a physical component of the game, or a Trait of one.
GlobalCommandTarget.GKCtype	Specifies the type of GKC being configured (affects which Target options are allowed)
Highlighter	An interface that defines how to draw GamePieces that are selected
PieceDefiner	This is the GamePiece designer dialog.
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.
PieceVisitorDispatcher	For implementing a modified Visitor pattern on GamePieces.
Stack	A Stack is a collection of pieces in the same location that can often be moved with a single drag-and-drop.

Classes in VASSAL.counters used by VASSAL.build.module.index

Class	Description
GamePiece	Interface to deal with the behaviors of a physical component of the game, or a Trait of one.

Classes in VASSAL.counters used by VASSAL.build.module.map

Class	Description
ColoredBorder
Deck	A collection of pieces that behaves like a deck, i.e.: Doesn't move.
DeckVisitor	For Visitors that are aware of Deck types
DeckVisitorDispatcher	For handling Visitors that are aware of Deck types
GamePiece	Interface to deal with the behaviors of a physical component of the game, or a Trait of one.
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.
GlobalCommandTarget.GKCtype	Specifies the type of GKC being configured (affects which Target options are allowed)
Highlighter	An interface that defines how to draw GamePieces that are selected
KeyCommand
Mat	Designates the piece as a "Mat" on which other pieces ("Cargo") can be placed.
MatCargo	Designates the piece as "Cargo", which can be placed on a "Mat" to move along with it
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
PieceFinder.Movable
PieceVisitor	For implementing a somewhat modified Visitor pattern for GamePieces.
PieceVisitorDispatcher	For implementing a modified Visitor pattern on GamePieces.
Stack	A Stack is a collection of pieces in the same location that can often be moved with a single drag-and-drop.

Classes in VASSAL.counters used by VASSAL.build.module.map.deck

Class	Description
Deck	A collection of pieces that behaves like a deck, i.e.: Doesn't move.
GamePiece	Interface to deal with the behaviors of a physical component of the game, or a Trait of one.
KeyCommand

Classes in VASSAL.counters used by VASSAL.build.module.properties

Class	Description
DynamicProperty	Trait that contains a property accessible via getProperty() and updatable dynamically via key commands
GamePiece	Interface to deal with the behaviors of a physical component of the game, or a Trait of one.

Classes in VASSAL.counters used by VASSAL.build.module.turn

Class	Description
BasicPiece	Basic class for representing a physical component of the game.

Classes in VASSAL.counters used by VASSAL.build.widget

Class	Description
GamePiece	Interface to deal with the behaviors of a physical component of the game, or a Trait of one.

Classes in VASSAL.counters used by VASSAL.command

Class	Description
GamePiece	Interface to deal with the behaviors of a physical component of the game, or a Trait of one.
PieceVisitorDispatcher	For implementing a modified Visitor pattern on GamePieces.

Classes in VASSAL.counters used by VASSAL.configure

Class	Description
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
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.
GamePiece	Interface to deal with the behaviors of a physical component of the game, or a Trait of one.
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.
PieceAccess	Defines ability of a player to access a GamePiece
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
TraitConfigPanel	A standardised Panel for use by Trait configurers
TraitLayout	A standardised MigLayout for use by Trait configurers

Classes in VASSAL.counters used by VASSAL.counters

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
Attachment	Trait allowing creation of an "attachment" to one or more other pieces, which can then be sent GKCs very swiftly and whose properties can be easily read (and if a Dynamic Property can also be set with a Set Global Property trait)
BasicName	This trait overrides the $BasicName$ property provided by the "Basic Piece", allowing a module designer decking to define pieces entirely by prototype to safely ignore and leave empty the Basic Piece.
BorderOutline.LogicalCompareMode	Comparison Modes for property match
BoundsTracker	Records the bounding boxes of GamePieces.
CalculatedProperty	Conditional Marker A marker with a variable value depending on conditions.
Clone	This trait adds a command that creates a duplicate of the selected Gamepiece
Comment	A trait that exists in a Piece Definition, but is not included when the piece is created in a real game.
CounterGlobalKeyCommand	Trait that sends a Key Command to other pieces, selected with various filters.
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
DeckVisitor	For Visitors that are aware of Deck types
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
Deselect	Implements a trait to allow a piece to be deselected from the KeyBuffer in response to a Key Command.
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
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.
Embellishment	d/b/a "Layer" The "Layer" trait.
EventFilter	Gives information about what kinds of events a GamePiece will respond to
Footprint	Displays a movement trail indicating where a piece has been moved
FreeRotator	d/b/a "Can Rotate" A Decorator that rotates a GamePiece to an arbitrary angle
GamePiece	Interface to deal with the behaviors of a physical component of the game, or a Trait of one.
GlobalAttach	Variant on GlobalCommand for use with Attachment -- instead of sending a key, finds pieces and attaches them
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.
GlobalCommand.IndexedFastmatchDeckPolicyManager.DeckInfo	Class to track the acceptance count of pieces from multiple Decks
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.
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
GlobalCommandVisitor	When processing a GlobalCommand (either a Global Key Command or an Attachment command), this applies the "additional properties filter"
GlobalHotKey	Adds a menu entry that fires a specified key event to the module window.
GlobalSetter	Variant on GlobalCommand for use with SetPieceProperty -- instead of sending a key, finds pieces and sets their properties
Hideable
Highlighter	An interface that defines how to draw GamePieces that are selected
KeyBuffer	The KeyBuffer is the list of "currently selected pieces" in the VASSAL UI (map windows).
KeyCommand
Labeler.LabelOp
Mat	Designates the piece as a "Mat" on which other pieces ("Cargo") can be placed.
MatCargo	Designates the piece as "Cargo", which can be placed on a "Mat" to move along with it
MenuSeparator	This trait puts a menu separator bar in the context menu for the piece
MovementMarkable	d/b/a "Mark When Moved" A GamePiece with this trait will automatically be marked whenever it is moved.
MultiImagePicker
MultiLocationCommand	Allows a single trait to generate multiple context menu commands, using a set of filtered map locations.
PieceAccess	Defines ability of a player to access a GamePiece
PieceCloner	Utility class for cloning GamePieces
PieceDefiner	This is the GamePiece designer dialog.
PieceDefiner.TraitClipboard	Contents of the Copy/Paste buffer for traits in the editor
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
PieceFinder.Movable
PieceFinder.PieceInStack
PieceIterator	An iterator for GamePieces.
PieceVisitor	For implementing a somewhat modified Visitor pattern for GamePieces.
PieceVisitorDispatcher	For implementing a modified Visitor pattern on GamePieces.
Pivot	d/b/a "Can Pivot" Provides commands to pivot a Game Piece around a given point
PlaceMarker	This Decorator defines a key command to places another counter on top of this one.
PlaceMarker.Ed
PlayerAccess	Access is granted if GameModule.getUserId() matches
PlaySound	A trait that plays a sound clip
PropertyExporter	Interface for classes that can export the names and values of the properties they maintain
Replace	GamePiece trait that replaces a GamePiece with another one
ReportState	d/b/a "Report Action" 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)
RestrictCommands	RestrictCommands Restrict the availability of Key Commands, depending on a Property Match String
Restricted	d/b/a "Restricted Access" A GamePiece with the Restricted trait can only be manipulated by the player playing a specific side
SendToLocation	This trait adds a command that sends a piece to another location.
SendToLocation.Destination
SetGlobalProperty
SetPieceProperty
SideAccess	Access is granted if PlayerRoster.getMySide() matches
Stack	A Stack is a collection of pieces in the same location that can often be moved with a single drag-and-drop.
StateMergeable	GamePieces may implement this interface to implement "merge" functionality of their state.
SubMenu	A trait that groups menu items of other traits into a sub-menu
TraitConfigPanel	A standardised Panel for use by Trait configurers
TraitLayout	A standardised MigLayout for use by Trait configurers
Translate	d/b/a "Move Fixed Distance" Give a piece a command that moves it a fixed amount in a particular direction, optionally tracking the current rotation of the piece.
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
UsePrototype	d/b/a "Prototype" This trait is a placeholder for a pre-defined series of traits specified in a PrototypeDefinition object.

Classes in VASSAL.counters used by VASSAL.i18n

Class	Description
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.
GamePiece	Interface to deal with the behaviors of a physical component of the game, or a Trait of one.
PlaceMarker	This Decorator defines a key command to places another counter on top of this one.

Classes in VASSAL.counters used by VASSAL.script

Class	Description
Decorator	The abstract class describing a generic 'Trait' of a full GamePiece.
GamePiece	Interface to deal with the behaviors of a physical component of the game, or a Trait of one.

Classes in VASSAL.counters used by VASSAL.script.expression

Class	Description
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.
GamePiece	Interface to deal with the behaviors of a physical component of the game, or a Trait of one.
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

Classes in VASSAL.counters used by VASSAL.script.proxy

Class	Description
GamePiece	Interface to deal with the behaviors of a physical component of the game, or a Trait of one.
Stack	A Stack is a collection of pieces in the same location that can often be moved with a single drag-and-drop.

Classes in VASSAL.counters used by VASSAL.tools

Class	Description
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.

Classes in VASSAL.counters used by VASSAL.tools.imageop

Class	Description
GamePiece	Interface to deal with the behaviors of a physical component of the game, or a Trait of one.

Classes in VASSAL.counters used by VASSAL.tools.imports.adc2

Class	Description
Decorator	The abstract class describing a generic 'Trait' of a full GamePiece.
DynamicProperty	Trait that contains a property accessible via getProperty() and updatable dynamically via key commands
Embellishment	d/b/a "Layer" The "Layer" trait.
FreeRotator	d/b/a "Can Rotate" A Decorator that rotates a GamePiece to an arbitrary angle
GamePiece	Interface to deal with the behaviors of a physical component of the game, or a Trait of one.
MovementMarkable	d/b/a "Mark When Moved" A GamePiece with this trait will automatically be marked whenever it is moved.
Obscurable	d/b/a "Mask" Trait that lets some traits of a piece be hidden "from some players, some of the time".
PropertySheet	A Decorator class that endows a GamePiece with a dialog.
UsePrototype	d/b/a "Prototype" This trait is a placeholder for a pre-defined series of traits specified in a PrototypeDefinition object.