Package VASSAL.build.module

Contains classes that may be added to a GameModule.

See:
Description

Interface Summary

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.
ServerConnection	Represents the connection to a live server

Class Summary

BasicCommandEncoder	A CommandEncoder that handles the basic commands: AddPiece, RemovePiece, ChangePiece, MovePiece.
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
ConnectionWindow	This is now a dummy class
DiceButton	This component places a button into the controls window toolbar.
DiceButton.IconConfig
DiceButton.ReportFormatConfig
DieManager
DieManager.DieServer	Base DieServer Class Does most of the work.
DieManager.RollSet	Describes a set of DieRolls
DieRoll
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
GameState	The GameState represents the state of the game currently being played.
GameState.SetupCommand
GlobalOptions
GlobalOptions.Prompt
InternetDiceButton	This component places a button into the controls window toolbar.
Map	The Map is the main component for displaying and containing GamePieces during play.
Map.CreateFormatConfig
Map.IconConfig
Map.MoveToFormatConfig
Map.MoveWithinFormatConfig
Map.View	The 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
MultiRoll
NotesWindow	This is a GameComponent that allows players to type and save text notes during a game.
ObscurableOptions	Determines whether players are allowed to un-mask 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.Entry
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
SpecialDiceButton.ReportFormatConfig
SpecialDiceButton.ShowResults	Command for displaying the results of a roll of the dice
SpecialDie
SpecialDie.ResultFormatConfig
SpecialDieFace
SpecialDieFace.IconConfig

Package VASSAL.build.module Description

Contains classes that may be added to a GameModule.