Package VASSAL.build.module

Contains classes that may be added to a GameModule.

Interface Summary

Interface	Description
BasicCommandEncoder.BasicPieceFactory	Factory interface for BasicPieces.
BasicCommandEncoder.DecoratorFactory	Factory interface for Decorators See: Decorator Pattern, Factory Pattern
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)
PlayerRoster.SideChangeListener	Call-back interface for when a player changes sides during a game
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.
ServerConnection	Represents the connection to a live server

Class Summary

Class	Description
BasicCommandEncoder	Although 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 contains BasicCommandEncoder.createDecorator(java.lang.String, VASSAL.counters.GamePiece), the BasicCommandEncoder.DecoratorFactory for Traits, which are usually internally referred to as Decorators because they are implemented using the Decorator Pattern.
BasicLogger	BasicLogger deals with VLOG Vassal Log files (i.e.
BasicLogger.LogCommand
ChartWindow	A top-level Widget for displaying Charts
ChartWindow.IconConfig
Chatter	The chat window component.
Chatter.DisplayText	This is a Command object that, when executed, displays a text message in the Chatter's text area
ChessClockControl	CHESS CLOCK CONTROLLER for VASSAL.
ChessClockControl.IconConfig	Autoconfigurer for master chessclock button icon (allows user to choose an icon image)
ChessClockControl.TimeStyleConfig	Autoconfigurer for the days/hours/minutes/seconds/tenths styles
ConnectionWindow	This is now a dummy class
Console	Expandable "Console" to allow entering commands into the Chatter.
ConsoleAppender	Grabs errorlog output and displays it in the Chatter.
DiceButton	This component places a button into the controls window toolbar.
DiceButton.IconConfig	Deprecated, for removal: This API element is subject to removal in a future version.
DiceButton.ReportFormatConfig
DieManager
DieRoll
DoActionButton	This component places a button into the controls window toolbar.
DoActionButton.HotkeyConfig
DoActionButton.IconConfig	Deprecated, for removal: This API element is subject to removal in a future version.
DoActionButton.LoopConfig
DoActionButton.LoopCountConfig
DoActionButton.LoopTypeConfig
DoActionButton.NamedHotkeyListConfigurer	Deprecated, for removal: This API element is subject to removal in a future version. not replaced
DoActionButton.ReportFormatConfig
DoActionButton.SoundConfig
Documentation	Represents the Help menu of the controls window
EventLog
EventLog.Event
EventLog.StoreEvents
ExtensionElement	An element of a ModuleExtension that extends an individual Buildable component of the GameModule.
ExtensionsLoader
ExtensionsManager	Convenience class for managing extensions relative to a module file.
GameRefresher	GameRefresher Replace all counters in the same game with the current version of the counters defined in the module Note: Counters that are Hidden or Obscured to us cannot be updated.
GameState	The GameState contains methods to track and read/write the complete enumerated game state of the game currently being played.
GameState.SetupCommand
GlobalKeyCommand	This version of MassKeyCommand is added directly to a GameModule and applies to all maps.
GlobalOptions	GlobalOptions is a junction point for several flavors of "preferences"-related categories.
GlobalOptions.PlayerIdFormatConfig	Configurer for the Player's ID
GlobalOptions.Prompt	The Prompt class allows certain attribute settings to be configured by the module designer: ALWAYS = the "preference" is forced on NEVER = the "preference" is forced off PROMPT = the player actually receives a preference on the General tab to control this behavior
GlobalOptions.PromptOnOff	The PromptOnOff class allows certain attribute settings to be configured by the module designer: ALWAYS = the "preference" is forced on NEVER = the "preference" is forced off
InternetDiceButton	This component places a button into the controls window toolbar.
InternetDiceButton.InternetReportFormatConfig
Inventory
Inventory.FunctionConfig
Inventory.IconConfig	Deprecated, for removal: This API element is subject to removal in a future version.
Inventory.PieceFormatConfig
Inventory.Selector	Filter to select pieces required
Inventory.SortConfig
KeyNamer	Translates key codes into human-readable strings (e.g.
Map	The Map is the main component for displaying and containing GamePieces during play.
Map.ChangeFormatConfig	Report format configurer for "modified on map"
Map.CreateFormatConfig	Report format configurer for "created on map"
Map.IconConfig	Autoconfigurer for map's icon used on its launch button
Map.InsetLayout	The Layout responsible for arranging insets which overlay the Map InsetLayout currently is responsible for keeping the GlobalMap in the upper-left corner of the Map.View.
Map.Merger	Implements default logic for merging pieces (into a Stack or Deck} at a given location within a map Returns a Command that merges the input GamePiece with an existing piece at the input position, provided the pieces are stackable, visible, in the same layer, etc.
Map.MoveToFormatConfig	Report format configurer for "moved to map"
Map.MoveWithinFormatConfig	Report format configurer for "moved within map"
Map.UnmovedIconConfig	Autoconfigurer for mark-unmoved icon
Map.View	The (JPanel-extending) component that represents the map itself
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
ModuleExtension.RegCmd	A command that verifies that a certain extension has been loaded
ModulePlugin	A ModulePlugin is basically identical to a ModuleExtension except that is loaded earlier and must throw Plugin specific error messages
ModulePlugin.RegCmd
MultiActionButton	Combines multiple buttons from the toolbar into a single button.
MultiRoll
MultiRoll.HeaderRow
MultiRoll.StateButton
NewGameIndicator	Provides information about whether a game was started from File->New Game or loaded from a saved game
NewGameIndicator.MarkGameNotNew
NotesWindow	This is a GameComponent that allows players to type and save text notes during a game.
NotesWindow.IconConfig	Deprecated, for removal: This API element is subject to removal in a future version.
ObscurableOptions	Determines whether players are allowed to unmask other players pieces.
ObscurableOptions.SetAllowed
PieceWindow	A window from which players can create new GamePieces by clicking and dragging from the PieceWindow.
PieceWindow.IconConfig
PlayerHand
PlayerRoster	Maintains a list of players involved in the current game
PlayerRoster.Add
PlayerRoster.PlayerInfo
Plugin	Plugin is a general purpose component for use by Module Plugins that require some sort of initialisation.
PluginsLoader	Load Plugins.
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.
PrivateMap.View
PrototypeDefinition
PrototypeDefinition.Config
PrototypeDefinition.Config.Definer
PrototypesContainer	Container for definitions of Game Piece prototypes.
RandomTextButton
SpecialDiceButton	...
SpecialDiceButton.IconConfig	Deprecated, for removal: This API element is subject to removal in a future version.
SpecialDiceButton.ReportFormatConfig
SpecialDiceButton.ShowResults	Command for displaying the results of a roll of the dice
SpecialDie
SpecialDie.ResultFormatConfig
SpecialDieFace
SpecialDieFace.IconConfig
StartupGlobalKeyCommand	A Global Key Command that is automatically invoked on game start-up, once the various Key Listeners have been started.
ToolbarMenu	Takes buttons from the toolbar of a Map or the main module and places them into a popup menu
WizardSupport	Provides support for two different wizards.
WizardSupport.BranchingWizard	Branches the wizard by forwarding to the Wizard stored in the wizard settings under a specified key
WizardSupport.GameSetupPanels	Wizard pages for starting a new game.
WizardSupport.LoadSavedGamePanels	Wizard pages for loading a saved game
WizardSupport.PlayOfflinePanels	Wizard pages for starting a new game offline
WizardSupport.SavedGameLoader	Loads a saved game in the background.
WizardSupport.SetupStepPage	Wizard page for an unfinished GameSetupStep
WizardSupport.TutorialLoader

Exception Summary

Exception	Description
ExtensionsLoader.LoadExtensionException