VASSAL.build.GameModule

All Implemented Interfaces:: AutoConfigurable, Buildable, Configurable, GpIdSupport, MutablePropertiesContainer, PropertyNameSource, PropertySource, CommandEncoder, ValidityChecker, Translatable, ToolBarComponent

Direct Known Subclasses:: BasicModule

public abstract class GameModule
extends AbstractConfigurable
implements CommandEncoder, ToolBarComponent, PropertySource, MutablePropertiesContainer, GpIdSupport

The GameModule class is the base class for a VASSAL module. It is the root of the Buildable containment hierarchy, although BasicModule actually stands in as the root node in the Editor's ConfigureTree and contains the root node's own encoder and a certain amount of its build logic, in order to allow the root node to be easily configured in the Editor without fully building/activating the module. Components which are added directly to the GameModule are contained in the VASSAL.build.module package.

It is a singleton, and contains access points for many other classes, such as DataArchive, ServerConnection, Logger, and Prefs.

Nested Class Summary

Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable
AutoConfigurable.Util

Nested classes/interfaces inherited from interface VASSAL.build.module.properties.MutablePropertiesContainer
MutablePropertiesContainer.Impl

Field Summary

Fields
Modifier and Type	Field	Description
`protected DataArchive`	`archive`
`static String`	`BUILDFILE`
`protected Chatter`	`chat`
`protected CommandEncoder[]`	`commandEncoders`
`protected JPanel`	`controlPanel`	Deprecated, for removal: This API element is subject to removal in a future version. use `getPlayerWindow()` and `PlayerWindow.getControlPanel()` instead.
`protected Long`	`crc`
`protected static String`	`DEFAULT_NAME`
`protected List<String>`	`deferredChat`
`protected String`	`description`
`static String`	`DESCRIPTION`
`protected FileChooser`	`fileChooser`
`protected FileDialog`	`fileDialog`
`protected PlayerWindow`	`frame`
`protected String`	`gameName`
`protected GpIdSupport`	`gpidSupport`
`protected PropertyChangeSupport`	`idChangeSupport`
`protected List<KeyStrokeListener>`	`keyStrokeListeners`
`protected List<KeyStrokeSource>`	`keyStrokeSources`
`protected String`	`lastSavedConfiguration`
`protected String`	`localizedGameName`
`protected Logger`	`logger`
`protected Object`	`loggingLock`
`protected boolean`	`loggingPaused`
`static String`	`MODULE_NAME`
`static String`	`MODULE_VERSION`
`protected String`	`moduleVersion`
`static String`	`NEXT_PIECESLOT_ID`
`protected int`	`nextGpId`
`protected Command`	`pausedCommands`
`static String`	`PERSONAL_INFO`	The `Prefs` key for the user's personal info
`protected Prefs`	`preferences`
`protected MutablePropertiesContainer`	`propsContainer`
`static String`	`REAL_NAME`	The `Prefs` key for the user's real name
`protected PropertyChangeListener`	`repaintOnPropertyChange`
`protected Random`	`RNG`
`static String`	`SECRET_NAME`	The `Prefs` key for the user's secret name
`protected ServerConnection`	`server`
`protected ImageTileSource`	`tcache`
`protected GameState`	`theState`
`static String`	`VASSAL_VERSION_CREATED`
`static String`	`VASSAL_VERSION_RUNNING`	The System property of this name will return a version identifier for the version of VASSAL being run
`protected String`	`vassalVersionCreated`
`protected WizardSupport`	`wizardSupport`

Fields inherited from class VASSAL.build.AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

Constructors

Modifier Constructor Description

protected GameModule(DataArchive archive)

Method Summary

Modifier and Type	Method	Description
`void`	`addCommandEncoder(CommandEncoder ce)`	This method adds a `CommandEncoder` to the list of objects that will attempt to decode/encode a command
`void`	`addIdChangeListener(PropertyChangeListener l)`
`void`	`addKeyStrokeListener(KeyStrokeListener l)`	The GameModule acts as the mediator for hotkey events.
`void`	`addKeyStrokeSource(KeyStrokeSource src)`	The GameModule acts as the mediator for hotkey events.
`void`	`addMutableProperty(String key, MutableProperty p)`	Add a property under the given key
`void`	`addSideChangeListenerToPlayerRoster(PlayerRoster.SideChangeListener l)`
`void`	`addTo(Buildable b)`	Adds this component to its parent.
`void`	`appendToTitle(String s)`	Append the string to the title of the controls window and all Map windows
`protected abstract void`	`build()`	Initialize the module
`protected Long`	`buildCrc()`
`protected String`	`buildString()`
`protected void`	`checkGpIds()`	Check every PieceSlot and PlaceMarker trait for duplicate, illegal or Missing GamePiece id's and update them if necessary
`void`	`clearPausedCommands()`	Clear outstanding Commands Use where the calling level handles the sending of outstanding commands
`static int`	`compareVersions(String v1, String v2)`	Deprecated, for removal: This API element is subject to removal in a future version. use `VersionUtils.compareVersions(String, String)`
`GamePiece`	`createPiece(String type)`	Central location to create any type of GamePiece from within VASSAL
`GamePiece`	`createPiece(String type, GamePiece inner)`
`Command`	`decode(String command)`	Uses the registered `CommandEncoder`s to decode a String into a `Command`.
`String`	`encode(Command c)`	Uses the registered `CommandEncoder`s to encode a `Command` into a String object
`void`	`fireKeyStroke(KeyStroke stroke)`	Deprecated, for removal: This API element is subject to removal in a future version. use `fireKeyStroke(NamedKeyStroke)`
`void`	`fireKeyStroke(NamedKeyStroke stroke)`
`String`	`generateGpId()`	Generate a new PieceSlot Id, unique to this top-level component.
`Class<?>[]`	`getAllowableConfigureComponents()`	Return a list of valid sub-component Classes.
`ArchiveWriter`	`getArchiveWriter()`	If the module is being edited, return the writeable archive for the module
`String[]`	`getAttributeDescriptions()`	Return an array of Strings describing the attributes of this object.
`String[]`	`getAttributeNames()`	Lists all the buildFile (XML) attribute names for this component.
`Class<?>[]`	`getAttributeTypes()`	Return the Class for the buildFile (XML) attributes of this component.
`String`	`getAttributeValueString(String name)`	Called by the `Buildable.getBuildElement(org.w3c.dom.Document)` method to write the attributes into an XML element
`Chatter`	`getChatter()`
`static String`	`getConfigureTypeName()`
`JComponent`	`getControlPanel()`
`long`	`getCrc()`
`DataArchive`	`getDataArchive()`
`FileChooser`	`getFileChooser()`
`FileDialog`	`getFileDialog()`	Deprecated, for removal: This API element is subject to removal in a future version. Use `getFileChooser()` instead.
`JFrame`	`getFrame()`	Deprecated, for removal: This API element is subject to removal in a future version. use `getPlayerWindow()`
`static GameModule`	`getGameModule()`
`String`	`getGameName()`
`GameState`	`getGameState()`	Return the object responsible for tracking the state of a game.
`String`	`getGameVersion()`
`Prefs`	`getGlobalPrefs()`	Deprecated, for removal: This API element is subject to removal in a future version. use `Prefs.getGlobalPrefs()`
`GpIdSupport`	`getGpIdSupport()`
`HelpFile`	`getHelpFile()`
`ComponentI18nData`	`getI18nData()`
`ImageTileSource`	`getImageTileSource()`
`String`	`getLocalizedGameName()`
`Object`	`getLocalizedProperty(Object key)`
`Logger`	`getLogger()`
`String`	`getMutablePropertiesContainerId()`	Return a unique Id for the container
`MutableProperty`	`getMutableProperty(String name)`	Find a GlobalProperty object with the given name
`int`	`getNextGpId()`	Accessors to check and update the next GpId if necessary.
`PlayerRoster`	`getPlayerRoster()`
`PlayerWindow`	`getPlayerWindow()`
`Prefs`	`getPrefs()`
`Object`	`getProperty(Object key)`	Return values of Global properties
`Random`	`getRNG()`
`ServerConnection`	`getServer()`
`JToolBar`	`getToolBar()`
`static String`	`getUserId()`
`WizardSupport`	`getWizardSupport()`
`static void`	`init(GameModule module)`	Set the singleton GameModule and invoke `build()` on it.
`void`	`initFrameTitle()`
`boolean`	`isLocalizationEnabled()`	Is the module being translated into the user's Locale? Localization is disabled when editing a module
`boolean`	`pauseLogging()`	Pause logging and return true if successful.
`void`	`quit()`	Exit the application, prompting user to save if necessary
`void`	`refreshKeyStrokeListeners()`	If our keyboard mapping paradigm changes (example: Mac Legacy preference checked/unchecked), we need to reregister all of our KeyStrokeListeners
`void`	`removeCommandEncoder(CommandEncoder ce)`	This method removes a `CommandEncoder` from the list of objects that will attempt to decode/encode a command
`void`	`removeFrom(Buildable parent)`	Remove this component from its parent
`void`	`removeIdChangeListener(PropertyChangeListener l)`
`MutableProperty`	`removeMutableProperty(String key)`	Remove the property with the given key
`Command`	`resumeLogging()`	Restart logging and return any outstanding commands
`void`	`save()`	If the module is being edited, write the module data
`protected void`	`save(boolean saveAs)`
`void`	`saveAs()`
`void`	`sendAndLog(Command c)`	Encode the `Command`, send it to the server and write it to a logfile (if any is open)
`void`	`setAttribute(String name, Object value)`	Sets a buildFile (XML) attribute value for this component.
`void`	`setChatter(Chatter c)`	Set the object that displays chat text.
`void`	`setGlobalPrefs(Prefs p)`	Deprecated, for removal: This API element is subject to removal in a future version. no replacement
`void`	`setGpIdSupport(GpIdSupport s)`
`void`	`setNextGpId(int id)`
`void`	`setPrefs(Prefs p)`
`static void`	`setUserId(String newId)`	Set the identifier for the user
`boolean`	`shutDown()`	Prompt user to save open game and modules/extensions being edited
`static void`	`unload()`	Unload the module
`void`	`updateLastSave()`
`void`	`warn(String s)`	Display the given text in the control window's status line.

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigureName, getConfigurer, getI18nPrefix, getLocalizedConfigureName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getPropertyNames, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface VASSAL.build.Buildable

build, getBuildElement

Field Details
- DEFAULT_NAME
  
  protected static final String DEFAULT_NAME
  
  See Also:
  
  Constant Field Values
- MODULE_NAME
  
  public static final String MODULE_NAME
  
  See Also:
  
  Constant Field Values
- MODULE_VERSION
  
  public static final String MODULE_VERSION
  
  See Also:
  
  Constant Field Values
- DESCRIPTION
  
  public static final String DESCRIPTION
  
  See Also:
  
  Constant Field Values
- VASSAL_VERSION_CREATED
  
  public static final String VASSAL_VERSION_CREATED
  
  See Also:
  
  Constant Field Values
- VASSAL_VERSION_RUNNING
  
  public static final String VASSAL_VERSION_RUNNING
  
  The System property of this name will return a version identifier for the version of VASSAL being run
  
  See Also:
  
  Constant Field Values
- NEXT_PIECESLOT_ID
  
  public static final String NEXT_PIECESLOT_ID
  
  See Also:
  
  Constant Field Values
- BUILDFILE
  
  public static final String BUILDFILE
  
  See Also:
  
  Constant Field Values
- moduleVersion
  
  protected String moduleVersion
- vassalVersionCreated
  
  protected String vassalVersionCreated
- gameName
  
  protected String gameName
- localizedGameName
  
  protected String localizedGameName
- description
  
  protected String description
- lastSavedConfiguration
  
  protected String lastSavedConfiguration
- fileChooser
  
  protected FileChooser fileChooser
- fileDialog
  
  protected FileDialog fileDialog
- propsContainer
  
  protected MutablePropertiesContainer propsContainer
- repaintOnPropertyChange
  
  protected PropertyChangeListener repaintOnPropertyChange
- frame
  
  protected PlayerWindow frame
- controlPanel
  
  @Deprecated(since="2020-08-06", forRemoval=true) protected JPanel controlPanel
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  use getPlayerWindow() and PlayerWindow.getControlPanel() instead.
- theState
  
  protected GameState theState
- archive
  
  protected DataArchive archive
- preferences
  
  protected Prefs preferences
- logger
  
  protected Logger logger
- chat
  
  protected Chatter chat
- RNG
  
  protected Random RNG
- server
  
  protected ServerConnection server
- tcache
  
  protected ImageTileSource tcache
- wizardSupport
  
  protected WizardSupport wizardSupport
- idChangeSupport
  
  protected PropertyChangeSupport idChangeSupport
- keyStrokeSources
  
  protected List<KeyStrokeSource> keyStrokeSources
- keyStrokeListeners
  
  protected List<KeyStrokeListener> keyStrokeListeners
- commandEncoders
  
  protected CommandEncoder[] commandEncoders
- deferredChat
  
  protected List<String> deferredChat
- nextGpId
  
  protected int nextGpId
- loggingPaused
  
  protected boolean loggingPaused
- loggingLock
  
  protected final Object loggingLock
- pausedCommands
  
  protected Command pausedCommands
- gpidSupport
  
  protected GpIdSupport gpidSupport
- crc
  
  protected Long crc
- REAL_NAME
  
  public static final String REAL_NAME
  
  The Prefs key for the user's real name
  
  See Also:
  
  Constant Field Values
- SECRET_NAME
  
  public static final String SECRET_NAME
  
  The Prefs key for the user's secret name
  
  See Also:
  
  Constant Field Values
- PERSONAL_INFO
  
  public static final String PERSONAL_INFO
  
  The Prefs key for the user's personal info
  
  See Also:
  
  Constant Field Values
Constructor Details
- GameModule
  
  protected GameModule(DataArchive archive)
Method Details
- getFrame
  
  @Deprecated(since="2020-08-06", forRemoval=true) public JFrame getFrame()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  use getPlayerWindow()
  
  Returns:
  
  the top-level frame of the controls window
- getPlayerWindow
  
  public PlayerWindow getPlayerWindow()
- initFrameTitle
  
  public void initFrameTitle()
- getWizardSupport
  
  public WizardSupport getWizardSupport()
- build
  
  protected abstract void build() throws IOException
  
  Initialize the module
  
  Throws:
  
  IOException
- setAttribute
  
  public void setAttribute(String name, Object value)
  
  Description copied from class: AbstractBuildable
  
  Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractBuildable.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value will be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()
  
  Specified by:
  
  setAttribute in interface AutoConfigurable
  
  Specified by:
  
  setAttribute in interface Translatable
  
  Specified by:
  
  setAttribute in class AbstractBuildable
  
  Parameters:
  
  name - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()
  
  value - If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value can also be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()
- getAttributeValueString
  
  public String getAttributeValueString(String name)
  
  Description copied from interface: AutoConfigurable
  
  Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
  
  Specified by:
  
  getAttributeValueString in interface AutoConfigurable
  
  Specified by:
  
  getAttributeValueString in interface Translatable
  
  Specified by:
  
  getAttributeValueString in class AbstractBuildable
  
  Parameters:
  
  name - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()
  
  Returns:
  
  a String representation of the attribute with the given name. When initializing a module, this String value will be passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object).
- compareVersions
  
  @Deprecated(since="2020-08-06", forRemoval=true) public static int compareVersions(String v1, String v2)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  use VersionUtils.compareVersions(String, String)
  
  A valid verson format is "w.x.y[bz]", where 'w','x','y', and 'z' are integers.
  
  Returns:
  
  a negative number if v2 is a later version the v1, a positive number if an earlier version, or zero if the versions are the same.
- addTo
  
  public void addTo(Buildable b)
  
  Description copied from interface: Buildable
  
  Adds this component to its parent. In order to make Buildable objects extensible, the child is reponsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.
  
  Specified by:
  
  addTo in interface Buildable
- getConfigureTypeName
  
  public static String getConfigureTypeName()
- removeFrom
  
  public void removeFrom(Buildable parent)
  
  Description copied from interface: Configurable
  
  Remove this component from its parent
  
  Specified by:
  
  removeFrom in interface Configurable
- getHelpFile
  
  public HelpFile getHelpFile()
  
  Specified by:
  
  getHelpFile in interface Configurable
  
  Returns:
  
  a HelpFilte describing how to use and configure this component
- getAttributeNames
  
  public String[] getAttributeNames()
  
  Description copied from class: AbstractBuildable
  
  Lists all the buildFile (XML) attribute names for this component. If this component is ALSO an AbstractConfigurable, then this list of attributes determines the appropriate attribute order for AbstractConfigurable.getAttributeDescriptions() and AbstractConfigurable.getAttributeTypes().
  
  Specified by:
  
  getAttributeNames in interface AutoConfigurable
  
  Specified by:
  
  getAttributeNames in class AbstractBuildable
  
  Returns:
  
  a list of all buildFile (XML) attribute names for this component
- getAttributeDescriptions
  
  public String[] getAttributeDescriptions()
  
  Description copied from interface: AutoConfigurable
  
  Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object.
  
  Specified by:
  
  getAttributeDescriptions in interface AutoConfigurable
  
  Specified by:
  
  getAttributeDescriptions in class AbstractConfigurable
  
  Returns:
  
  an array of Strings describing the buildFile (XML) attributes of this component. These strings are used as prompts in the Properties window for this object, when the component is configured in the Editor. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()
- getAttributeTypes
  
  public Class<?>[] getAttributeTypes()
  
  Description copied from class: AbstractConfigurable
  
  Return the Class for the buildFile (XML) attributes of this component. Valid classes include: String, Integer, Double, Boolean, Image, Color, and KeyStroke, along with any class for which a Configurer exists in VASSAL.configure. The class determines, among other things, which type of AutoConfigurer will be used to configure the attribute when the object is configured in the Editor. The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()
  
  Specified by:
  
  getAttributeTypes in interface AutoConfigurable
  
  Specified by:
  
  getAttributeTypes in class AbstractConfigurable
- getAllowableConfigureComponents
  
  public Class<?>[] getAllowableConfigureComponents()
  
  Description copied from interface: Configurable
  
  Return a list of valid sub-component Classes. If a Class appears in this list, then instances of that class may be added to this component from the Configuration Window.
  
  Specified by:
  
  getAllowableConfigureComponents in interface Configurable
- addKeyStrokeSource
  
  public void addKeyStrokeSource(KeyStrokeSource src)
  
  The GameModule acts as the mediator for hotkey events. Components that wish to fire hotkey events when they have the focus should register themselves using this method. These events will be forwarded to all listeners that have registered themselves with addKeyStrokeListener(VASSAL.tools.KeyStrokeListener)
- addKeyStrokeListener
  
  public void addKeyStrokeListener(KeyStrokeListener l)
  
  The GameModule acts as the mediator for hotkey events. Objects that react to hotkey events should register themselves using this method. Any component that has been registered with addKeyStrokeSource(VASSAL.tools.KeyStrokeSource) will forward hotkey events to listeners registered with this method.
- refreshKeyStrokeListeners
  
  public void refreshKeyStrokeListeners()
  
  If our keyboard mapping paradigm changes (example: Mac Legacy preference checked/unchecked), we need to reregister all of our KeyStrokeListeners
- fireKeyStroke
  
  @Deprecated(since="2020-08-06", forRemoval=true) public void fireKeyStroke(KeyStroke stroke)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  use fireKeyStroke(NamedKeyStroke)
- fireKeyStroke
  
  public void fireKeyStroke(NamedKeyStroke stroke)
- getGameName
  
  public String getGameName()
  
  Returns:
  
  the name of the game for this module
- getLocalizedGameName
  
  public String getLocalizedGameName()
- getGameVersion
  
  public String getGameVersion()
- addIdChangeListener
  
  public void addIdChangeListener(PropertyChangeListener l)
- removeIdChangeListener
  
  public void removeIdChangeListener(PropertyChangeListener l)
- getPrefs
  
  public Prefs getPrefs()
  
  Returns:
  
  the preferences for this module
- getGlobalPrefs
  
  @Deprecated(since="2020-08-06", forRemoval=true) public Prefs getGlobalPrefs()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  use Prefs.getGlobalPrefs()
  
  A set of preferences that applies to all modules
- addCommandEncoder
  
  public void addCommandEncoder(CommandEncoder ce)
  
  This method adds a CommandEncoder to the list of objects that will attempt to decode/encode a command
  
  See Also:
  
  decode(java.lang.String), encode(VASSAL.command.Command)
- removeCommandEncoder
  
  public void removeCommandEncoder(CommandEncoder ce)
  
  This method removes a CommandEncoder from the list of objects that will attempt to decode/encode a command
  
  See Also:
  
  decode(java.lang.String), encode(VASSAL.command.Command)
- createPiece
  
  public GamePiece createPiece(String type)
  
  Central location to create any type of GamePiece from within VASSAL
  
  Parameters:
  
  type - Type for Piece
  
  Returns:
  
  Created Piece
- createPiece
  
  public GamePiece createPiece(String type, GamePiece inner)
- warn
  
  public void warn(String s)
  
  Display the given text in the control window's status line. Save the messages for later if the Chatter has not been initialised yet
- getRNG
  
  public Random getRNG()
  
  Returns:
  
  a single Random number generator that all objects may share
- getLogger
  
  public Logger getLogger()
  
  Returns:
  
  the object responsible for logging commands to a logfile
- setChatter
  
  public void setChatter(Chatter c)
  
  Set the object that displays chat text. Display any warning messages deferred during earlier initialisation
- getControlPanel
  
  public JComponent getControlPanel()
- getChatter
  
  public Chatter getChatter()
  
  Returns:
  
  the object that displays chat text
- setPrefs
  
  public void setPrefs(Prefs p)
- setGlobalPrefs
  
  @Deprecated(since="2020-08-06", forRemoval=true) public void setGlobalPrefs(Prefs p)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  no replacement
- decode
  
  public Command decode(String command)
  
  Uses the registered CommandEncoders to decode a String into a Command.
  
  Specified by:
  
  decode in interface CommandEncoder
- encode
  
  public String encode(Command c)
  
  Uses the registered CommandEncoders to encode a Command into a String object
  
  Specified by:
  
  encode in interface CommandEncoder
- getFileChooser
  
  public FileChooser getFileChooser()
  
  Returns:
  
  a common FileChooser so that recent file locations can be remembered
- getFileDialog
  
  @Deprecated(since="2020-08-06", forRemoval=true) public FileDialog getFileDialog()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Use getFileChooser() instead.
- getToolBar
  
  public JToolBar getToolBar()
  
  Specified by:
  
  getToolBar in interface ToolBarComponent
  
  Returns:
  
  the JToolBar of the command window
- appendToTitle
  
  public void appendToTitle(String s)
  
  Append the string to the title of the controls window and all Map windows
  
  Parameters:
  
  s - If null, set the title to the default.
- quit
  
  public void quit()
  
  Exit the application, prompting user to save if necessary
- shutDown
  
  public boolean shutDown()
  
  Prompt user to save open game and modules/extensions being edited
  
  Returns:
  
  true if shutDown should proceed, i.e. user did not cancel
- sendAndLog
  
  public void sendAndLog(Command c)
  
  Encode the Command, send it to the server and write it to a logfile (if any is open)
  
  See Also:
  
  encode(VASSAL.command.Command)
- pauseLogging
  
  public boolean pauseLogging()
  
  Pause logging and return true if successful. Return false if logging already paused While Paused, commands are accumulated into pausedCommands so that they can all be logged at the same time, and generate a single UNDO command.
  
  Returns:
  
  Current logging pause status, false if logging currently paused
- resumeLogging
  
  public Command resumeLogging()
  
  Restart logging and return any outstanding commands
- clearPausedCommands
  
  public void clearPausedCommands()
  
  Clear outstanding Commands Use where the calling level handles the sending of outstanding commands
- getUserId
  
  public static String getUserId()
  
  Returns:
  
  a String that uniquely identifies the user
- setUserId
  
  public static void setUserId(String newId)
  
  Set the identifier for the user
- getServer
  
  public ServerConnection getServer()
  
  Returns:
  
  the object reponsible for sending messages to the server
- init
  
  public static void init(GameModule module) throws IOException
  
  Set the singleton GameModule and invoke build() on it.
  
  Throws:
  
  IOException
- unload
  
  public static void unload()
  
  Unload the module
- updateLastSave
  
  public void updateLastSave()
- generateGpId
  
  public String generateGpId()
  
  Description copied from interface: GpIdSupport
  
  Generate a new PieceSlot Id, unique to this top-level component.
  
  Specified by:
  
  generateGpId in interface GpIdSupport
  
  Returns:
  
  PieceSlot Id
- getNextGpId
  
  public int getNextGpId()
  
  Description copied from interface: GpIdSupport
  
  Accessors to check and update the next GpId if necessary.
  
  Specified by:
  
  getNextGpId in interface GpIdSupport
- setNextGpId
  
  public void setNextGpId(int id)
  
  Specified by:
  
  setNextGpId in interface GpIdSupport
- setGpIdSupport
  
  public void setGpIdSupport(GpIdSupport s)
- getGpIdSupport
  
  public GpIdSupport getGpIdSupport()
- checkGpIds
  
  protected void checkGpIds()
  
  Check every PieceSlot and PlaceMarker trait for duplicate, illegal or Missing GamePiece id's and update them if necessary
- getDataArchive
  
  public DataArchive getDataArchive()
  
  Returns:
  
  the object which stores data for the module
- getArchiveWriter
  
  public ArchiveWriter getArchiveWriter()
  
  If the module is being edited, return the writeable archive for the module
- getImageTileSource
  
  public ImageTileSource getImageTileSource()
- isLocalizationEnabled
  
  public boolean isLocalizationEnabled()
  
  Is the module being translated into the user's Locale? Localization is disabled when editing a module
  
  Returns:
  
  true if the module/extension has been localized
- getGameModule
  
  public static GameModule getGameModule()
  
  Returns:
  
  the singleton instance of GameModule
- getGameState
  
  public GameState getGameState()
  
  Return the object responsible for tracking the state of a game. Only one game in progress is allowed;
- saveAs
  
  public void saveAs()
- save
  
  public void save()
  
  If the module is being edited, write the module data
- save
  
  protected void save(boolean saveAs)
- buildString
  
  protected String buildString()
- getProperty
  
  public Object getProperty(Object key)
  
  Return values of Global properties
  
  Specified by:
  
  getProperty in interface PropertySource
- getMutableProperty
  
  public MutableProperty getMutableProperty(String name)
  
  Description copied from interface: MutablePropertiesContainer
  
  Find a GlobalProperty object with the given name
  
  Specified by:
  
  getMutableProperty in interface MutablePropertiesContainer
- addMutableProperty
  
  public void addMutableProperty(String key, MutableProperty p)
  
  Description copied from interface: MutablePropertiesContainer
  
  Add a property under the given key
  
  Specified by:
  
  addMutableProperty in interface MutablePropertiesContainer
- removeMutableProperty
  
  public MutableProperty removeMutableProperty(String key)
  
  Description copied from interface: MutablePropertiesContainer
  
  Remove the property with the given key
  
  Specified by:
  
  removeMutableProperty in interface MutablePropertiesContainer
- getMutablePropertiesContainerId
  
  public String getMutablePropertiesContainerId()
  
  Description copied from interface: MutablePropertiesContainer
  
  Return a unique Id for the container
  
  Specified by:
  
  getMutablePropertiesContainerId in interface MutablePropertiesContainer
- getLocalizedProperty
  
  public Object getLocalizedProperty(Object key)
  
  Specified by:
  
  getLocalizedProperty in interface PropertySource
- getCrc
  
  public long getCrc()
- buildCrc
  
  protected Long buildCrc()
- getI18nData
  
  public ComponentI18nData getI18nData()
  
  Specified by:
  
  getI18nData in interface Translatable
  
  Overrides:
  
  getI18nData in class AbstractConfigurable
  
  Returns:
  
  the i18n data for this component
- getPlayerRoster
  
  public PlayerRoster getPlayerRoster()
  
  Returns:
  
  the PlayerRoster instance, or null if no PlayerRoster exists within this GameModule
- addSideChangeListenerToPlayerRoster
  
  public void addSideChangeListenerToPlayerRoster(PlayerRoster.SideChangeListener l)

Class GameModule

Nested Class Summary

Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable

Nested classes/interfaces inherited from interface VASSAL.build.module.properties.MutablePropertiesContainer

Field Summary

Fields inherited from class VASSAL.build.AbstractConfigurable

Fields inherited from class VASSAL.build.AbstractBuildable

Fields inherited from interface VASSAL.build.Configurable

Constructor Summary

Method Summary

Methods inherited from class VASSAL.build.AbstractConfigurable

Methods inherited from class VASSAL.build.AbstractBuildable

Methods inherited from class java.lang.Object

Methods inherited from interface VASSAL.build.Buildable

Field Details

DEFAULT_NAME

MODULE_NAME

MODULE_VERSION

DESCRIPTION

VASSAL_VERSION_CREATED

VASSAL_VERSION_RUNNING

NEXT_PIECESLOT_ID

BUILDFILE

moduleVersion

vassalVersionCreated

gameName

localizedGameName

description

lastSavedConfiguration

fileChooser

fileDialog

propsContainer

repaintOnPropertyChange

frame

controlPanel

theState

archive

preferences

logger

chat

RNG

server

tcache

wizardSupport

idChangeSupport

keyStrokeSources

keyStrokeListeners

commandEncoders

deferredChat

nextGpId

loggingPaused

loggingLock

pausedCommands

gpidSupport

crc

REAL_NAME

SECRET_NAME

PERSONAL_INFO

Constructor Details

GameModule

Method Details

getFrame

getPlayerWindow

initFrameTitle

getWizardSupport

build

setAttribute

getAttributeValueString

compareVersions

addTo

getConfigureTypeName

removeFrom

getHelpFile

getAttributeNames

getAttributeDescriptions

getAttributeTypes

getAllowableConfigureComponents

addKeyStrokeSource

addKeyStrokeListener

refreshKeyStrokeListeners