Uses of Package
VASSAL.build.module
| 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.chessclockcontrol | |
| VASSAL.build.module.dice | |
| VASSAL.build.module.map |
Contains classes that may be added to a
Map. |
| VASSAL.build.module.map.boardPicker |
Contains classes that may be added to a
BoardPicker. |
| VASSAL.build.module.map.boardPicker.board |
Contains classes that may be added to a
Board. |
| VASSAL.build.module.map.boardPicker.board.mapgrid |
Contains classes that may be added to a
MapGrid. |
| VASSAL.build.module.metadata | |
| VASSAL.build.module.noteswindow |
Contains classes that may be added to a
NotesWindow. |
| VASSAL.build.module.properties | |
| VASSAL.build.module.turn | |
| VASSAL.build.widget |
Contains classes that can be added to a
Widget. |
| VASSAL.chat |
Contains classes for specifying a VASSAL server implementation that follows a chat-room paradigm.
|
| VASSAL.chat.node | |
| VASSAL.chat.peer2peer | |
| 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.launch | |
| VASSAL.script | |
| VASSAL.script.proxy | |
| VASSAL.tools.imports |
-
Classes in VASSAL.build.module used by VASSAL.build Class Description Chatter The chat window component.Console Expandable "Console" to allow entering commands into the Chatter.GameState The GameState contains methods to track and read/write the complete enumerated game state of the game currently being played.PieceWindow A window from which players can create newGamePieces by clicking and dragging from the PieceWindow.PlayerRoster Maintains a list of players involved in the current gamePlayerRoster.SideChangeListener Call-back interface for when a player changes sides during a gamePrototypeDefinition ServerConnection Represents the connection to a live serverWizardSupport Provides support for two different wizards. -
Classes in VASSAL.build.module used by VASSAL.build.module Class Description Chatter The chat window component.ChessClockControl CHESS CLOCK CONTROLLER for VASSAL.DiceButton This component places a button into the controls window toolbar.DiceButton.ReportFormatConfig DieManager DieRoll EventLog EventLog.Event ExtensionElement ExtensionsLoader ExtensionsManager Convenience class for managing extensions relative to a module file.GameComponent 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.GameSetupStep Represents a step during the initialization of a game in which the player must specify some information See#addGameSetupStep(SetupStep)GlobalKeyCommand This version ofMassKeyCommandis added directly to aGameModuleand applies to all maps.GlobalOptions GlobalOptions is a junction point for several flavors of "preferences"-related categories.InternetDiceButton This component places a button into the controls window toolbar.Inventory.Counter Holds static information of and a reference to a gamepiece.Inventory.CounterInventory Inventory.CounterNode CounterNode for the result tree.Inventory.CounterNode.CompareCounterNodes Base class for comparing two CounterNodes.Map The Map is the main component for displaying and containingGamePieces during play.Map.View The (JPanel-extending) component that represents the map itselfModuleExtension 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 DataArchiveModuleExtension.RegCmd A command that verifies that a certain extension has been loadedMultiRoll NewGameIndicator Provides information about whether a game was started from File->New Game or loaded from a saved gameObscurableOptions Determines whether players are allowed to unmask other players pieces.PlayerRoster Maintains a list of players involved in the current gamePlayerRoster.PlayerInfo PlayerRoster.SideChangeListener Call-back interface for when a player changes sides during a gamePluginsLoader.PluginElement 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.PredefinedSetup Defines a saved game that is accessible from the File menu.PrivateMap A Map that may be configured to be visible only a particular side.PrototypeDefinition SpecialDiceButton ...SpecialDie SpecialDieFace ToolbarMenu Takes buttons from the toolbar of a Map or the main module and places them into a popup menuWizardSupport.BranchingWizard Branches the wizard by forwarding to the Wizard stored in the wizard settings under a specified keyWizardSupport.GameSetupPanels Wizard pages for starting a new game.WizardSupport.InitialWelcomeSteps Wizard pages for the welcome wizard (initial module load).WizardSupport.SavedGameLoader Loads a saved game in the background. -
Classes in VASSAL.build.module used by VASSAL.build.module.chessclockcontrol Class Description GameComponent 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. -
Classes in VASSAL.build.module used by VASSAL.build.module.dice Class Description DieRoll -
Classes in VASSAL.build.module used by VASSAL.build.module.map Class Description GameComponent 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.GameSetupStep Represents a step during the initialization of a game in which the player must specify some information See#addGameSetupStep(SetupStep)Map The Map is the main component for displaying and containingGamePieces during play.NewGameIndicator Provides information about whether a game was started from File->New Game or loaded from a saved game -
Classes in VASSAL.build.module used by VASSAL.build.module.map.boardPicker Class Description GameComponent 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.Map The Map is the main component for displaying and containingGamePieces during play. -
Classes in VASSAL.build.module used by VASSAL.build.module.map.boardPicker.board Class Description Map The Map is the main component for displaying and containingGamePieces during play. -
Classes in VASSAL.build.module used by VASSAL.build.module.map.boardPicker.board.mapgrid Class Description GameComponent 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.Map The Map is the main component for displaying and containingGamePieces during play. -
Classes in VASSAL.build.module used by VASSAL.build.module.metadata Class Description ModuleExtension 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 -
Classes in VASSAL.build.module used by VASSAL.build.module.noteswindow Class Description GameComponent 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. -
Classes in VASSAL.build.module used by VASSAL.build.module.properties Class Description GameComponent 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. -
Classes in VASSAL.build.module used by VASSAL.build.module.turn Class Description GameComponent 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. -
Classes in VASSAL.build.module used by VASSAL.build.widget Class Description GameComponent 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.Map The Map is the main component for displaying and containingGamePieces during play.PlayerRoster.SideChangeListener Call-back interface for when a player changes sides during a game -
Classes in VASSAL.build.module used by VASSAL.chat Class Description Chatter The chat window component.ServerConnection Represents the connection to a live server -
Classes in VASSAL.build.module used by VASSAL.chat.node Class Description ServerConnection Represents the connection to a live server -
Classes in VASSAL.build.module used by VASSAL.chat.peer2peer Class Description ServerConnection Represents the connection to a live server -
Classes in VASSAL.build.module used by VASSAL.command Class Description Map The Map is the main component for displaying and containingGamePieces during play. -
Classes in VASSAL.build.module used by VASSAL.configure Class Description Chatter The chat window component.ModuleExtension 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 -
Classes in VASSAL.build.module used by VASSAL.counters Class Description Map The Map is the main component for displaying and containingGamePieces during play.ObscurableOptions Determines whether players are allowed to unmask other players pieces.PlayerRoster.SideChangeListener Call-back interface for when a player changes sides during a game -
Classes in VASSAL.build.module used by VASSAL.launch Class Description Chatter The chat window component.ExtensionsLoader ExtensionsManager Convenience class for managing extensions relative to a module file.ModuleExtension 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 -
Classes in VASSAL.build.module used by VASSAL.script Class Description BasicCommandEncoder Although it is theCommandEncoderwhich 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.DecoratorFactoryfor Traits, which are usually internally referred to as Decorators because they are implemented using the Decorator Pattern.Map The Map is the main component for displaying and containingGamePieces during play.Plugin Plugin is a general purpose component for use by Module Plugins that require some sort of initialisation.PluginsLoader.PluginElement 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. -
Classes in VASSAL.build.module used by VASSAL.script.proxy Class Description Map The Map is the main component for displaying and containingGamePieces during play. -
Classes in VASSAL.build.module used by VASSAL.tools.imports Class Description Map The Map is the main component for displaying and containingGamePieces during play.