Class BasicModule

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.GameModule

VASSAL.launch.BasicModule

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, GpIdSupport, MutablePropertiesContainer, PropertyNameSource, PropertySource, TranslatableStringContainer, CommandEncoder, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget, ToolBarComponent

@Deprecated(since="2020-09-01",
            forRemoval=true)
public class BasicModule
extends GameModule

Deprecated, for removal: This API element is subject to removal in a future version.

Nested Class Summary

Nested classes/interfaces inherited from class GameModule

GameModule.GameFileMode

Modifier and Type	Class	Description
static enum	GameModule.GameFileMode	Last type of game save/load for our current game

Nested classes/interfaces inherited from interface AutoConfigurable

AutoConfigurable.Util

Modifier and Type	Interface	Description
static class	AutoConfigurable.Util

Nested classes/interfaces inherited from interface MutablePropertiesContainer

MutablePropertiesContainer.Impl

Modifier and Type	Interface	Description
static class	MutablePropertiesContainer.Impl	Simple implementation of MutablePropertiesContainer

Nested classes/interfaces inherited from interface TranslatableStringContainer

TranslatableStringContainer.Impl

Modifier and Type	Interface	Description
static class	TranslatableStringContainer.Impl	Simple implementation of TranslatableStringContainer

Field Summary

Fields inherited from class GameModule

BUILDFILE, BUILDFILE_OLD, DESCRIPTION, DRAWING_MOUSEOVER_INDEX_PROPERTY, DRAWING_MOUSEOVER_PROPERTY, IS_VISIBLE, MODULE_CURRENT_LOCALE, MODULE_CURRENT_LOCALE_NAME, MODULE_DESCRIPTION_PROPERTY, MODULE_NAME, MODULE_NAME_PROPERTY, MODULE_OTHER1_PROPERTY, MODULE_OTHER2_PROPERTY, MODULE_VASSAL_VERSION_CREATED_PROPERTY, MODULE_VASSAL_VERSION_RUNNING_PROPERTY, MODULE_VERSION, MODULE_VERSION_PROPERTY, NEXT_PIECESLOT_ID, PERSONAL_INFO, REAL_NAME, RECENT_GAMES, SECRET_NAME, UI_PIECE_COUNT, UI_PIECE_INDEX, VASSAL_VERSION_CREATED, VASSAL_VERSION_RUNNING

Modifier and Type	Field	Description
static final String	BUILDFILE
static final String	BUILDFILE_OLD
static final String	DESCRIPTION
static final String	DRAWING_MOUSEOVER_INDEX_PROPERTY
static final String	DRAWING_MOUSEOVER_PROPERTY
static final String	IS_VISIBLE
static final String	MODULE_CURRENT_LOCALE
static final String	MODULE_CURRENT_LOCALE_NAME
static final String	MODULE_DESCRIPTION_PROPERTY
static final String	MODULE_NAME
static final String	MODULE_NAME_PROPERTY
static final String	MODULE_OTHER1_PROPERTY
static final String	MODULE_OTHER2_PROPERTY
static final String	MODULE_VASSAL_VERSION_CREATED_PROPERTY
static final String	MODULE_VASSAL_VERSION_RUNNING_PROPERTY
static final String	MODULE_VERSION
static final String	MODULE_VERSION_PROPERTY
static final String	NEXT_PIECESLOT_ID
static final String	PERSONAL_INFO	The Prefs key for the user's personal info
static final String	REAL_NAME	The Prefs key for the user's real name
static final String	RECENT_GAMES
static final String	SECRET_NAME	The Prefs key for the user's secret name
static final String	UI_PIECE_COUNT
static final String	UI_PIECE_INDEX
static final String	VASSAL_VERSION_CREATED
static final String	VASSAL_VERSION_RUNNING	The System property of this name will return a version identifier for the version of VASSAL being run

Fields inherited from class AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Modifier and Type	Field	Description
protected PropertyChangeSupport	changeSupport
protected Configurer	config
protected String	localizedName
protected ComponentI18nData	myI18nData
protected String	name

Fields inherited from class AbstractBuildable

buildComponents, validator

Modifier and Type	Field	Description
protected List<Buildable>	buildComponents
protected ValidityChecker	validator

Fields inherited from interface Configurable

NAME_PROPERTY

Modifier and Type	Field	Description
static final String	NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
BasicModule(DataArchive archive)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Methods inherited from class GameModule

addCommandEncoder, addIdChangeListener, addKeyStrokeListener, addKeyStrokeSource, addMutableProperty, addSideChangeListenerToPlayerRoster, addTo, addTranslatableString, appendToTitle, build, clearPausedCommands, clearTempUserId, createPiece, createPiece, decode, encode, finalizeUiPieceProcessing, fireKeyStroke, generateGpId, getActiveUserId, getAllowableConfigureComponents, getArchiveWriter, getAttributeDescriptions, getAttributeNames, getAttributeTypes, getAttributeValueString, getBasicLogger, getChatter, getCombinedCrc, getCombinedCrc, getConfigureTypeName, getConsole, getControlPanel, getCrc, getCrc, getDataArchive, getDebugControls, getDeckManager, getEditorImageChooser, getEditorSoundChooser, getExpressionList, getFileChooser, getFrame, getGameFile, getGameFileMode, getGameModule, getGameName, getGameState, getGameVersion, getGpIdSupport, getHelpFile, getI18nData, getI18nPrefix, getImageTileSource, getIndexManager, getLocalizedGameName, getLocalizedProperty, getLocationKeyCommand, getLogger, getModuleOther1, getModuleOther2, getMutablePropertiesContainerId, getMutableProperty, getNextGpId, getPasswordConfigurer, getPieceWindow, getPlayerRoster, getPlayerWindow, getPrefs, getProperty, getPropertyNames, getResourcePathFinder, getRNG, getServer, getServerControls, getTempUserId, getTitleString, getToolBar, getTranslatableString, getTranslatableStringContainerId, getUiPieceCount, getUiPieceIndex, getUserId, getWindowTitleString, getWindowTitleString, getWizardSupport, init, initFrameTitle, initializeUiPieceProcessing, isEditorOpen, isErrorLogToChat, isLoadingContinuationSemaphore, isLoadOverSemaphore, isLocalizationEnabled, isMatSupport, isMultiPlayer, isMultiplayerConnected, isMutableButtonLabelSupport, isNonBlankPassword, isRealName, isRefreshingSemaphore, isReplayingOrLogging, isSuppressAutoCenterUpdate, isSuppressSounds, isTranslatableSupport, isTrueMovedSupport, pauseLogging, processNextUiPiece, quit, refreshKeyStrokeListeners, refreshVisibleMaps, removeCommandEncoder, removeFrom, removeIdChangeListener, removeKeyStrokeListener, removeMutableProperty, removeSideChangeListenerFromPlayerRoster, removeTranslatableString, resetSourcesAndListeners, resumeLogging, save, saveAs, sendAndLog, setAttribute, setChatter, setDirty, setErrorLogToChat, setGameFile, setGameFileMode, setGpIdSupport, setLoadingContinuationSemaphore, setLoadOverSemaphore, setLocationKeyCommand, setMatSupport, setMutableButtonSupport, setNextGpId, setPieceWindow, setPrefs, setRefreshingSemaphore, setSuppressAutoCenterUpdate, setSuppressSounds, setTempUserId, setTrueMovedSupport, setUserId, shutDown, toString, updateLastSave, updateMutableButtonLabels, updateTitleBar, warn

Modifier and Type	Method	Description
void	addCommandEncoder(CommandEncoder ce)	GameModule holds the master list of CommandEncoders, and invokes them as appropriate when commands are sent and received.
void	addIdChangeListener(PropertyChangeListener l)	Currently used to listen for changes to player names
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)	Adds a new mutable (changeable) "Global Property" to the Module.
void	addSideChangeListenerToPlayerRoster(PlayerRoster.SideChangeListener l)	Adds listener for players changing sides
void	addTo(Buildable b)	Game Module is normally at the root of the hierarchy, so it doesn't expect to get added to anything.
void	addTranslatableString(String key, TranslatableString p)	Add a property under the given key
void	appendToTitle(String s)	Deprecated, for removal: This API element is subject to removal in a future version. use GameModule.updateTitleBar()
void	build(Element e)	Builds the module's component hierarchy from a given XML element, or a null one is given initializes a brand new default "new module" hierarchy.
void	clearPausedCommands()	Clear outstanding Commands Use where the calling level handles the sending of outstanding commands
static void	clearTempUserId()
GamePiece	createPiece(String type)	Central location to create any type of GamePiece from within VASSAL
GamePiece	createPiece(String type, GamePiece inner)	Central location to create any type of GamePiece Trait (Decorator) from within VASSAL
Command	decode(String command)	Decodes our inbound Command traffic -- incoming player commands ready to be executed.
String	encode(Command c)	Encodes our outbound Command traffic -- outgoing player commands to be sent to other players' clients via either online (server) or logfile (PBEM).
final void	finalizeUiPieceProcessing()	Record the end of a multi-piece UI gesture
void	fireKeyStroke(NamedKeyStroke stroke)	Invokes a NamedKeyStroke to all of our listeners.
String	generateGpId()	Allocates the next available GamePiece ID and returns it.
static String	getActiveUserId()
Class<?>[]	getAllowableConfigureComponents()	List of subcomponents which can be added to a GameModule.
ArchiveWriter	getArchiveWriter()	VASSAL modules are stored in ".vmod" files, which are actually simple ".zip" files with a unique extension.
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 attributes of this object.
String	getAttributeValueString(String name)	Called by the Buildable.getBuildElement(Document) method to write the attributes into an XML element
BasicLogger	getBasicLogger()
Chatter	getChatter()
long	getCombinedCrc()
long	getCombinedCrc(boolean forceRegenerate)
static String	getConfigureTypeName()	Gets the generic name for this type of class across all instances of it.
Console	getConsole()
JComponent	getControlPanel()
long	getCrc()
long	getCrc(boolean forceRegenerate)
DataArchive	getDataArchive()	VASSAL modules are stored in ".vmod" files, which are actually simple ".zip" files with a unique extension.
DebugControls	getDebugControls()
DeckManager	getDeckManager()
FileChooser	getEditorImageChooser()
FileChooser	getEditorSoundChooser()
List<String>	getExpressionList()	SearchTarget
FileChooser	getFileChooser()
JFrame	getFrame()	Deprecated. use GameModule.getPlayerWindow()
String	getGameFile()
GameModule.GameFileMode	getGameFileMode()
static GameModule	getGameModule()
String	getGameName()
GameState	getGameState()	Return the object responsible for tracking the state of a game.
String	getGameVersion()
GpIdSupport	getGpIdSupport()
HelpFile	getHelpFile()
ComponentI18nData	getI18nData()
String	getI18nPrefix()
ImageTileSource	getImageTileSource()
IndexManager	getIndexManager()
String	getLocalizedGameName()
Object	getLocalizedProperty(Object key)	Returns a localized translation of the specified property value, if available.
KeyCommand	getLocationKeyCommand()
Logger	getLogger()
String	getModuleOther1()
String	getModuleOther2()
String	getMutablePropertiesContainerId()	Return a unique Id for the container
MutableProperty	getMutableProperty(String name)	Gets the value of a mutable (changeable) "Global Property".
int	getNextGpId()	Accessors to check and update the next GpId if necessary.
ToggleablePasswordConfigurer	getPasswordConfigurer()
PieceWindow	getPieceWindow()
PlayerRoster	getPlayerRoster()
PlayerWindow	getPlayerWindow()	"Player" in this context meaning the VASSAL Player, i.e. the main module window, as opposed to any individual player meaning participant-in-a-boardgame.
Prefs	getPrefs()
Object	getProperty(Object key)	Gets the value of a module level global property -- this includes identification information for the local player as well as the contents of any Global Property objects defined at module level in the Module.
List<String>	getPropertyNames()	Override this method to provide a list of properties to be exposed for use by expressions in the module.
ResourcePathFinder	getResourcePathFinder()
Random	getRNG()
ServerConnection	getServer()
ChatServerControls	getServerControls()
static String	getTempUserId()
String	getTitleString()	Returns an appropriate Title Bar string for the main module window, based on the module name, the last read/written game file, and the manner of interaction with it.
JToolBar	getToolBar()	Provides access to the Game Module's toolbar.
TranslatableString	getTranslatableString(String name)	Find an object with the given name
String	getTranslatableStringContainerId()	Return a unique Id for the container
int	getUiPieceCount()	Return number of pieces to be processed by the current multi-piece UI gesture
int	getUiPieceIndex()	Return the index of the current piece being processed by the current multi-piece UI gesture
static String	getUserId()
String	getWindowTitleString(String key, String name)
String	getWindowTitleString(String key, String name, boolean moduleVersion)	Returns an appropriate Title Bar string for a window, based on the module name, the last read/written game file, and the manner of interaction with it.
WizardSupport	getWizardSupport()
static void	init(GameModule module)	Loads a module object into the player window.
void	initFrameTitle()	Sets the proper name for module window's title bar
final void	initializeUiPieceProcessing(int pieceCount)	A multi-piece UI gesture is starting.
boolean	isEditorOpen()	Is an editor window currently open
static boolean	isErrorLogToChat()
boolean	isLoadingContinuationSemaphore()
boolean	isLoadOverSemaphore()
boolean	isLocalizationEnabled()	Is the module being translated into the user's Locale?
boolean	isMatSupport()
boolean	isMultiPlayer()
boolean	isMultiplayerConnected()
boolean	isMutableButtonLabelSupport()
boolean	isNonBlankPassword()	Returns true if user has supplied a real password for current GameModule.
boolean	isRealName()	Returns true if user has supplied a real name Test's whether GameModule.REAL_NAME is non-empty and not "newbie"
boolean	isRefreshingSemaphore()
boolean	isReplayingOrLogging()
boolean	isSuppressAutoCenterUpdate()
boolean	isSuppressSounds()
boolean	isTranslatableSupport()
boolean	isTrueMovedSupport()
boolean	pauseLogging()	Pause logging and return true if successful.
final void	processNextUiPiece()	The next piece in a multi-piece UI gesture is about to be processed.
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
final void	refreshVisibleMaps()	Refresh the visible portions of all currently showing maps.
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)	Since we aren't expecting to be GameModule.addTo(Buildable)'ed to a parent, we likewise don't need to do much about being "removeFrom'ed" one.
void	removeIdChangeListener(PropertyChangeListener l)	Currently used to listen for changes to player names
void	removeKeyStrokeListener(KeyStrokeListener l)
MutableProperty	removeMutableProperty(String key)	Removes a mutable property from the Global Properties list.
void	removeSideChangeListenerFromPlayerRoster(PlayerRoster.SideChangeListener l)	Removes listener for players changing sides
TranslatableString	removeTranslatableString(String key)	Remove the property with the given key
void	resetSourcesAndListeners()
Command	resumeLogging()	Restart logging and return any outstanding commands
void	save()	If the module is being edited, write the module data to the current filename
void	saveAs()	If the module is being edited, write the module data after prompting for a new filename.
void	sendAndLog(Command c)	When the local player has taken any action that would change the game state (or otherwise needs to be sent to any other players' clients), the action should be encapsulated into a Command and sent here.
void	setAttribute(String name, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setChatter(Chatter c)	Allows the Chat Log window to register itself to the Module.
void	setDirty(boolean touchThis)
static void	setErrorLogToChat(boolean errorLogToChat)
void	setGameFile(String gameFile, GameModule.GameFileMode mode)	Sets the most recent .VSAV / .VLOG file saved, loaded, or logged to, along with the type of action taken with that file.
void	setGameFileMode(GameModule.GameFileMode mode)	Sets the type of interaction we most recently had with saving/loading/replaying/logging, for managing title bars of windows.
void	setGpIdSupport(GpIdSupport s)	Registers a GamePiece ID support object for us to manage a namespace for unique GamePiece objects.
void	setLoadingContinuationSemaphore(boolean state)
void	setLoadOverSemaphore(boolean state)
void	setLocationKeyCommand(KeyCommand kc)
void	setMatSupport(boolean matSupport)
void	setMutableButtonSupport(boolean support)
void	setNextGpId(int id)	Sets the next available GamePiece ID
void	setPieceWindow(PieceWindow pieceWindow)	Allows a PieceWindow that wants to be our docked PieceWindow to register itself.
void	setPrefs(Prefs p)
void	setRefreshingSemaphore(boolean state)
void	setSuppressAutoCenterUpdate(boolean suppressAutoCenterUpdate)
void	setSuppressSounds(boolean suppressSounds)
static void	setTempUserId(String id)
void	setTrueMovedSupport(boolean trueMovedSupport)
static void	setUserId(String newId)	Set the identifier for the user
boolean	shutDown()	Prompt user to save open game and modules/extensions being edited
String	toString()
void	updateLastSave()	Save the current buildString for comparison when we try and quit.
void	updateMutableButtonLabels()	A property has changed somewhere, so we need to redraw all the toolbar buttons that use properties
void	updateTitleBar()	Updates the title bar of the main module window, and all map windows
void	warn(String s)	Display the given text in the control window's status line.

Methods inherited from class AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigureName, getConfigurer, getFormattedStringList, getLocalizedConfigureName, getMenuTextList, getNamedKeyStrokeList, getPropertyList, getTypeName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Modifier and Type	Method	Description
void	add(Buildable b)	Set the owning translatable of this component
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
Configurable[]	getConfigureComponents()
String	getConfigureName()	ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
List<String>	getFormattedStringList()	SearchTarget
String	getLocalizedConfigureName()
List<String>	getMenuTextList()	SearchTarget
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
List<String>	getPropertyList()	SearchTarget
String	getTypeName()	Returns the name of the configurable type for display purposes.
void	remove(Buildable b)	Remove a Buildable object from this object
void	removePropertyChangeListener(PropertyChangeListener l)
protected void	setAllAttributesUntranslatable()	Sets all attributes untranslatable.
protected void	setAttributeTranslatable(String attr, boolean b)	Over-ride the default attribute translatability.
void	setConfigureName(String s)	Sets the name and fires a PropertyChangeEvent

Methods inherited from class AbstractBuildable

addImageNamesRecursively, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, setAncestor, validate

Modifier and Type	Method	Description
void	addImageNamesRecursively(Collection<String> s)	Adds all images used by this component AND any subcomponents to the collection
String	buildString()
<T> List<T>	getAllDescendantComponentsOf(Class<T> target)	Recursively descend the build tree and return a List of all components that are instances of the given class
Buildable	getAncestor()
List<Buildable>	getBuildables()
Enumeration<Buildable>	getBuildComponents()	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getBuildables() instead.
Element	getBuildElement(Document doc)
<T> Enumeration<T>	getComponents(Class<T> target)	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getComponentsOf(Class) instead.
<T> List<T>	getComponentsOf(Class<T> target)
Buildable	getNonFolderAncestor()
void	setAncestor(Buildable ancestor)
void	validate(Buildable target, ValidationReport report)

Methods inherited from class AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	Classes extending AbstractImageFinder should override this method in order to add the names of any image files they use to the collection.
SortedSet<String>	getAllImageNames()
SortedSet<String>	getLocalImageNames()

Methods inherited from class Object

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

Methods inherited from interface Auditable

getComponentName, getComponentTypeName

Modifier and Type	Method	Description
default String	getComponentName()	Return the name of the trait or Component an Auditable is
default String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is

Methods inherited from interface Buildable

isMandatory, isMovable, isUnique

Modifier and Type	Method	Description
default boolean	isMandatory()	Is this component a reqired component within its parent?
default boolean	isMovable()	Is this component allowed to be moved around the Configure Tree?
default boolean	isUnique()	Does this component need to be unique within it's parent?

Methods inherited from interface ToolBarComponent

updateToolbarButtons

Modifier and Type	Method	Description
default void	updateToolbarButtons()	Update the text labels in the toolbar's component buttons (for mutable button label support)

Constructor Details

BasicModule

@Deprecated(since="2020-09-01",
            forRemoval=true)
public BasicModule(DataArchive archive)

Deprecated, for removal: This API element is subject to removal in a future version.