Package VASSAL.build.module
Contains classes that may be added to a
GameModule.
-
Interface Summary Interface Description BasicCommandEncoder.BasicPieceFactory BasicCommandEncoder.DecoratorFactory 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 SeeGameState.addGameSetupStep(SetupStep)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.ServerConnection Represents the connection to a live server -
Class Summary Class Description BasicCommandEncoder BasicLogger BasicLogger.LogCommand ChartWindow A top-level Widget for displaying ChartsChartWindow.IconConfig Chatter The chat window component.Chatter.DisplayText This is aCommandobject that, when executed, displays a text message in the Chatter's text areaConnectionWindow This is now a dummy classDiceButton This component places a button into the controls window toolbar.DiceButton.IconConfig DiceButton.ReportFormatConfig DieManager DieRoll DoActionButton This component places a button into the controls window toolbar.DoActionButton.HotkeyConfig DoActionButton.IconConfig DoActionButton.LoopConfig DoActionButton.LoopCountConfig DoActionButton.LoopTypeConfig DoActionButton.NamedHotkeyListConfigurer DoActionButton.ReportFormatConfig DoActionButton.SoundConfig Documentation Represents theHelpmenu of the controls windowEventLog EventLog.Event EventLog.StoreEvents ExtensionElement 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 ofMassKeyCommandis added directly to aGameModuleand applies to all mapsGlobalOptions GlobalOptions.PlayerIdFormatConfig GlobalOptions.Prompt GlobalOptions.PromptOnOff InternetDiceButton This component places a button into the controls window toolbar.InternetDiceButton.InternetReportFormatConfig Inventory Inventory.IconConfig Inventory.PieceFormatConfig Inventory.Selector Filter to select pieces requiredInventory.SortConfig Map The Map is the main component for displaying and containingGamePieces during play.Map.ChangeFormatConfig Map.CreateFormatConfig Map.IconConfig Map.InsetLayout Map.Merger Map.MoveToFormatConfig Map.MoveWithinFormatConfig Map.UnmovedIconConfig Map.View The 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 loadedModulePlugin A ModulePlugin is basically identical to a ModuleExtension except that is loaded earlier and must throw Plugin specific error messagesModulePlugin.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 gameNewGameIndicator.MarkGameNotNew NotesWindow This is aGameComponentthat allows players to type and save text notes during a game.NotesWindow.IconConfig ObscurableOptions Determines whether players are allowed to unmask other players pieces.ObscurableOptions.SetAllowed PieceWindow A window from which players can create newGamePieces by clicking and dragging from the PieceWindow.PieceWindow.IconConfig PlayerHand PlayerRoster Maintains a list of players involved in the current gamePlayerRoster.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 SpecialDiceButton.ReportFormatConfig SpecialDiceButton.ShowResults Command for displaying the results of a roll of the diceSpecialDie 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 menuWizardSupport Provides support for two different wizards.WizardSupport.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.LoadSavedGamePanels Wizard pages for loading a saved gameWizardSupport.PlayOfflinePanels Wizard pages for starting a new game offlineWizardSupport.SavedGameLoader Loads a saved game in the background.WizardSupport.SetupStepPage Wizard page for an unfinishedGameSetupStepWizardSupport.TutorialLoader -
Exception Summary Exception Description ExtensionsLoader.LoadExtensionException