All Classes

Class Description
AboutScreen
Places an entry in the Help menu.
AboutVASSALAction  
AboutWindow  
AbstractBuildable
Abstract implementation of the Buildable interface.
AbstractConfigurable
An abstract implementation of the Configurable interface.
AbstractConfigurableListEntry
Base class for a List Entry maintained by a ConfigurableList A ConfigurableListEntry must be configurered by a single Configurer.
AbstractImageFinder
Abstract implementation of ImageSearchTarget interface.
AbstractInterpreter  
AbstractLaunchAction
The base class for Actions which launch processes from the ModuleManagerWindow.
AbstractMetaData
Base class representing the metadata for a Saved Game, Module or Extension.
AbstractOpImpl
An abstract representation of an operation which may be applied to an Image.
AbstractOpImpl<V>
An abstract representation of an operation.
AbstractParent<T extends JComponent>  
AbstractPropertyContainer
An abstract base class for PropertyContainers.
AbstractProxy<T extends JComponent>  
AbstractScript  
AbstractTiledOpImpl
The abstract base class for ImageOps which support multiple tiles.
AbstractTileOpImpl
The abstract base class for ImageOps which are a single tile.
AbstractToolbarItem
Creates an item that is both configurable w/ an edit box AbstractConfigurable and buildable from the XML buildFile AbstractBuildable, but which also has a Toolbar launch button.
AbstractToolbarItem.IconConfig
Configures the toolbar's button icon.
AbstractUpdateCheckRequest  
AcceptPeerThread
Date: Mar 11, 2003
ActionButton
A Trait (aka Decorator that acts like a button on a GamePiece, such that clicking on a particular area of the piece invokes a key command
ActionButton.ButtonPusher
Registers mouse listeners with Maps and other components.
ActionButton.Ed  
ActionManager  
ActionScript  
ADC2Module  
ADC2Module.FacingDirection  
ADC2Module.ForcePoolList  
ADC2Module.HideState  
ADC2Module.Player  
ADC2Module.StateFlag  
ADC2Module.ValueType  
ADC2ModuleFileFilter
A FileFilter for ADC2 modules.
ADC2Utils
Common utilities for importing ADC2 modules to VASSAL.
ADC2Utils.NoMoreBlocksException  
AddPiece
This Command adds a GamePiece to a game.
AddressBookServerConfigurer
Improved version of ServerConfigurer that includes an Address Book of commonly visited private servers and P2P clients.
AddSecretNoteCommand
When executed, adds a SecretNote to a specified List.
AddSecretNoteCommand.Interface  
AdjustableSpeedScrollPane
AdjustableSpeedScrollPane extends ScrollPane by making the scroll speed user-configurable.
AlertCommand
This command, when executed, displays a Dialog box with a message
ApplicationIcons  
ArchiveWriter
An ArchiveWriter is a writeable DataArchive.
AreaCache  
AreaOfEffect  
AreaOfEffect.TraitEditor  
ArgsParser  
ArrayIterator<T> Deprecated.
ArrayUtils Deprecated.
Use ArrayUtils.
AsynchronousServerNode
Root node in a hierarchical server.
AsynchronousServerNode.ReportContentsThread  
AudioClip  
AudioClipConfigurer
Class for selecting an AudioClip while editing a module and adding it to module
AudioFileFilter
A FileFilter for AIFF, AU, and WAV files.
AudioSystemClip  
AutoConfigurable
A class that implements AutoConfigurable can use the AutoConfigurer class to automatically build a property editor.
AutoConfigurable.Util  
AutoConfigurer
A Configurer for configuring Configurable components (Is that as redundant as it sounds?) Automatically builds a property editor with controls for setting all of the attributes of the target Configurable component
BackgroundTask Deprecated.
Use {link SwingWorker} now that we ship the JAR for it.
BadDataReport
General-purpose condition indicating that VASSAL has encountered data that's inconsistent with the current module.
BasicChatControlsInitializer
Adds Connect/Disconnect button to the server controls toolbar
BasicCommandEncoder
Although it is the CommandEncoder which 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 contains BasicCommandEncoder.createDecorator(java.lang.String, VASSAL.counters.GamePiece), the BasicCommandEncoder.DecoratorFactory for Traits, which are usually internally referred to as Decorators because they are implemented using the Decorator Pattern.
BasicCommandEncoder.BasicPieceFactory
Factory interface for BasicPieces.
BasicCommandEncoder.DecoratorFactory
Factory interface for Decorators See: Decorator Pattern, Factory Pattern
BasicLogger
BasicLogger deals with VLOG Vassal Log files (i.e.
BasicLogger.LogCommand  
BasicModule Deprecated, for removal: This API element is subject to removal in a future version.
BasicPiece
Basic class for representing a physical component of the game.
BasicPreference
Base class for a Module Preference.
BasicPreference.NoteConfig  
BeanShell
Class encapsulating BeanShell support in Vassal
BeanShellExpression
A basic beanShell expression
BeanShellExpressionConfigurer
A Configurer for Java Expressions
BeanShellExpressionConfigurer.Option
enum describing any special processing that needs to be done for particular expression types NONE = No special handling PME = Property Match Expression handling.
BeanShellFunctionMenu  
BMPFileFilter
A FileFilter for BMP images.
Board  
Board.Cleanup Deprecated, for removal: This API element is subject to removal in a future version.
Only used to cleanup Board images, which is now handled automatically by the cache.
BoardPicker
This class is responsible for maintaining the Boards on a Map.
BoardPicker.SetBoards  
BoardSlot  
BonesDiceServer  
BooleanAndPieceFilter
Boolean and of two PieceFilters
BooleanConfigurer
Configurer for Boolean values
BooleanOrPieceFilter
Boolean Or of two PieceFilters
BooleanPreference
A Checkbox Module Preference.
BoundsTracker
Records the bounding boxes of GamePieces.
BoxWidget
A Widget that corresponds to a panel with a JComboBox above a JPanel with a CardLayout layout.
BrokenImageException
An exception indicating that an image file is broken in some way.
BrowserHelpFile
Unpacks a zipped directory stored in the module and displays it in an external browser window.
BrowserHelpFile.ContentsConfig  
BrowserHelpFile.MyConfigurer
Handles the packaging of the target directory into the module file after the user saves the properties in the editor
BrowserPDFFile
Easier-to-use support for opening a single PDF file in the browser (it can be done with BrowserHelpFile, but requires a substantial workaround and weird confusing procedures)
BrowserSupport
Utility class for displaying an external browser window.
BshCommandEncoder
Used by the Bsh Plugin
BshPlugin  
Bug2694Handler  
BugDialog  
BugHandler  
BugUtils  
Buildable
A Buildable is an object which can be initialized from an XML configuration file (e.g.
Builder
This class holds static convenience methods for building Buildable objects.
BundleHelper
Utility class for extracting strings from a ResourceBundle.
ButtonFactory
Produce standard Vassal buttons.
CalculatedProperty
Conditional Marker A marker with a variable value depending on conditions.
CalculatedProperty.Ed
Trait Editor implementation
Callback<T>  
CardSlot
A CardSlot is identical to a PieceSlot except that it is initialized with a card-like GamePiece.
CgiServerStatus
Queries a known URL to get historical status of the chat room server.
ChangePiece
This Command changes the state of a GamePiece.
ChangePropertyButton
Adds a toolbar button that changes the value of a global property
ChangePropertyButton.PropChangerOptions  
ChangePropertyButton.ReportFormatConfig  
ChangePropertyCommand
Command to change the value of a MutableProperty
ChangePropertyCommandEncoder
ChangeTracker
Utility class for generating ChangePiece commands.
Chart
A Chart is used for displaying charts and tables for the module.
ChartWindow
A top-level Widget for displaying Charts
ChartWindow.IconConfig  
ChatControlsInitializer
Interface for registering event listeners with the Swing components in a ChatServerControls component
ChatServerConnection
Specialized interface for chat-room server connections
ChatServerControls  
ChatServerFactory
A Factory for building ChatServerConnection instances
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
CheckBoxMenuItemProxy  
ChessClock
CHESS CLOCK class for VASSAL.
ChessClock.ColorConfig
Color auto-configurer.
ChessClock.ColorConfig2
Color auto-configurer.
ChessClock.ColorConfig3
Color auto-configurer.
ChessClock.IconConfig
Autoconfigurer for the icon for this timer.
ChessClock.PlayerSidesConfig
PlayerSidesConfig makes a dropdown of all the player sides
ChessClockControl
CHESS CLOCK CONTROLLER for VASSAL.
ChessClockControl.IconConfig
Autoconfigurer for master chessclock button icon (allows user to choose an icon image)
ChessClockControl.TimeStyleConfig
Autoconfigurer for the days/hours/minutes/seconds/tenths styles
ChildProxy<T extends JComponent>  
ChooseComponentDialog
Dialog that prompts the user to select a component from the ConfigureTree
ChooseComponentPathDialog
Widget for selecting the full path of a Component in the Buildable hierarchy
ClientTest  
Clone
This trait adds a command that creates a duplicate of the selected Gamepiece
Clone.Ed  
ColorButton
A JButton which displays a color swatch.
ColorConfigurer
Configurer for Color values.
ColoredBorder  
ColorManager
Container for definitions of Generic Color Definitions
ColorSwatch
Class that implements a named Color Swatch
ColorSwatchConfigurer  
Command
A Command represents an action that needs to be transmitted from one client to another - any action that could change the game state of a multiplayer game should be encapsulated in a Command object.
CommandDecoder
Listens for incoming messages (PropertyChangeEvents with name {ChatServerConnection.INCOMING_MSG}) and interprets the message as a command to be executed
CommandEncoder
Translates a Command to and from a string.
CommandFilter
Remove sub-commands from a composite command
CompileResult  
ComponentConfigPanel
A standardised Panel for use by Component configurers
ComponentI18nData
Object encapsulating the internationalization information for a component.
ComponentI18nData.Property
An attribute of a Configurable component that can be translated into another language
ComponentLayout
A standardised MigLayout for use by Component configurers
ComponentPathBuilder
Provides an XPath-like syntax for identifying configuration components
ComponentPathBuilder.PathFormatException  
ComponentSplitter Deprecated, for removal: This API element is subject to removal in a future version.
Use SplitPane instead.
ComponentSplitter.SplitPane
Contains methods to automatically show/hide one of its components (the "hideable" component) while the other (the "base" component) remains always visible.
CompositeInputStream
An InputStream which concatenates other InputStreams.
CompoundPieceCollection
Base class for PieceCollection implementation that organizes GamePieces -- a category which in this case also includes Decks and Stacks, in addition to ordinary pieces -- into distinct visual layers.
CompoundValidityChecker
Combines multiple instances of ValidityChecker
Compressor  
ConcurrentPropertySupport
A thread-safe implementation of PropertySupport.
ConcurrentSoftHashMap<K,​V>
A memory-sensitive ConcurrentMap which stores the values in SoftReferences.
ConcurrentSoftHashMap.SimpleEntry<K,​V>
An implementation of Map.Entry.
ConditionalCommand
Evaluates properties of the GameModule and conditionally executes another Command if all values are satisfied.
ConditionalCommand.Condition
The class representing a condition that must be satisfied if the Command is to be executed
ConditionalCommand.Eq  
ConditionalCommand.Gt  
ConditionalCommand.Lt  
ConditionalCommand.Not  
Config  
Configurable
An object that implements the Configurable interface, in addition to being built from a configuration XML file (because this class ultimately extends Buildable, can be manipulated by the user directly in the VASSAL module editor via the Configuration window.
ConfigurableList
An interface to be implemented by Configurers that manage variable sized lists.
ConfigurableListController
A small panel of buttons for controlling the entries in a Configurablelist See also ConfigurableList, ConfigurableListEntry, ConfigurableListController
ConfigurableListEntry
An interface to be implemented by Configurers that manage variable sized lists.
Configurer
A property editor class.
ConfigurerFactory
General purpose type for defining property-sheet editors.
ConfigurerLayout
A Standardised MigLayout for use by individual Configurers
ConfigurerPanel
A standardised Panel to hold an individual Configurer
ConfigurerWindow
A Window for displaying a Configurer.
ConfigureTree
The beating heart of the Editor, this class handles the Configuration Tree that appears in the Configuration window when editing a VASSAL module.
ConfigureTree.AdditionalComponent  
ConfigureTree.Mutable
Configurers that add or remove their own children directly should implement the Mutable interface so that ConfigureTree can refresh the changed node.
ConnectionLimiter
Limits connections to the server to one per registered username
ConnectionWindow
This is now a dummy class
Console
Expandable "Console" to allow entering commands into the Chatter.
ConsoleAppender
Grabs errorlog output and displays it in the Chatter.
CounterDetailViewer
This is a Drawable class that draws the counters horizontally when the mouse is held over a stack with the control key down.
CounterDetailViewer.CounterFormatConfig  
CounterDetailViewer.DisplayConfig  
CounterDetailViewer.EmptyFormatConfig  
CounterDetailViewer.MinConfig  
CounterDetailViewer.ReportFormatConfig  
CounterDetailViewer.Visitor  
CounterGlobalKeyCommand
Trait that sends a Key Command to other pieces, selected with various filters.
CounterGlobalKeyCommand.Ed  
CounterNames  
CounterTurnLevel  
CountingReadWriteLock
A ReadWriteLock which counts locks held.
CountingReadWriteLock.BaseLock  
CountingReadWriteLock.Sync  
CRCUtils
Some general purpose CRC utilities.
CreateModuleAction  
CropOp
An ImageOp which crops its source.
CropOpBitmapImpl
An ImageOp which crops its source.
CurrentRoomActions
Interface for user interactions with players in the current room
CustomVmOptions  
DaemonThreadFactory
A thread factory which creates daemon threads.
DataArchive
Wrapper around a Zip archive with methods to cache images
DataArchiveHTMLEditorKit
Extended HTML Editor kit to let the tag display images from the module DataArchive where no pathname is included in the image name.
Deck
A collection of pieces that behaves like a deck, i.e.: Doesn't move.
Deck.CountExpression
An object that parses expression strings from the config window
Deck.LoadDeckCommand
Command to set the contents of this deck from a saved file.
DeckGlobalKeyCommand
This version of MassKeyCommand is added to a DrawPile (which holds a Deck) and applies to pieces/cards currently in the deck.
DeckGlobalKeyCommand.DeckGlobalCommand  
DeckGlobalKeyCommand.DeckPolicyConfig2  
DeckVisitor
For Visitors that are aware of Deck types
DeckVisitorDispatcher
For handling Visitors that are aware of Deck types
Decorator
The abstract class describing a generic 'Trait' of a full GamePiece.
DefaultEventListenerSupport<T>
A class to provide support for EventListeners.
DefaultMultiEventListenerSupport
A class to provide support for EventListeners.
DefaultPieceCollection
Maps now start with a Game Piece Layers component (i.e.
Delete
This trait adds a command that creates a duplicate of the selected Gamepiece
Delete.Ed  
DeobfuscatingInputStream
A FilterInputStream which converts a file created with ObfuscatingOutputStream back into plain text.
Deselect
Implements a trait to allow a piece to be deselected from the KeyBuffer in response to a Key Command.
Deselect.Ed  
DetailsButton  
DetailsDialog  
DialogHelpWindow
A Dialog that displays HTML content, with navigation
Dialogs
Provides some basic kinds of dialogs.
DialogUtils  
DiceButton
This component places a button into the controls window toolbar.
DiceButton.IconConfig Deprecated, for removal: This API element is subject to removal in a future version.
DiceButton.ReportFormatConfig  
DieManager  
DieRoll  
DieServer
Base DieServer Class Does most of the work.
DirectoryConfigurer
A Configurer for picking file directories
DirectoryFileFilter
A FileFilter which accepts directories only.
DirectPeerPool
Date: Mar 12, 2003
DoActionButton
This component places a button into the controls window toolbar.
DoActionButton.HotkeyConfig  
DoActionButton.IconConfig Deprecated, for removal: This API element is subject to removal in a future version.
DoActionButton.LoopConfig  
DoActionButton.LoopCountConfig  
DoActionButton.LoopTypeConfig  
DoActionButton.NamedHotkeyListConfigurer Deprecated, for removal: This API element is subject to removal in a future version.
not replaced
DoActionButton.ReportFormatConfig  
DoActionButton.SoundConfig  
Documentation
Represents the Help menu of the controls window
DotPrinter<T>
Prints dots to a stream in response to events.
DoubleConfigurer
A Configurer for Double values
DoublePreference
A Decimal Number Module Preference.
DragBuffer  
Drawable
A component may implement the Drawable interface if it has graphical information the should be drawn whenever the Map is drawn.
DrawPile  
DrawPile.AssignedDeckPrompt
generates a prompt with the names of all decks already defined
DrawPile.FormattedStringConfig  
DrawPile.PiecePropertyConfig  
DrawPile.Prompt  
DummyClient
Empty server
DummyConfig  
DummyEventListener<T>
An EventListener which does nothing.
DummyMessageServer  
DynamicClient
Refreshes every time the user attempts to connect
DynamicKeyCommandConfigurer  
DynamicKeyCommandListConfigurer  
DynamicProperty
Trait that contains a property accessible via getProperty() and updatable dynamically via key commands
DynamicProperty.DynamicKeyCommand
DynamicKeyCommand A class that represents an action to be performed on a Dynamic property
DynamicProperty.DynamicKeyCommandConfigurer Deprecated, for removal: This API element is subject to removal in a future version.
DynamicProperty.Ed  
EchoClient  
EditablePiece
If class implementing GamePiece also implements the EditablePiece interface, then it can be manipulated from the Editor's Configuration Tree via the PieceDefiner dialog.
EditContainedPiecesAction
Action to edit all GamePiece's within a given component
EditExtensionAction
Loads an exiting module extension and opens it in an extension edit window
EditModuleAction  
Editor  
Editor.ImportLaunchAction  
Editor.LaunchAction  
Editor.ListLaunchAction  
Editor.NewModuleLaunchAction  
Editor.PromptImportLaunchAction  
Editor.PromptLaunchAction  
EditorWindow
EditorWindow is the base class for the three top-level component editors :- ModuleEditorWindow, ExtensionEditorWindow, PluginEditorWindow
EditPropertiesAction
Action to edit the Properties of a component
EDT
A cover for the ExecutorService which submits to the Event Dispatch Thread.
EDTExecutorService
An ExecutorService which submits to Event Dispatch Thread.
EDTRunnableFuture<V>
A {link RunnableFuture} for use on the Event Dispatch Thread.
Embellishment
The "Layer" trait.
Embellishment.Ed
Return Property names exposed by this trait
Embellishment0
Embellishment has been extensively re-written for Vassal 3.2 changing both the behavior and the visual look of the configurer.
EnumeratedIterator<T> Deprecated.
use Iterator, Iterable, Collection or Stream API instead.
EnumeratedPropertyPrompt
Prompts user to select from a list
EnumPreference
A Drop-down list preference.
ErrorDialog  
EventAccumulator<T>
An EventListener which accumulates the events it receives into a List.
EventFilter
Gives information about what kinds of events a GamePiece will respond to
EventListener<T>
An interface for handling events.
EventListenerSupport<T>
An interface to provide support for EventListeners.
EventLog  
EventLog.Event  
EventLog.StoreEvents  
ExceptionHandler
Handles uncaught exceptions.
Exec  
Expression
An abstract class representing an expression that can be evaluated.
ExpressionBuilder
Interactively build inline(beanshell) expressions
ExpressionException  
ExpressionInterpreter
A BeanShell Interpreter customised to evaluate a single Vassal expression containing Vassal property references.
ExtensionEditorWindow  
ExtensionElement
An element of a ModuleExtension that extends an individual Buildable component of the GameModule.
ExtensionFileFilter
A generic by-extension FileFilter.
ExtensionMetaData  
ExtensionsLoader  
ExtensionsLoader.LoadExtensionException  
ExtensionsManager
Convenience class for managing extensions relative to a module file.
ExtensionTree
The configuration tree for editing a module extension
FallbackImageTypeConverter
Convert a BufferedImage to a different type, falling back to conversion on disk if conversion in memory fails.
FastByteArrayOutputStream
A ByteArrayOutputStream which does not retain its byte buffer, and can produce an InputStream sharing the same byte buffer.
FileArchive  
FileArchiveImageTiler
Tiles images contained in a ZIP archive.
FileChooser
FileChooser provides a wrapper for JFileChooser and FileDialog, selecting whichever is preferred on the user's OS.
FileConfigurer
A Configurer for java.io.File values
FileFilter
The file filter abstract base class for {link VASSAL.tools.FileChooser}.
FileFormatException
File cannot be interpreted.
FileImageTypeConverter
Convert a BufferedImage to a different type by caching image data on disk.
FileStore
An interface for providing read access to files.
FileUtils
Custom Implementation of FileUtils.byteCountToDisplaySize to fix rounding bug
FirstTimeDialog
A dialog for first-time users.
Flare
Allows a player to ping a location ("send up a flare") by clicking on a map with the correct modifier key combination held down (default: Alt+LeftClick).
Flare.FlareKeyConfig
A configurer for different combinations of modifier key
Flare.ReportFormatConfig
A configurer for our reportFormat, which includes the unique $FlareLocation$, $FlareZone$, $FlareMap$ properties as well as $PlayerName$ and $PlayerSide$ in the "Insert" pulldown.
FlareCommand
A Command for sending Flare actions to other clients
FlareFormattedStringConfigurer
Utility subclass of FormattedStringConfigurer which includes variable keys for player name, side, and id
FlowLabel
A label which word-wraps and fully justifies its text, and which reflows the text when resized.
FontConfigurer
A Configurer for Fontvalues
FontConfigurer
A Configurer for Font values
FontManager
Container for definitions of Generic Color Definitions
FontStyle
Class that implements a names Font Swatch
FontStyle.FontStyleConfig  
FontStyleConfigurer  
Footprint
Displays a movement trail indicating where a piece has been moved
Footprint.Ed
Key Command Global Visibility Circle Radius Fill Color Line Color Selected Transparency Unselected Transparency Edge Buffer Display Limit Edge Buffer Point Limit
FormattedExpressionConfigurer
A standard Formatted String configurer that has an additional Calculator icon that: a) Indicates to the user that $name$ variables can be used in this field b) Clicking on it opens up an Expression Builder that allows entry of in-line Calculated Properties (Not implemented yet)
FormattedExpressionConfigurer.ExpressionButton
A small 'Calculator' button added after the text to indicate this Configurer accepts Expressions.
FormattedString
FormattedString.java A String that can include options of the form $optionName$.
FormattedStringArrayConfigurer  
FormattedStringConfigurer  
FormattedStringExpression
Report Format or old-style Formatted String expression containing at least one $variable$ name reference
ForwardToChatter
This KeyListener forwards key event from a Map to the Chatter The event is forwarded only if not consumed
ForwardToKeyBuffer
This KeyListener forwards key event from a Map to the KeyBuffer, where it is given to selected GamePieces to interpret.
FreeRotator
A Decorator that rotates a GamePiece to an arbitrary angle
FunctionBuilder  
FutureUtils  
FutureUtils Deprecated.
Moved to VASSAL.tools.concurrent package.
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.
GameModule
The GameModule class is the base class for a VASSAL module.
GameModule.GameFileMode
Last type of game save/load for our current game
GameModuleAction
Utility base class for GameModule-related actions, with auxiliary actions and error reporting.
GamePiece
Interface to deal with the behaviors of a physical component of the game, or a Trait of one.
GamePiece
BeanShell proxy for the Vassal GamePiece object BeanShell proxies control access to Vassal components and expose a consistent API to BeanShell Scripts.
GamePieceFormattedStringConfigurer
Convenience class that provides prompts for the properties found in a BasicPiece
GamePieceImage  
GamePieceImage.BgColorSwatchConfig  
GamePieceImage.BorderColorSwatchConfig  
GamePieceImage.DefnConfig  
GamePieceImageDefinitions
Container for definitions of Generic Counter Definitions.
GamePieceLayout  
GamePieceLayout.BorderConfig  
GamePieceLayout.LayoutConfig  
GamePieceLayoutsContainer
Container for definitions of Generic Counter Definitions.
GamePieceOp
An ImageOp which has a GamePiece as its source.
GamePieceOpImpl
An ImageOp which uses a GamePiece as its source.
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.
GameSetupStep
Represents a step during the initialization of a game in which the player must specify some information See #addGameSetupStep(SetupStep)
GameState
The GameState contains methods to track and read/write the complete enumerated game state of the game currently being played.
GameState.SetupCommand  
GeneralFilter
GeneralFilter is a pluggable image resampler.
GeneralFilter.BellFilter Deprecated.
class is not used anywhere and will be removed
GeneralFilter.BoxFilter Deprecated.
class is not used anywhere and will be removed
GeneralFilter.BSplineFilter Deprecated.
class is not used anywhere and will be removed
GeneralFilter.Filter
The abstract base class for filters.
GeneralFilter.HermiteFilter Deprecated.
class is not used anywhere and will be removed
GeneralFilter.Lanczos3Filter
A Lanczos filter with radius 3.
GeneralFilter.MitchellFilter
A Mitchell filter.
GeneralFilter.TriangleFilter Deprecated.
class is not used anywhere and will be removed
GeneralScript  
GeometricGrid
A Map grid that consists of a regular tiling of shapes
GitProperties
Reads Properties generated by Git-Commit-Id-Plugin
GlobalCommand
The heart of all the different forms of Global Key Command, GlobalCommand handles sending a key command to multiple pieces, potentially on multiple maps, as long as they match its filtering condition.
GlobalCommandTarget
GlobalCommandTarget configures and stores the "Fast Match" parameters of Global Key Commands, allowing certain simple filters to be "pre-matched" without having to initiate the (relatively slower) BeanShell filters.
GlobalCommandTarget.CompareMode
Comparison Modes for property match
GlobalCommandTarget.GKCtype
Specifies the type of GKC being configured (affects which Target options are allowed)
GlobalCommandTarget.Target
Specifies the kind of target matching
GlobalCommandTargetConfigurer  
GlobalHotKey
Adds a menu entry that fires a specified key event to the module window.
GlobalHotKey.Ed  
GlobalKeyCommand
This version of MassKeyCommand is added directly to a GameModule and applies to all maps.
GlobalMap
This is scaled version of a Map that gives an overview.
GlobalMap.IconConfig  
GlobalOptions
GlobalOptions is a junction point for several flavors of "preferences"-related categories.
GlobalOptions.PlayerIdFormatConfig
Configurer for the Player's ID
GlobalOptions.Prompt
The 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 behavior
GlobalOptions.PromptOnOff
The PromptOnOff class allows certain attribute settings to be configured by the module designer: ALWAYS = the "preference" is forced on NEVER = the "preference" is forced off
GlobalPrefs
A set of global preferences shared by all modules.
GlobalProperties
Dummy component that acts as a simple container for GlobalProperty components
GlobalPropertiesContainer
A component that can contain global properties
GlobalProperty
Adds a global property to a Map or Module
GlobalProperty.SetGlobalProperty
Command to pass a new Global property value to other players or into the logfile.
GlobalTranslatableMessage
Adds a global property to a Map or Module
GlobalTranslatableMessages
Dummy component that acts as a simple container for GlobalProperty components
GpIdChecker
Build a cross-reference of all GpId-able elements in a module or ModuleExtension, Check for missing, duplicate or illegal GamePieceId's Update if necessary
GpIdSupport
GameModule and ModuleExtension are the top-level components and must provide some Namespace services for generated GamePiece Identifiers.
GridContainer
A Component that can contain a MapGrid
GridEditor  
GridEditor.EditableGrid  
GridNumbering
Provides methods for assigning names to locations on a MapGrid, and drawing those locations when drawing a grid
GridOp  
HandMetrics
Handles the drawing of cards in a PlayerHand.
HashCode Deprecated.
Use HashCodeBuilder instead.
HeapFinderDummy  
HelpFile
Places an entry in the Help menu.
HelpWindow
A Window that displays HTML content, with navigation
HelpWindowExtension Deprecated.
To be replaced
HexGrid
A Hexgrid is a map grid composed of hexes.
HexGrid.HexGridEditor  
HexGridNumbering  
Hideable  
Hideable.Ed  
HidePiecesButton
This removes all game pieces from the (@link Map) therefore providing an un-cluttered view.
HidePiecesButton.HiddenIconConfig  
HidePiecesButton.ShowingIconConfig  
Highlighter
An interface that defines how to draw GamePieces that are selected
HighlightLastMoved  
HintTextField
A class extending a JTextField that can display a 'ghost' text prompt in the field when it is empty.
HotKeyConfigurer
A Configurer for KeyStroke values
HotkeySpecifier
Text component for specifying a hot key
HtmlChart
An HtmlChart is used for displaying html information for the module.
HtmlChart.XTMLEditorKit Deprecated, for removal: This API element is subject to removal in a future version.
HtmlChart.XTMLEditorKit.XTMLFactory  
HtmlChart.XTMLEditorKit.XTMLFactory.ImageComponentView  
HTMLImageFinder
Parses image tags out of an HTML file or string.
HTMLWindowHelper  
HttpMessageServer  
HTTPPostBuilder
Builds HTTP POST requests conveniently.
HttpRequestWrapper
Performs Get and Post operations to a given URL
HybridClient
Delegates calls to another SvrConnection instance, which can be changed programmatically
I18nResourcePathFinder  
IconButton  
IconConfigurer  
IconFactory
Manage and Provide Icons in standard sizes.
IconFamily
An IconFamily is a named set of Icons in the four standard Tango sizes.
IllegalBuildException
An Exception indicating that an illegal operation was performed when building a Buildable component.
ImageConfigurer
A Configurer for Image values.
ImageFileFilter
A FileFilter for GIF, JPEG, PNG, and SVG images.
ImageIOException
An exception indicating some I/O problem while reading an image file.
ImageIOImageLoader
An image loader which wraps ImageIO.
ImageIOImageLoader.Wrapper<T>  
ImageItem  
ImageItem.BaseOp  
ImageItem.TextSource  
ImageItemInstance  
ImageLoader
An interface for loading images.
ImageNotFoundException
An exception indicating that an image file was not found.
ImageOp
An abstract representation of an operation which may be applied to an {link Image}.
ImageOpObserver
ImageOpObservers can be notified on the completion of an ImageOp.
ImagePicker  
ImageSaver
This allows the user to capture a snapshot of the entire map into a PNG file.
ImageSaver.IconConfig Deprecated, for removal: This API element is subject to removal in a future version.
ImageSearchTarget
An interface for "things that contain images" to ship off convenient packages of filename.
ImageSelector
Allows a user to select from the images currently available in a module, or to open a File Dialog to import a new image.
ImageSourceOpBitmapImpl
An ImageOp which uses a fixed image as its source.
ImageTileDiskCache
An on-disk ImageTileSource and FileStore for image tiles.
ImageTileSource
An interface for classes which supply image tiles.
ImageToTiles
Converts an image file to tile files.
ImageTypeConverter
An interface for converting BufferedImages from one type to another.
ImageUtils  
Immobilized
Decorator that filters events to prevent a GamePiece from being selected and/or moved.
ImportAction
Action for importing foreign modules into VASSAL.
Importer
Abstract parent of all importer classes.
ImportMetaData
Class representing the metadata for an Importable file.
ImprovedAveragingScaleFilter Deprecated, for removal: This API element is subject to removal in a future version.
IncrementProperty
Increments a property by a given value.
IncrementProperty.Constraints  
Info
Class for storing release-related information
InputOutputStreamPump
Pumps an InputStream to an OutputStream.
InputStreamPump
Pumps an InputStream.
InstanceConfigurer
Controls for configuring an individual ItemInstance
IntBuilder  
IntConfigurer
A Configurer for Integer values
IntegerPreference
A whole number Module Preference.
InternetDiceButton
This component places a button into the controls window toolbar.
InternetDiceButton.InternetReportFormatConfig  
IntExpression
An expression consisting of an Integer only
Inventory  
Inventory.FunctionConfig  
Inventory.IconConfig Deprecated, for removal: This API element is subject to removal in a future version.
Inventory.PieceFormatConfig  
Inventory.Selector
Filter to select pieces required
Inventory.SortConfig  
InviteAction
When invoked, will Kick another player out of his current room back to the Main Room.
InviteCommand
A Command that, when executed, sends game synchronization information to a given SimplePlayer
InviteEncoder
Date: Mar 16, 2003
IOUtils Deprecated, for removal: This API element is subject to removal in a future version.
Use IOUtils instead.
IpWatch  
Item
The base portion of a Counter Layout component.
Item.IconConfig  
Item.LocationConfig  
ItemInstance
Individual override parameters for an instance of an Item.
IteratorUtils  
JarArchive  
JavaNameConfigurer
A Configurer for a String that enforces the string to be a valid Java name
JoinRoomAction
When invoked, will join a game room on the server
KeyBuffer
The KeyBuffer is the list of "currently selected pieces" in the VASSAL UI (map windows).
KeyBufferer
Selects and unselects pieces on the map, using the mouse.
KeyCommand  
KeyCommandSubMenu
Represents a sub-menu in a GamePiece's right-click drop-down menu
KeyModifiersConfigurer
Configurer for specifying key masks (CTRL, SHIFT, CTRL-ALT, etc.)
KeyNamer
Translates key codes into human-readable strings (e.g.
KeySpecifier  
KeyStrokeArrayConfigurer
Configures an array of keystrokes
KeyStrokeListener
Utility class for associating an Action with a keystroke from multiple different component sources
KeyStrokeSource
Utility class for registering a component as a source of hotkey events
KickAction
When invoked, will Kick another player out of his current room back to the Main Room.
Labeler
Displays a text label, with content specified by the user at runtime.
Labeler.HTMLLabelOp  
Labeler.LabelOp  
LabelUtils  
Language
Container for definitions of Translations.
LaunchButton
A JButton for placing into a VASSAL component's toolbar.
Launcher  
LaunchRequest
Encapsulates and parses command-line arguments.
LaunchRequestException
The Exception thrown by LaunchRequest when command line arguments cannot be parsed.
LaunchRequestHandler  
LaunchTourAction  
LayerControl
Adds a button to the toolbar to manipulate Game Piece Layers
LayerControl.CommandConfig  
LayeredPieceCollection
The optional "Game Piece Layers" component of a Map which allows pieces on the map to be assigned to an arbitrary number of visual layers according to a property setting.
LayeredPieceCollection.Collection
The PieceCollection class used by the Map to which a LayeredPieceCollection has been added.
LayoutConfigurer  
LayoutConfigurer.NewIntConfigurer  
ListConfigurer
Configures a variable-length list of objects
ListTurnLevel  
ListWidget
A Widget that corresponds to a panel with a JList sitting to the right of a JPanel with a CardLayout layout.
LoadModuleAction
Loads a module in play mode
LocaleConfigurer
Configure a Locale Value using full, localized Language and Country names
Localization
Singleton class for managing the translation of a module into other languages
LockableChatServerConnection  
LockableNodeRoomControls  
LockableRoom
A room that may be locked
LockableRoomControls  
LockableRoomTreeRenderer
Renders rooms with a "locked" icon if locked Change Owners name to display Red
LockWatcher
Watches for thread lock on a server.
LogAndSaveFileFilter
A FileFilter for VASSAL logs and saved games.
LogEntry Deprecated.
LogFileFilter
A FileFilter for VASSAL logs.
LoggedOutputStream
An OutputStream which feeds an Logger.
Logger  
Logger Deprecated.
Use Logger instead.
LogListener Deprecated.
LogPane  
LongConfigurer
A Configurer for Long values
LoopControl
Code for controlling looping common to both TriggerAction and DoActionButton
LOS_Thread
A class that allows the user to draw a straight line on a Map (LOS = Line Of Sight).
LOS_Thread.GlobalOptions  
LOS_Thread.IconConfig Deprecated, for removal: This API element is subject to removal in a future version.
LOS_Thread.LOSCommand  
LOS_Thread.PersistenceOptions  
LOS_Thread.ReportFormatConfig  
LOS_Thread.RoundingOptions  
MacOSXMenuManager  
MacOSXStartUp  
MainRoomChecker  
MainRoomFilter
Only passes commands that are allowed in the Main Room
MandatoryComponent
Requires that at least one child of a given type exist within a target component
Map
The Map is the main component for displaying and containing GamePieces during play.
Map
BeanShell proxy for the Vassal Map object BeanShell proxies control access to Vassal components and expose a consistent API to BeanShell Scripts.
Map.ChangeFormatConfig
Report format configurer for "modified on map"
Map.CreateFormatConfig
Report format configurer for "created on map"
Map.IconConfig
Autoconfigurer for map's icon used on its launch button
Map.InsetLayout
The Layout responsible for arranging insets which overlay the Map InsetLayout currently is responsible for keeping the GlobalMap in the upper-left corner of the Map.View.
Map.Merger
Implements default logic for merging pieces (into a Stack or Deck} at a given location within a map Returns a Command that merges the input GamePiece with an existing piece at the input position, provided the pieces are stackable, visible, in the same layer, etc.
Map.MoveToFormatConfig
Report format configurer for "moved to map"
Map.MoveWithinFormatConfig
Report format configurer for "moved within map"
Map.UnmovedIconConfig
Autoconfigurer for mark-unmoved icon
Map.View
The (JPanel-extending) component that represents the map itself
MapBoard
The map board itself.
MapBoard.LineDefinition
Line styles for hex sides and hex lines.
MapBoard.LineStyle
line patter such as dashed or dotted or solid
MapBoard.PlaceNameOrientation  
MapBoardFileFilter
A FileFilter for ADC2 map boards.
MapCenterer
Centers the map when user right-clicks on an empty hex
MapGrid
A MapGrid overlays a map board to constrain the legal locations of GamePieces
MapGrid.BadCoords  
MapShader
Draw shaded regions on a map.
MapShader.BoardPrompt  
MapShader.IconConfig Deprecated, for removal: This API element is subject to removal in a future version.
MapShader.PatternPrompt  
MapShader.ShadedPiece
Pieces that contribute to shading must implement this interface
MapShader.TypePrompt  
MapWidget  
MapWidget.TabSwitcher  
Marker
A generic Decorator that retains in its state the value of a property.
MassKeyCommand
Adds a button to a map window toolbar.
MassKeyCommand.DeckPolicyConfig  
MassKeyCommand.IconConfig Deprecated, for removal: This API element is subject to removal in a future version.
MassKeyCommand.Prompt  
MassKeyCommand.ReportFormatConfig  
MassPieceDefiner
Edits an entire set of GamePieces at once
MassPieceLoader
Class to load a directory full of images and create counters
MemoryImageTypeConverter
Convert a BufferedImage to a different type, in memory.
MemoryUtils
A utility class for getting information about system memory.
MenuBarProxy  
MenuDisplayer  
MenuItemProxy  
MenuManager  
MenuMarker  
MenuProxy  
MenuScroller
A class that provides scrolling capabilities to a long menu dropdown or popup menu.
MenuSeparator
This trait adds a command that creates a duplicate of the selected Gamepiece
MenuSeparator.Ed  
Message
A message in a message board
MessageBoard
Simple abstraction of a message board Date: Mar 11, 2003
MessageBoardControls
UI controls for posting and retrieving messages from a message board.
MessageBoardControlsInitializer
Adds controls to post/retrieve message from a message board
MessageServer  
MessageViewer  
MetaDataFactory  
ModuleEditorWindow  
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
ModuleExtensionFileFilter
A FileFilter for VASSAL module extensions.
ModuleFileFilter
A FileFilter for VASSAL modules.
ModuleManager
Tracks recently-used modules and builds the main GUI window for interacting with modules.
ModuleManagerMacOSXStartUp  
ModuleManagerMenuManager  
ModuleManagerSocketListener  
ModuleManagerUpdateHelper  
ModuleManagerWindow  
ModuleMetaData
Class representing the metadata for a Module or an Extension.
ModulePlugin
A ModulePlugin is basically identical to a ModuleExtension except that is loaded earlier and must throw Plugin specific error messages
ModulePlugin.RegCmd  
ModuleUpdaterDialog Deprecated, for removal: This API element is subject to removal in a future version.
MovementMarkable
A GamePiece with this trait will automatically be marked whenever it is moved.
MovementReporter
Builds an auto-report message for a collection of Move Commands
MovementReporter.HiddenMovementReporter
A version of the MovementReporter for reporting the movement of Invisible pieces.
MovementReporter.HiddenMoveSummary  
MovementReporter.MoveSummary  
MovePiece
Command that moves a piece to a new location and position within a stack.
MoveTracker
Convenience class for building MovePiece commands.
Mp3AudioClip  
MsgSender
Generic interface for sending messages
MultiActionButton
Combines multiple buttons from the toolbar into a single button.
MultiEventListenerSupport
An interface to provide support for EventListeners.
MultiImagePicker  
MultiResolutionRenderedImage  
MultiResolutionRenderedImage.Renderer  
MultiRoll  
MultiRoll.HeaderRow  
MultiRoll.StateButton  
MutablePropertiesContainer
A component that can contain mutable (updatable) properties
MutablePropertiesContainer.Impl
Simple implementation of MutablePropertiesContainer
MutableProperty
A container for a String property that can be updated
MutableProperty.Impl
Simple implementation of MutableProperty Support dynamic changing of the property name, provided that the MutableProperty.Impl.addTo(MutablePropertiesContainer) method is used to register this property with a properties container.
MutableProperty.Util  
NamedHotKeyConfigurer
A configurer for Configuring Key Strokes.
NamedKeyManager  
NamedKeyStroke
A NamedKeyStroke is a KeyStroke with a name given by the module developer.
NamedKeyStrokeArrayConfigurer
Configures an array of {link NamedKeyStrokes}
NamedKeyStrokeListener
Extension of KeyStrokeListener to support NamedKeyStroke's and store the supplied NamedKeyStroke.
NewColorConfigurer
Configurer for Color values
NewExtensionAction
Creates a new module extension and opens an extension edit window
NewGameIndicator
Provides information about whether a game was started from File->New Game or loaded from a saved game
NewGameIndicator.MarkGameNotNew  
Node
Base class for the hierarchical server model.
NodeClient  
NodeClientFactory  
NodePlayer
A SimplePlayer subclass used in clients of the hierarchical server
NodeRoom
Subclass of SimpleRoom for use on the client side of a hierarchical server
NoInsetButton
A button with no insets to be as small as possible
NonRectangular
A trait for assigning an arbitrary shape to a GamePiece
NotesWindow
This is a GameComponent that allows players to type and save text notes during a game.
NotesWindow.IconConfig Deprecated, for removal: This API element is subject to removal in a future version.
NullCommand  
NullExpression
An Empty Expression
NumericPropertyPrompt
Prompts for an integer value
ObfuscatingOutputStream
A FilterOutputStream which handles simple obfuscation of a file's contents, to prevent the casual cheat of hand-editing.
Obscurable  
ObscurableOptions
Determines whether players are allowed to unmask other players pieces.
ObscurableOptions.SetAllowed  
OfficialNodeClient  
OfficialNodeClientFactory  
Op  
Op<V>
An operation with a cacheable result.
OpCache
A memory-sensitive cache for Ops and their results.
OpCache.Key<V>
A cache key for OpCache.
OpFailedException  
OpIcon
An implementation of Icon using an ImageOp as a source.
OpMultiResolutionImage  
OpObserver<V>
An OpObserver is notified when its Op completes..
OrthoRotateOpBitmapImpl  
OutlineFont  
OutputStreamPump
Pumps an OutputStream.
OwningOpMultiResolutionImage  
P2PClient  
P2PClientFactory  
P2PPlayer  
Pair<A,​B>
An immutable class for pairs of objects.
PanelWidget
A Widget that corresponds to a JPanel with a GridLayout or BoxLayout layout.
ParentProxy  
PasswordConfigurer  
PeerPool
Date: Mar 11, 2003
PeerPoolInfo
Date: Mar 12, 2003
PersistentPropertyContainer
A container holding properties that must be maintained as part of the Game State (saved with saved games, passed to other clients via logfile/server, etc).
PieceAccess
Defines ability of a player to access a GamePiece
PieceAccess.GlobalAccess
Global utility class to temporarily restrict access to all piece
PieceAccessConfigurer  
PieceCloner
Utility class for cloning GamePieces
PieceCollection
A PieceCollection generally holds a list of GamePieces on a Map.
PieceDefiner
This is the GamePiece designer dialog.
PieceDefiner.Ed
A Dialog for editing an EditablePiece's properties
PieceEditor  
PieceFilter
A filter for GamePieces Sample implementations include: PropertyExpression - used for "matching expressions" in Global Key Commands and the like RangeFilter - filters for pieces within range of a point BooleanOrPieceFilter - "OR"s two Filters together to make one Amazing Disjunctive Filter BooleanAndPieceFilter - "AND"s two Filters together and you'd better satisfy both CounterDetailViewer.Filter - Filter created from Mouseover Stack Viewer settings Inventory.Selector - Layered filter for Piece Inventory window
PieceFinder
This interface defines selection criteria for finding a GamePiece in a Map
PieceFinder.DeckOrPieceInStack  
PieceFinder.Movable  
PieceFinder.PieceInStack  
PieceFinder.StackOnly  
PieceI18nData
Object encapsulating the internationalization information for a GamePiece.
PieceI18nData.Property  
PieceImage Deprecated.
Use GamePieceOp instead.
PieceIterator
An iterator for GamePieces.
PieceMover
PieceMover handles the "Drag and Drop" of pieces and stacks, onto or within a Map window.
PieceMover.AbstractDragHandler
Common functionality for DragHandler for cases with and without drag image support.
PieceMover.DragHandler
VASSAL's front-line drag handler for drag-and-drop of pieces.
PieceMover.DragHandlerMacOSX
Special MacOSX variant of DragHandler, because of differences in how device scaling is handled.
PieceMover.DragHandlerNoImage
Fallback drag-handler when DragImage not supported by JRE.
PieceRecenterer
Adds a button to a Maps toolbar that adjusts the positions of all pieces so that their centroid is at the center of the map
PieceRecenterer.IconConfig Deprecated, for removal: This API element is subject to removal in a future version.
PieceSlot
A Component that displays a GamePiece.
PieceSorter
Sorts GamePieces according to their position: If on different Maps, order by Map id If in different Stacks order by Stack position on the Map If in the same Stack, order by position within the Stack
PieceVisitor
For implementing a somewhat modified Visitor pattern for GamePieces.
PieceVisitorDispatcher
For implementing a modified Visitor pattern on GamePieces.
PieceWindow
A window from which players can create new GamePieces by clicking and dragging from the PieceWindow.
PieceWindow.IconConfig  
Pivot
Provides commands to pivot a Game Piece around a given point
Pivot.Ed  
PlaceMarker
This Decorator defines a key command to places another counter on top of this one.
PlaceMarker.Ed  
PlaceMarker.Ed.ChoosePieceDialog  
PlayAudioClipCommand  
Player
Represents an occupant of a chat room, i.e.
Player  
Player.LaunchAction  
Player.PromptLaunchAction  
PlayerAccess
Access is granted if GameModule.getUserId() matches
PlayerActionFactory  
PlayerEncoder
Date: Mar 16, 2003
PlayerHand  
PlayerIdFormattedString Deprecated.
use FormattedString constructor with defaultProperties
PlayerIdFormattedStringConfigurer
Utility subclass of FormattedStringConfigurer which includes variable keys for player name, side, and id
PlayerInfoWindow
A window that displays information on a SimplePlayer
PlayerNode
Node representing a single player.
PlayerRoster
Maintains a list of players involved in the current game
PlayerRoster.Add  
PlayerRoster.PlayerInfo  
PlayerRoster.SideChangeListener
Call-back interface for when a player changes sides during a game
PlayerStatus
Represents the current status of a player on the server.
PlayerWindow  
PlaySound
A trait that plays a sound clip
PlaySound.Ed  
Plugin
Plugin is a general purpose component for use by Module Plugins that require some sort of initialisation.
PluginsLoader
Load Plugins.
PluginsLoader.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.
PNGFileFilter
A FileFilter for PNG images.
PolygonEditor  
PositionOption  
PredefinedSetup
Defines a saved game that is accessible from the File menu.
Prefs
A set of preferences.
PrefsEditor  
Prioritizable  
PrivateChatEncoder
Date: Mar 16, 2003
PrivateChatManager
Manages PrivateChatter instances
PrivateChatter
A window for private messages between the user and another player;
PrivateMap
A Map that may be configured to be visible only a particular side.
PrivateMap.View  
PrivateMessageAction
When invoked, will open a private message window to another player
PrivateNodeClient  
PrivateNodeClientFactory  
PrivateNotesController
Holds PrivateText objects, only displaying the one owned by the current user
PrivateText
A text message with an owner
PrivMsgCommand
A Command that encapsulates a private chat message from another SimplePlayer
ProblemDialog  
ProcessIDConverter  
ProcessLauncher  
ProcessWrapper
A wrapper for returning processes from a ProcessLauncher.
ProgressDialog
A cancellable progress dialog.
Progressor
A progress handler.
Properties
Defines the properties expected to be defined in each GamePiece
PropertiesEncoder
Encodes a set of properties into a String, without using an '\n' character.
PropertiesPieceFilter
Accepts pieces based on whether the piece has properties that match a given set of conditions
PropertiesWindow
Window for editing properties of a Configurable object
Property<T>
Represents a named property with a specified type.
PropertyChanger
Provides a new value for a global property.
PropertyChangerConfigurer
Configurer instance that allows a module editor to specify a PropertyChanger, i.e.
PropertyChangerConfigurer.Constraints  
PropertyContainer
Provides an interface for getting and setting Propertys and listening for changes to them.
PropertyExporter
Interface for classes that can exporty the names and values of the properties they maintain
PropertyExpression  
PropertyExpressionBuilder  
PropertyExpressionConfigurer
A Configurer for Java Expressions
PropertyExpressionConfigurer.PropertyExpressionButton  
PropertyListener<T>
The listener interface for receiving Property change events.
PropertyMatchExpression
An old-style Property Match expression.
PropertyNameExpressionBuilder
A Builder for a field that can contain a property Name or a beanshell expression.
PropertyNameExpressionConfigurer
A Configurer for Java Expressions
PropertyNameExpressionConfigurer.PropertyNameExpressionButton  
PropertyNameSource  
PropertyProducer
A component that exposes properties
PropertyPrompt
Prompts user for a new value
PropertyPrompt.Constraints  
PropertyPrompt.DialogParent  
PropertySetter
Provides a fixed value The value can be specified as a FormattedString property and evaluated at runtime
PropertySheet
A Decorator class that endows a GamePiece with a dialog.
PropertySource
A PropertySource provides an interface to read properties (values), usually game- or UI-related, from various game objects.
PropertySupport
An interface for handling PropertyListeners.
Protocol
Utility method for encoding server-related commands into strings.
PrototypeDefinition  
PrototypeDefinition.Config  
PrototypeDefinition.Config.Definer  
PrototypesContainer
Container for definitions of Game Piece prototypes.
QueueJoiner
A Callable which calls a Callable retrieved from a queue.
QuickColors
Allows certain special characters at the beginning of a string to control a color styling, as an easier shortcut than putting style="color:#00ffff;" tags in every message.
RandomTextButton  
RangedRunnable<T>
A Runnable which operates on a rolling range.
RangeFilter
Accepts all pieces within a specified range of a given point on a map
ReadErrorDialog
Utility class for reporting an IOException reading from the local system or a resource bundled with the VASSAL engine
ReadOnlyPrefs
A simple preferences class which permits reading stored values.
RecursionLimiter
Utility class to detect and report Infinite Loops within Vassal components
RecursionLimiter.Loopable  
RecursionLimitException  
Reference<T>
Holds a mutable reference.
ReflectionUtils  
RefreshPredefinedSetupsDialog  
Region  
RegionGrid  
RegionGrid.Config  
RegionGrid.Config.EditRegionAction  
RegionGrid.Config.View  
RegularGridNumbering
Abstract base class for grid numbering classes for hexagonal and rectangular grids
RegularGridNumbering.F  
RegularGridNumbering.LocationFormatConfig  
RegularGridNumbering.R  
RegularGridNumbering.T  
RemovePiece
This Command removed a GamePiece from a game.
RemoveUnusedImagesDialog  
Repainter
An ImageOpObserver which repaints Components.
Replace
GamePiece trait that replaces a GamePiece with another one
Replace.Ed  
ReportState
A GamePiece with this trait will echo the piece's current name when any of a given key commands are pressed (and after they take effect)
ReportState.Ed  
RereadableInputStream
An rereadable InputStream.
ResourcePathFinder  
Resources  
RestrictCommands
RestrictCommands Restrict the availability of Key Commands, depending on a Property Match String.
RestrictCommands.Ed  
Restricted
A GamePiece with the Restricted trait can only be manipulated by the player playing a specific side
Restricted.Ed  
ReturnToDeck
GamePiece trait that returns a piece to a DrawPile
RollSet
Describes a set of DieRolls
Room
Represents a game room on the server
RoomActionFactory  
RoomInteractionControlsInitializer
Adds mouse listeners to the RoomTree components: double-click to join a room, etc.
RoomManager  
RoomTracker
Tracks players entering/exiting a room
RoomTree
JTree component displaying chat rooms on the server
RoomTreeRenderer
Cell render component for RoomTree
RotateOp
An ImageOp which rotates its source about its center.
RotateScaleOp
An ImageOp which both rotates and scales its source.
RotateScaleOpBitmapImpl
An ImageOp which rotates and scales its source.
RotateScaleOpSVGImpl
An ImageOp which rotates and scales its source.
SaveAction
General-purpose "Save" action
SaveAsAction
General-purpose "Save As" action
SavedGameUpdater  
SavedGameUpdaterDialog  
SaveMetaData
Class representing the metadata for a Save Game/Log File.
SaveModuleAction  
SaveModuleAsAction  
ScaledImagePainter
Paints an image at arbitrary scale.
ScaleOp
An ImageOp which scales its source.
ScaleOpBitmapImpl
An ImageOp which scales its source.
ScaleOpTiledBitmapImpl
An ImageOp which scales its source and cobbles scaled tiles from the tile cache.
ScriptContainer
Container for Scripts.
ScriptInterpreter  
Scroller
This component listens to key events on a Map window and scrolls the map.
ScrollPane
ScrollPane extends JScrollPane to have complete mouse-wheel functionality.
SearchTarget
An interface for "things the editor might search for with its 'Search' function" to ship off convenient packages of searchable strings in various categories.
SecretNote
Represents a text note with an owner and hidden/revealed status.
SecretNotesController  
SelectionHighlighter  
SelectionHighlighter.IconConfig  
SelectionHighlighters  
SendSoundAction
Send a wake-up sound to another player - Can't wake-up oneself - No wake-ups in the default room - No wake-ups to people in different rooms - No wake-up to the same person in the same room until at least 5 seconds has passed.
SendToLocation
This trait adds a command that sends a piece to another location.
SendToLocation.Ed  
SeparatorProxy  
SequenceEncoder
Encodes a sequence of Strings into a single String with a given delimiter.
SequenceEncoder.Decoder  
Server
The server-side Main class
ServerAddressBook  
ServerConfigurer
Specifies the server implementation in the Preferences
ServerConnection
Represents the connection to a live server
ServerNode  
ServerStatus
Represents the history and current state of connections to the chat room server
ServerStatus.ModuleSummary  
ServerStatusControlsInitializer  
ServerStatusView
Shows the current status of connections to the server
ServerStatusView.Render  
ServerWindowActions
Interface for user interaction with {org.vassalengine.module.ServerWindow}
SetGlobalProperty  
SetGlobalProperty.Ed  
SetPersistentPropertyCommand
This Command sets a Persistent Property in a PersistentPropertyContainer.
SetPrivateTextCommand
When executed, adds a PrivateText to a specified set.
SetPrivateTextCommand.Interface  
SettableFuture<V>
A Future which provides methods for setting its result.
SettableRunnableFuture<V>
SetupStack
This is the "At-Start Stack" component, which initializes a Map or Board with a specified stack.
SetupStack.OwningBoardPrompt  
SetupStack.View  
ShadowDiceDieServer
ShadowDice Dice Server
ShapeItem  
ShapeItem.ShapeConfig  
ShapeItemInstance  
ShapeItemInstance.BorderColorSwatchConfig  
ShapeItemInstance.FgColorSwatchConfig  
ShowHelpAction
Action that displays a HelpWindow
ShowProfileAction
When invoked, will show profile information about another player
ShowServerStatusAction
Description?
ShutDownAction  
SideAccess
Access is granted if PlayerRoster.getMySide() matches
SimpleConfigurer
A Configurer for configuring Configurable components (Is that as redundant as it sounds?) The invoking class must provide an array of Configurers, one for each attribute of the target Configurable object.
SimpleFuture<V>
An uninterruptable SettableFuture.
SimplePieceCollection
A SimplePieceCollection is used within a CompoundPieceCollection to maintain an array of the pieces/stacks/decks (GamePiece) within a single visual layer.
SimplePieceEditor  
SimplePlayer
Simple Player bean
SimpleRoom
A simple Room bean
SimpleRunnableFuture<V>
SimpleStatus
Immutable PlayerStatus class with flags indicating "looking for a game" and "away from keyboard" and a String profile
SimpleStatusControlsInitializer  
SingleChildInstance
Ensures that at most a single instance of a given type belongs to a given parent
SinglePropertyContainer<V>
A PropertyContainer which holds one Property.
SinglePropertyExpression
An expression consisting of a single property name
SizeConfigurer  
SmallList
Bogus extension of list that takes up less space.
SocketHandler  
SocketWatcher
Generic interface for listening to a socket
SolidColorOp  
Sort Deprecated.
Use {link java.util.Collections.sort} instead.
Sort.Alpha Deprecated.
Use the natural ordering on Strings instead.
Sort.Comparator Deprecated.
Use Comparator instead.
SoundConfigurer
Configurer for specifying a Clip.
SoundConfigurer.AudioClipFactory  
SoundEncoder
Encodes commands that play sounds This class is used exclusively by the 'Send wake-up' server feature.
SoundEncoder.Cmd  
SourceOp
An ImageOp which provides a source.
SourceOpBitmapImpl
An ImageOp which loads an image from the DataArchive.
SourceOpDiskCacheBitmapImpl
An ImageOp which loads tiles from the tile cache.
SourceOpSVGImpl
An ImageOp which loads an image from the DataArchive.
SourceOpTiledBitmapImpl
An ImageOp which loads an image from the DataArchive, but produces tiles loaded from the tile cache.
SourceTileOpBitmapImpl
An ImageOp for producing tiles directly from a source, without cobbling tiles from the source.
SourceTileOpSVGImpl
An ImageOp for producing tiles directly from a source, without cobbling tiles from the source.
SpecialDiceButton
...
SpecialDiceButton.IconConfig Deprecated, for removal: This API element is subject to removal in a future version.
SpecialDiceButton.ReportFormatConfig  
SpecialDiceButton.ShowResults
Command for displaying the results of a roll of the dice
SpecialDie  
SpecialDie.ResultFormatConfig  
SpecialDieFace  
SpecialDieFace.IconConfig  
SpecifiedSideAccess
Access is granted if PlayerRoster.getMySide() is in a specified list
SplashScreen
Displays an image centered on the screen
SplitPane  
SquareGrid  
SquareGrid.RangeOptions  
SquareGrid.SquareGridEditor  
SquareGridNumbering  
Stack
A Stack is a collection of pieces in the same location that can often be moved with a single drag-and-drop.
Stack
BeanShell proxy for the Vassal GamePiece object BeanShell proxies control access to Vassal components and expose a consistent API to BeanShell Scripts.
StackExpander  
StackMetrics
StackMetrics provides the [Stacking options] component of a Map.
StandardConfig  
StartUp  
StartupGlobalKeyCommand
A Global Key Command that is automatically invoked on game start-up, once the various Key Listeners have been started.
StateMergeable
GamePieces may implement this interface to implement "merge" functionality of their state.
StatusReporter
Copyright (c) 2003 by Rodney Kinney.
StrBuilder  
StringArrayConfigurer
A Configurer that returns an array of Strings
StringConfigurer
A Configurer for String values
StringEnum
Wrapper class for an enumerated type.
StringEnumConfigurer
A Configurer that returns a String from among a list of possible values
StringEnumConfigurer
A Configurer that returns a String from among a list of possible values
StringExpression
An expression consisting of a String only
StringPreference
A String Module Preference.
SubMenu
A trait that groups menu items of other traits into a sub-menu
SubMenu.Editor  
SumProperties
For property names of the form sum(name), returns the value of the named property summed over a list of pieces.
SVGImageUtils
Utility methods for manipulating SVG images.
SVGOp
An ImageOp which produces images from SVG.
SVGRenderer
Render an SVG image to a BufferedImage.
SwatchComboBox  
SwingUtils  
Symbol  
Symbol.NatoUnitSymbolSet  
Symbol.SizeOption  
SymbolConfigurer  
SymbolItem  
SymbolItem.SetConfig  
SymbolItemInstance  
SymbolItemInstance.BgColorSwatchConfig  
SymbolItemInstance.FgColorSwatchConfig  
SymbolItemInstance.SizeColorSwatchConfig  
SymbolItemInstance.SizeConfig  
SymbolItemInstance.Symbol1Config  
SymbolItemInstance.Symbol2Config  
SymbolSet
ADC2 game piece and terrain symbols.
SymbolSetFileFilter
A FileFilter for ADC2 symbol sets.
SynchAction
When invoked, will request synchronization info from another player - Cannot Synch when in the default room - Cannot Synch with a player in a different room - Cannot Synch with yourself - Cannot Synch with any player in the same room within 15 seconds of your last synch in this room
SynchCommand
A Command that, when executed, sends game synchronization information to a given SimplePlayer
SynchEncoder
Date: Mar 16, 2003
TableConfigurer  
TableConfigurer.Column  
TableInfo
A Decorator class that endows a GamePiece with an editable spreadsheet (i.e.
TabWidget
A Widget that corresponds to a JTabbedPane.
Tailer
Tail a file.
TemporaryFileFactory
A factory for temporary files.
TemporaryToolBar
Stores components in a dummy toolbar, then transfers them to another toolbar component when it becomes available.
TextBoxItem  
TextBoxItemInstance  
TextBoxItemInstance.BgColorSwatchConfig  
TextBoxItemInstance.FgColorSwatchConfig  
TextBoxItemInstance.WrappingTextConfigurer  
TextClient  
TextClient.Encoder  
TextClient.ShowText  
TextConfigurer
A Configurer that allows multi-line string input via a JTextArea
TextItem  
TextItem.FontStyleConfig  
TextItem.NameFormatConfig  
TextItem.TextSource  
TextItemInstance  
TextItemInstance.BgColorSwatchConfig  
TextItemInstance.FgColorSwatchConfig  
TextItemInstance.OutlineColorSwatchConfig  
TextPreference
A multi-line textbox Module Preference.
TextSaver  
TextSaver.IconConfig Deprecated, for removal: This API element is subject to removal in a future version.
ThrowableUtils  
TileNotFoundException
An exception indicating that a tile file was not found.
TileSlicer
Slices an image into tiles.
TileSlicerImpl
Slices an image into tiles.
TileSlicerImpl.TaskMaker  
TilesToImage
Reconstitute an image from tile files.
TileToImage
Converts tile files to image files.
TileUtils
A class for reading and writing image tiles.
TilingHandler
A launcher for the process which tiles large images.
ToggleablePasswordConfigurer  
ToggleablePasswordFieldPanel  
ToolBarComponent
Indicates a component with a toolbar
ToolbarMenu
Takes buttons from the toolbar of a Map or the main module and places them into a popup menu
TraitConfigPanel
A standardised Panel for use by Trait configurers
TraitLayout
A standardised MigLayout for use by Trait configurers
Translatable
Defines VASSAL's standard interface for getting and setting XML (buildFile) attributes, as well as attendant i18n translatable field infrastructure.
TranslatableAttribute
A Class representing an Attribute of a Component that can be translated.
TranslatableConfigurerFactory  
TranslatableMarker  
TranslatableMessage
A trait to expose a translated string as a readable/displayable property.
TranslatablePiece
Decorators that contain localizable elements must implement this interface
TranslatableString
A container for a String property that can be translated
TranslatableString.Impl
Simple implementation of TranslatableString Support dynamic changing of the property name, provided that the TranslatableString.Impl.addTo(TranslatableStringContainer) method is used to register this property with a properties container.
TranslatableString.Util  
TranslatableStringContainer
A component that can contain mutable (updatable) properties
TranslatableStringContainer.Impl
Simple implementation of TranslatableStringContainer
TranslatableStringEnum
Wrapper class for an enumerated type.
Translate
Give a piece a command that moves it a fixed amount in a particular direction, optionally tracking the current rotation of the piece.
Translate.Editor  
Translate.MoveExecuter
Batches up all the movement commands resulting from a single KeyEvent and executes them at once.
TranslateAction
Action to open the Translation Window for a component
TranslateVassalWindow  
TranslateWindow
Window for editing translations of a Configurable object
TranslateWindow.JComponentCellEditor
Custom CellEditor to support CopyButtons in JTable cells
TranslateWindow.JComponentCellRenderer
Custom Cell Renderer to support CopyButtons in JTable cells
TranslateWindow.MyPropertiesWindow  
TranslateWindow.MyTreeNode
Custom Tree Node implementation
TranslatingStringEnumConfigurer
A Configurer that allows a user to select from an underlying list of values, based on a translatable list of descriptions of those values.
Translation  
Translation.LocalePrompt  
TriggerAction
Macro Execute a series of Keystrokes against this same piece - Triggered by own KeyCommand or list of keystrokes - Match against an optional Property Filter
TriggerAction.Ed  
TurnComponent
Generic Turn Component
TurnGlobalHotkey  
TurnGlobalHotkey.ReportFormatConfig  
TurnLevel  
TurnLevel.TurnFormatConfig  
TurnTracker
Generic Turn Counter
TurnTracker.IconConfig  
TurnTracker.LengthStyleConfig  
TurnTracker.ReportFormatConfig  
TurnTracker.SetTurn  
TurnTracker.TurnFormatConfig  
Tutorial
Provides tutorial functionality by reading in a logfile
UniqueIdManager
A class for assigning unique identifiers to objects.
UniqueIdManager.Identifyable
An object with an identifier that can be manipulated by a UniqueIdManager
UnitTest  
UnrecognizedImageTypeException
An exception indicating that an image file is not a recognized type.
UpdateCheckAction  
UpdateCheckRequest  
URLUtils  
UsePrototype
This trait is a placeholder for a pre-defined series of traits specified in a PrototypeDefinition object.
UsePrototype.Editor  
UsernameAndPasswordDialog
A dialog for setting a username and password.
ValidationReport
Summarizes error/warning messages about invalid module configuration
ValidationReportDialog
Dialog for reporting the results of validating a GameModule
ValidationReportDialog.CallBack  
ValidityChecker
Performs validation checks on Buildable objects
VassalResourceBundle
VASSAL PropertyResourceBundle - Expose setParent()
VassalTranslation
Utility class to allow translation of VASSAL using the Component Translation mechanism.
VassalVersionTokenizer Deprecated, for removal: This API element is subject to removal in a future version.
VassalVersionTokenizer.State  
VersionFormatException Deprecated, for removal: This API element is subject to removal in a future version.
VersionTokenizer Deprecated, for removal: This API element is subject to removal in a future version.
VersionUtils  
VisibilityCondition  
VisibilityOption
A Preferences option controlling the visibility of a window
Visualizable  
Visualizer  
WarningDialog  
WelcomeMessageServer
Date: Mar 11, 2003
Widget
A general-purpose configurable GUI container Widgets are Configurable objects that represent AWT components.
Widget.MyCellRenderer  
WidgetMap  
WizardSupport
Provides support for two different wizards.
WizardSupport.BranchingWizard
Branches the wizard by forwarding to the Wizard stored in the wizard settings under a specified key
WizardSupport.GameSetupPanels
Wizard pages for starting a new game.
WizardSupport.LoadSavedGamePanels
Wizard pages for loading a saved game
WizardSupport.PlayOfflinePanels
Wizard pages for starting a new game offline
WizardSupport.SavedGameLoader
Loads a saved game in the background.
WizardSupport.SetupStepPage
Wizard page for an unfinished GameSetupStep
WizardSupport.TutorialLoader  
WrapLayout
FlowLayout subclass that fully supports wrapping of components.
WriteErrorDialog  
ZipArchive  
ZipFileImageTiler
Tiles images contained in a ZIP archive.
ZipFileImageTilerState  
ZipUpdater Deprecated, for removal: This API element is subject to removal in a future version.
removed without replacement
ZipWriter
A class for writing ZIP archives.
Zone  
Zone.Editor  
Zone.LocationFormatConfig  
Zone.ShapeEditor  
ZonedGrid
Map Grid that contains any number of Zones against a background MapGrid
ZonedGridHighlighter  
ZoneHighlight
A Class that defines a method of highlighting the a zone in a multi-zoned grid.
ZoneHighlight.Coverage  
ZoneHighlight.OpacityConfig  
ZoneHighlight.Style  
ZoneProperty  
Zoomer
Controls the zooming in/out of a Map window.
Zoomer.InIconConfig  
Zoomer.LevelConfig  
Zoomer.LevelConfigurer
Zoomer.OutIconConfig  
Zoomer.PickIconConfig  
Zoomer.State
Stores the state information for the Zoomer.