Package VASSAL.build.module
package VASSAL.build.module
Contains classes that may be added to a
GameModule.
-
Interface SummaryInterfaceDescriptionFactory interface for BasicPieces.Factory interface for Decorators See: Decorator Pattern, Factory PatternA 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)Call-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.Represents the connection to a live server -
Class SummaryClassDescriptionAlthough it is the
CommandEncoderwhich 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.BasicLogger deals with VLOG Vassal Log files (i.e.A top-level Widget for displaying ChartsThe chat window component.This is aCommandobject that, when executed, displays a text message in the Chatter's text areaCHESS CLOCK CONTROLLER for VASSAL.Autoconfigurer for master chessclock button icon (allows user to choose an icon image)Autoconfigurer for the days/hours/minutes/seconds/tenths stylesThis is now a dummy classExpandable "Console" to allow entering commands into the Chatter.Grabs errorlog output and displays it in the Chatter.This component places a button into the controls window toolbar.Deprecated, for removal: This API element is subject to removal in a future version.This component places a button into the controls window toolbar.Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.not replacedRepresents theHelpmenu of the controls windowConvenience class for managing extensions relative to a module file.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.The GameState contains methods to track and read/write the complete enumerated game state of the game currently being played.This version ofMassKeyCommandis added directly to aGameModuleand applies to all maps.GlobalOptions is a junction point for several flavors of "preferences"-related categories.Configurer for the Player's IDThe 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 behaviorThe PromptOnOff class allows certain attribute settings to be configured by the module designer: ALWAYS = the "preference" is forced on NEVER = the "preference" is forced offThis component places a button into the controls window toolbar.Deprecated, for removal: This API element is subject to removal in a future version.Filter to select pieces requiredTranslates key codes into human-readable strings (e.g.The Map is the main component for displaying and containingGamePieces during play.Report format configurer for "modified on map"Report format configurer for "created on map"Autoconfigurer for map's icon used on its launch buttonReport format configurer for "moved to map"Report format configurer for "moved within map"Autoconfigurer for mark-unmoved iconThe (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 loadedA ModulePlugin is basically identical to a ModuleExtension except that is loaded earlier and must throw Plugin specific error messagesCombines multiple buttons from the toolbar into a single button.Provides information about whether a game was started from File->New Game or loaded from a saved gameThis is aGameComponentthat allows players to type and save text notes during a game.Deprecated, for removal: This API element is subject to removal in a future version.Determines whether players are allowed to unmask other players pieces.A window from which players can create newGamePieces by clicking and dragging from the PieceWindow.Maintains a list of players involved in the current gamePlugin is a general purpose component for use by Module Plugins that require some sort of initialisation.Load Plugins.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....Deprecated, for removal: This API element is subject to removal in a future version.Command for displaying the results of a roll of the diceA Global Key Command that is automatically invoked on game start-up, once the various Key Listeners have been started.Takes buttons from the toolbar of a Map or the main module and places them into a popup menuProvides support for two different wizards.Branches 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 loading a saved gameWizard pages for starting a new game offlineLoads a saved game in the background.Wizard page for an unfinishedGameSetupStep -
Exception Summary