Uses of Package
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.map |
Contains classes that may be added to a
Map. |
| 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 EditablePiece If class implementing GamePiece also implements the EditablePiece interface, then it can be manipulated from the Editor's Configuration Tree via thePieceDefinerdialog.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 Class Description Deck A collection of pieces that behaves like a deck, i.e.: Doesn't move.DeckVisitor For Visitors that are aware ofDecktypesDecorator 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 selectedPieceDefiner 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 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 windowPieceFinder This interface defines selection criteria for finding a GamePiece in a MapPieceVisitor For implementing a somewhat modified Visitor pattern forGamePieces.PieceVisitorDispatcher For implementing a modified Visitor pattern onGamePieces.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 Class Description ColoredBorder Deck A collection of pieces that behaves like a deck, i.e.: Doesn't move.DeckVisitor For Visitors that are aware ofDecktypesDeckVisitorDispatcher For handling Visitors that are aware ofDecktypesGamePiece 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 selectedKeyCommand PieceFilter A 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 windowPieceFinder This interface defines selection criteria for finding a GamePiece in a MapPieceFinder.Movable PieceIterator An iterator for GamePieces.PieceVisitor For implementing a somewhat modified Visitor pattern forGamePieces.PieceVisitorDispatcher For implementing a modified Visitor pattern onGamePieces.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.properties 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.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 onGamePieces. -
Classes in VASSAL.counters used by VASSAL.configure Class Description EditablePiece If class implementing GamePiece also implements the EditablePiece interface, then it can be manipulated from the Editor's Configuration Tree via thePieceDefinerdialog.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 GamePiecePieceFilter A 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 windowTraitConfigPanel A standardised Panel for use by Trait configurersTraitLayout A standardised MigLayout for use by Trait configurers -
Classes in VASSAL.counters used by VASSAL.counters Class Description ActionButton A Trait (akaDecoratorthat acts like a button on a GamePiece, such that clicking on a particular area of the piece invokes a key commandActionButton.ButtonPusher Registers mouse listeners with Maps and other components.AreaOfEffect 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 GamepieceCounterGlobalKeyCommand 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 windowDeckVisitor For Visitors that are aware ofDecktypesDeckVisitorDispatcher For handling Visitors that are aware ofDecktypesDecorator The abstract class describing a generic 'Trait' of a full GamePiece.Delete This trait adds a command that creates a duplicate of the selected GamepieceDeselect 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 commandsDynamicProperty.DynamicKeyCommand DynamicKeyCommand A class that represents an action to be performed on a Dynamic propertyEditablePiece If class implementing GamePiece also implements the EditablePiece interface, then it can be manipulated from the Editor's Configuration Tree via thePieceDefinerdialog.Embellishment The "Layer" trait.EventFilter Gives information about what kinds of events aGamePiecewill respond toFootprint Displays a movement trail indicating where a piece has been movedFreeRotator A Decorator that rotates a GamePiece to an arbitrary angleGamePiece 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.CompareMode Comparison Modes for property matchGlobalCommandTarget.GKCtype Specifies the type of GKC being configured (affects which Target options are allowed)GlobalCommandTarget.Target Specifies the kind of target matchingGlobalHotKey Adds a menu entry that fires a specified key event to the module window.Hideable Highlighter An interface that defines how to draw GamePieces that are selectedKeyBuffer The KeyBuffer is the list of "currently selected pieces" in the VASSAL UI (map windows).KeyCommand Labeler.LabelOp MenuSeparator This trait adds a command that creates a duplicate of the selected GamepieceMovementMarkable A GamePiece with this trait will automatically be marked whenever it is moved.MultiImagePicker PieceAccess Defines ability of a player to access a GamePiecePieceCloner Utility class for cloningGamePiecesPieceDefiner This is the GamePiece designer dialog.PieceEditor PieceFilter A 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 windowPieceFinder This interface defines selection criteria for finding a GamePiece in a MapPieceFinder.Movable PieceFinder.PieceInStack PieceImage Deprecated.PieceIterator An iterator for GamePieces.PieceVisitor For implementing a somewhat modified Visitor pattern forGamePieces.PieceVisitorDispatcher For implementing a modified Visitor pattern onGamePieces.Pivot Provides commands to pivot a Game Piece around a given pointPlaceMarker This Decorator defines a key command to places another counter on top of this one.PlaceMarker.Ed PlayerAccess Access is granted ifGameModule.getUserId()matchesPlaySound A trait that plays a sound clipPropertyExporter Interface for classes that can exporty the names and values of the properties they maintainReplace GamePiece trait that replaces a GamePiece with another oneReportState 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 A GamePiece with the Restricted trait can only be manipulated by the player playing a specific sideSendToLocation This trait adds a command that sends a piece to another location.SetGlobalProperty SideAccess Access is granted ifPlayerRoster.getMySide()matchesStack 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-menuTraitConfigPanel A standardised Panel for use by Trait configurersTraitLayout A standardised MigLayout for use by Trait configurersTranslate 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 FilterUsePrototype This trait is a placeholder for a pre-defined series of traits specified in aPrototypeDefinitionobject. -
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 thePieceDefinerdialog.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 thePieceDefinerdialog.PieceFilter A 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 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 thePieceDefinerdialog. -
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 commandsEmbellishment The "Layer" trait.FreeRotator A Decorator that rotates a GamePiece to an arbitrary angleGamePiece Interface to deal with the behaviors of a physical component of the game, or a Trait of one.MovementMarkable A GamePiece with this trait will automatically be marked whenever it is moved.Obscurable PropertySheet A Decorator class that endows a GamePiece with a dialog.UsePrototype This trait is a placeholder for a pre-defined series of traits specified in aPrototypeDefinitionobject.
GamePieceOpinstead.