Uses of Package
VASSAL.build.module
Package
Description
Provides classes for building Java instances automatically from XML
files.
Contains classes that may be added to a
GameModule
.Contains classes that may be added to a
Map
.Contains classes that may be added to a
BoardPicker
.Contains classes that may be added to a
Board
.Contains classes that may be added to a
MapGrid
.Contains classes that may be added to a
NotesWindow
.Contains classes that can be added to a
Widget
.Contains classes for specifying a VASSAL server implementation that follows a chat-room paradigm.
Provides classes that implement the "Command" design pattern.
Provides classes for building "Edit Property" dialogs, and for editing
GameModule
's and ModuleExtension
's.Provides classes that define game pieces.
Contains various utility classes.
-
ClassDescriptionBasicLogger deals with VLOG Vassal Log files (i.e.The chat window component.Expandable "Console" to allow entering commands into the Chatter.A GameComponent is any object which reacts to the start/end of a game, or whose state can be saved as part of a game.The GameState contains methods to track and read/write the complete enumerated game state of the game currently being played.A window from which players can create new
GamePiece
s by clicking and dragging from the PieceWindow.Maintains a list of players involved in the current gameCall-back interface for when a player changes sides during a gameRepresents the connection to a live serverProvides support for two different wizards. -
ClassDescriptionMaintains a list of pieces with attachment traitsThe chat window component.CHESS CLOCK CONTROLLER for VASSAL.This component places a button into the controls window toolbar.This component places a button into the controls window toolbar.Convenience class for managing extensions relative to a module file.A GameComponent is any object which reacts to the start/end of a game, or whose state can be saved as part of a game.Represents a step during the initialization of a game in which the player must specify some information See
#addGameSetupStep(SetupStep)
This version ofMassKeyCommand
is added directly to aGameModule
and applies to all maps.GlobalOptions is a junction point for several flavors of "preferences"-related categories.This component places a button into the controls window toolbar.Holds static information of and a reference to a gamepiece.CounterNode for the result tree.Base class for comparing two CounterNodes.The Map is the main component for displaying and containingGamePiece
s during play.The (JPanel-extending) component that represents the map itselfAn optional extension to a GameModule Like a GameModule, it is built from scratch from a 'buildFile' in a DataArchive The components described in the buildFile are appended to components in the base DataArchiveA command that verifies that a certain extension has been loadedProvides information about whether a game was started from File->New Game or loaded from a saved gameDetermines whether players are allowed to unmask other players pieces.Maintains a list of players involved in the current gameCall-back interface for when a player changes sides during a gameAny components that are added to the module by a Plugin MUST implement PluginElement to prevent them being written to the buildFile when saving the module.Defines a saved game that is accessible from the File menu.A Map that may be configured to be visible only a particular side.Container for definitions of Game Piece prototypes....Takes buttons from the toolbar of a Map or the main module and places them into a popup menuBranches the wizard by forwarding to the Wizard stored in the wizard settings under a specified keyWizard pages for starting a new game.Wizard pages for the welcome wizard (initial module load).Loads a saved game in the background. -
ClassDescriptionA GameComponent is any object which reacts to the start/end of a game, or whose state can be saved as part of a game.
-
-
-
ClassDescriptionA GameComponent is any object which reacts to the start/end of a game, or whose state can be saved as part of a game.Represents a step during the initialization of a game in which the player must specify some information See
#addGameSetupStep(SetupStep)
The Map is the main component for displaying and containingGamePiece
s during play.Provides information about whether a game was started from File->New Game or loaded from a saved game -
-
-
ClassDescriptionA GameComponent is any object which reacts to the start/end of a game, or whose state can be saved as part of a game.The Map is the main component for displaying and containing
GamePiece
s during play. -
ClassDescriptionAn optional extension to a GameModule Like a GameModule, it is built from scratch from a 'buildFile' in a DataArchive The components described in the buildFile are appended to components in the base DataArchive
-
ClassDescriptionA GameComponent is any object which reacts to the start/end of a game, or whose state can be saved as part of a game.
-
ClassDescriptionA GameComponent is any object which reacts to the start/end of a game, or whose state can be saved as part of a game.
-
ClassDescriptionA GameComponent is any object which reacts to the start/end of a game, or whose state can be saved as part of a game.
-
ClassDescriptionA GameComponent is any object which reacts to the start/end of a game, or whose state can be saved as part of a game.The Map is the main component for displaying and containing
GamePiece
s during play.Call-back interface for when a player changes sides during a game -
ClassDescriptionThe chat window component.Represents the connection to a live server
-
-
-
-
ClassDescriptionThe chat window component.The Map is the main component for displaying and containing
GamePiece
s during play.An optional extension to a GameModule Like a GameModule, it is built from scratch from a 'buildFile' in a DataArchive The components described in the buildFile are appended to components in the base DataArchive -
ClassDescriptionThe Map is the main component for displaying and containing
GamePiece
s during play.Determines whether players are allowed to unmask other players pieces.Call-back interface for when a player changes sides during a game -
ClassDescriptionThe chat window component.Convenience class for managing extensions relative to a module file.An optional extension to a GameModule Like a GameModule, it is built from scratch from a 'buildFile' in a DataArchive The components described in the buildFile are appended to components in the base DataArchive
-
ClassDescriptionAlthough it is the
CommandEncoder
which handles the basic commands:AddPiece
,RemovePiece
,ChangePiece
,MovePiece
, this class is most commonly needed by module designers who want to make custom "Traits" for game pieces because it containsBasicCommandEncoder.createDecorator(java.lang.String, VASSAL.counters.GamePiece)
, theBasicCommandEncoder.DecoratorFactory
for Traits, which are usually internally referred to as Decorators because they are implemented using the Decorator Pattern.The Map is the main component for displaying and containingGamePiece
s during play.Plugin is a general purpose component for use by Module Plugins that require some sort of initialisation.Any components that are added to the module by a Plugin MUST implement PluginElement to prevent them being written to the buildFile when saving the module. -
-
-