Uses of Interface
VASSAL.build.Buildable
Package
Description
Provides classes for building Java instances automatically from XML
files.
Contains classes that may be added to a
GameModule
.Contains classes that may be added to a
Documentation
.Contains classes that may be added to a
Map
.Contains classes that may be added to a
BoardPicker
.Contains classes that may be added to a
Board
.Contains classes that may be added to a
MapGrid
.Contains classes that can be added to a
Widget
.Contains classes for specifying a VASSAL server implementation that follows a chat-room paradigm.
Provides classes for building "Edit Property" dialogs, and for editing
GameModule
's and ModuleExtension
's.Provides support for specifying and saving preferences.
Contains various utility classes.
-
Uses of Buildable in VASSAL.build
Modifier and TypeInterfaceDescriptioninterface
A class that implements AutoConfigurable can use theAutoConfigurer
class to automatically build a property editor.interface
An object that implements the Configurable interface, in addition to being built from a configuration XML file (because this class ultimately extendsBuildable
, can be manipulated by the user directly in the VASSAL module editor via the Configuration window.Modifier and TypeClassDescriptionclass
Abstract implementation of theBuildable
interface.class
An abstract implementation of theConfigurable
interface.class
Abstract class for a Folder component that can contain/organize a particular type of configurable(s).class
Creates an item that is both configurable w/ an edit boxAbstractConfigurable
and buildable from the XML buildFileAbstractBuildable
, but which also has a Toolbar launch button.class
The GameModule class is the base class for a VASSAL module.class
A general-purpose configurable GUI container Widgets areConfigurable
objects that represent AWT components.Modifier and TypeMethodDescriptionstatic Buildable
static Buildable
Create an instance of a class from an XML element and build it.AbstractBuildable.getAncestor()
AbstractBuildable.getNonFolderAncestor()
Modifier and TypeMethodDescriptionAbstractBuildable.getBuildables()
AbstractBuildable.getBuildComponents()
Deprecated, for removal: This API element is subject to removal in a future version.Modifier and TypeMethodDescriptionvoid
Add a Buildable object to this objectvoid
Set the owning translatable of this componentvoid
Adds a child component.void
void
Default behavior adds the button to the parent componentvoid
Adds this component to its parent.void
Game Module is normally at the root of the hierarchy, so it doesn't expect to get added to anything.void
static void
General building algorithm.static Buildable
Create an instance of a class from an XML element and build it.void
Remove a Buildable object from this objectvoid
Remove a child componentvoid
AbstractFolder.removeFrom
(Buildable parent) void
AbstractToolbarItem.removeFrom
(Buildable parent) Remove from our parentvoid
Configurable.removeFrom
(Buildable parent) Remove this component from its parentvoid
GameModule.removeFrom
(Buildable parent) Since we aren't expecting to beGameModule.addTo(VASSAL.build.Buildable)
'ed to a parent, we likewise don't need to do much about being "removeFrom'ed" one.void
Widget.removeFrom
(Buildable b) void
AbstractBuildable.setAncestor
(Buildable ancestor) void
AbstractBuildable.validate
(Buildable target, ValidationReport report) -
Uses of Buildable in VASSAL.build.module
Modifier and TypeClassDescriptionclass
Although it is theCommandEncoder
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 containsBasicCommandEncoder.createDecorator(java.lang.String, VASSAL.counters.GamePiece)
, theBasicCommandEncoder.DecoratorFactory
for Traits, which are usually internally referred to as Decorators because they are implemented using the Decorator Pattern.class
BasicLogger deals with VLOG Vassal Log files (i.e.class
A top-level Widget for displaying Chartsclass
The chat window component.class
CHESS CLOCK CONTROLLER for VASSAL.class
This is now a dummy classclass
This component places a button into the controls window toolbar.class
class
This component places a button into the controls window toolbar.class
Represents theHelp
menu of the controls windowclass
class
class
This version ofMassKeyCommand
is added directly to aGameModule
and applies to all maps.class
GlobalOptions is a junction point for several flavors of "preferences"-related categories.class
This component places a button into the controls window toolbar.class
class
Translates key codes into human-readable strings (e.g.class
The Map is the main component for displaying and containingGamePiece
s during play.class
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 DataArchiveclass
A ModulePlugin is basically identical to a ModuleExtension except that is loaded earlier and must throw Plugin specific error messagesclass
Combines multiple buttons from the toolbar into a single button.class
This is aGameComponent
that allows players to type and save text notes during a game.class
A window from which players can create newGamePiece
s by clicking and dragging from the PieceWindow.class
class
Maintains a list of players involved in the current gameclass
Plugin is a general purpose component for use by Module Plugins that require some sort of initialisation.class
Defines a saved game that is accessible from the File menu.class
A Map that may be configured to be visible only a particular side.class
class
Container for definitions of Game Piece prototypes.class
class
...class
class
class
A Global Key Command that is automatically invoked on game start-up, once the various Key Listeners have been started.class
Takes buttons from the toolbar of a Map or the main module and places them into a popup menuModifier and TypeMethodDescriptionvoid
Adds a buildable subcomponent.void
void
void
void
void
void
void
void
void
void
void
Adds this BasicCommandEncoder to its parent, which should be theGameModule
.void
Expects to be added to aGameModule
.void
Expects to be added to a GameModule.void
Expects to be added to a GameModule.void
Registers us with the game module, tool bar, command encoder, etc.void
void
Expects to be added to a GameModule.void
void
void
void
void
GlobalOptions are added to theGameModule
.void
Expects to be added to the DieManager.void
void
void
Registers this Map as a child of another buildable component, usually theGameModule
.void
void
Expects to be added to aGameModule
.void
Expects to be added to aGameModule
.void
void
void
void
void
void
Expects to be added to a SymbolDice.void
void
void
void
protected void
ModuleExtension.checkGpIds
(Buildable b, GpIdChecker checker) void
void
void
void
void
void
void
ChartWindow.removeFrom
(Buildable b) void
ChessClockControl.removeFrom
(Buildable parent) Unregisters us from everything when shutting down.void
DieManager.removeFrom
(Buildable parent) void
Documentation.removeFrom
(Buildable b) void
GlobalOptions.removeFrom
(Buildable parent) Removes us from our parent componentvoid
InternetDiceButton.removeFrom
(Buildable b) void
Inventory.removeFrom
(Buildable b) void
Map.removeFrom
(Buildable b) Unregisters this Map from itsBuildable
parent (usually aGameModule
), reversing the process ofMap.addTo(VASSAL.build.Buildable)
.void
ModuleExtension.removeFrom
(Buildable parent) void
NotesWindow.removeFrom
(Buildable b) void
PieceWindow.removeFrom
(Buildable parent) void
PlayerRoster.removeFrom
(Buildable parent) void
Plugin.removeFrom
(Buildable parent) void
PredefinedSetup.removeFrom
(Buildable parent) void
PrototypeDefinition.removeFrom
(Buildable parent) void
PrototypesContainer.removeFrom
(Buildable parent) void
SpecialDiceButton.removeFrom
(Buildable b) void
SpecialDie.removeFrom
(Buildable parent) void
SpecialDieFace.removeFrom
(Buildable parent) void
StartupGlobalKeyCommand.removeFrom
(Buildable parent) void
ToolbarMenu.removeFrom
(Buildable parent) protected void
ModuleExtension.updateGpIds
(Buildable b) void
PrototypeDefinition.validate
(Buildable target, ValidationReport report) Modifier and TypeMethodDescriptionvoid
Plugin.registerComponent
(Class<? extends Buildable> parent, Class<? extends Buildable> child) Utility routine to register a new component with the module editor so that it appears in the right-click popup menu. -
Uses of Buildable in VASSAL.build.module.chessclockcontrol
Modifier and TypeMethodDescriptionvoid
Registers us with game module, command encoder, and the Chess Clock Control.void
ChessClock.removeFrom
(Buildable parent) Unregisters us when we are shutting down -
Uses of Buildable in VASSAL.build.module.documentation
Modifier and TypeClassDescriptionclass
Places an entry in theHelp
menu.class
Unpacks a zipped directory stored in the module and displays it in an external browser window.protected class
The attributes we want to expose in the editor are not the same as the ones we want to save to the buildFile, so we use this object to specify the properties in the editor.class
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)class
Places an entry in theHelp
menu.class
Provides tutorial functionality by reading in a logfileModifier and TypeMethodDescriptionvoid
void
Expects to be added to aDocumentation
.void
void
void
void
void
void
void
void
void
AboutScreen.removeFrom
(Buildable b) void
BrowserHelpFile.ConfigSupport.removeFrom
(Buildable parent) void
BrowserHelpFile.removeFrom
(Buildable parent) void
BrowserPDFFile.removeFrom
(Buildable parent) void
HelpFile.removeFrom
(Buildable b) void
Tutorial.removeFrom
(Buildable parent) -
Uses of Buildable in VASSAL.build.module.folder
Modifier and TypeClassDescriptionclass
class
class
class
class
-
Uses of Buildable in VASSAL.build.module.gamepieceimage
Modifier and TypeClassDescriptionclass
Container for definitions of Generic Color Definitionsclass
Class that implements a named Color Swatchclass
Container for definitions of Generic Color Definitionsclass
Class that implements a names Font Swatchclass
class
Container for definitions of Generic Counter Definitions.class
class
Container for definitions of Generic Counter Definitions.class
class
class
The base portion of a Counter Layout component.class
Individual override parameters for an instance of anItem
.class
class
class
class
class
class
class
class
Modifier and TypeMethodDescriptionvoid
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
ColorManager.removeFrom
(Buildable parent) void
ColorSwatch.removeFrom
(Buildable parent) void
FontManager.removeFrom
(Buildable parent) void
FontStyle.removeFrom
(Buildable parent) void
GamePieceImage.removeFrom
(Buildable parent) void
GamePieceImageDefinitions.removeFrom
(Buildable parent) void
GamePieceLayout.removeFrom
(Buildable parent) void
GamePieceLayoutsContainer.removeFrom
(Buildable parent) void
Item.removeFrom
(Buildable parent) void
ItemInstance.removeFrom
(Buildable parent) -
Uses of Buildable in VASSAL.build.module.map
Modifier and TypeClassDescriptionclass
class
This is aDrawable
class that draws the counters horizontally when the mouse is held over a stack with the control key down.class
This version ofMassKeyCommand
is added to aDrawPile
(which holds aDeck
) and applies to pieces/cards currently in the deck.class
class
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).class
class
class
This is scaled version of aMap
that gives an overview.protected class
class
Handles the drawing of cards in aPlayerHand
.class
This removes all game pieces from the (@link Map) therefore providing an un-cluttered view.class
class
This allows the user to capture a snapshot of the entire map into a PNG file.class
Selects and unselects pieces on the map, using the mouse.class
Adds a button to the toolbar to manipulate Game Piece Layersclass
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.class
A class that allows the user to draw a straight line on a Map (LOS = Line Of Sight).class
Centers the map when user right-clicks on an empty hexclass
Draw shaded regions on a map.class
Adds a button to a map window toolbar.class
class
Adds a button to a Maps toolbar that moves the view/camera to a specific pointclass
PieceMover handles the "Drag and Drop" of pieces and stacks, onto or within a Map window.class
Adds a button to a Maps toolbar that adjusts the positions of all pieces so that their centroid is at the center of the mapclass
This component listens to key events on a Map window and scrolls the map.class
class
class
This is the "At-Start Stack" component, which initializes a Map or Board with a specified stack.class
class
StackMetrics provides the [Stacking options] component of aMap
.class
class
Controls the zooming in/out of aMap
window.Modifier and TypeMethodDescriptionvoid
Add a board to the list of those available for the user to choose fromvoid
void
void
void
void
void
void
void
void
void
void
void
void
void
Adds this component to a Buildable component.void
void
void
Expects to be added to aMap
.void
Expects to be added to aMap
.void
void
Expects to be added to aMap
.void
Adds us to our parent map - we register as a mouse listener and a drawable componentvoid
void
void
Expects to be added to aMap
.void
void
void
void
void
void
Adds this component to its parent map.void
void
void
void
void
void
void
void
void
void
Remove a board from the list of those available for the user to choose fromvoid
void
void
BoardPicker.removeFrom
(Buildable parent) void
CounterDetailViewer.removeFrom
(Buildable parent) void
DeckGlobalKeyCommand.removeFrom
(Buildable parent) void
Flare.removeFrom
(Buildable parent) Removes this component from a Buildable parent.void
GlobalMap.removeFrom
(Buildable b) void
HidePiecesButton.removeFrom
(Buildable b) void
HighlightLastMoved.removeFrom
(Buildable parent) void
ImageSaver.removeFrom
(Buildable b) void
LayerControl.removeFrom
(Buildable parent) void
LayeredPieceCollection.removeFrom
(Buildable parent) void
LOS_Thread.removeFrom
(Buildable b) void
MapShader.removeFrom
(Buildable parent) void
MassKeyCommand.removeFrom
(Buildable parent) void
MoveCameraButton.removeFrom
(Buildable parent) void
PieceRecenterer.removeFrom
(Buildable parent) void
SelectionHighlighter.removeFrom
(Buildable parent) void
SelectionHighlighters.removeFrom
(Buildable parent) void
SetupStack.removeFrom
(Buildable parent) void
StackMetrics.removeFrom
(Buildable parent) void
TextSaver.removeFrom
(Buildable b) void
Zoomer.removeFrom
(Buildable b) void
BoardPicker.validate
(Buildable target, ValidationReport report) void
SetupStack.validate
(Buildable target, ValidationReport report) -
Uses of Buildable in VASSAL.build.module.map.boardPicker
-
Uses of Buildable in VASSAL.build.module.map.boardPicker.board
Modifier and TypeClassDescriptionclass
A Hexgrid is a map grid composed of hexes.class
class
class
class
Modifier and TypeMethodDescriptionvoid
void
void
void
void
void
HexGrid.removeFrom
(Buildable b) void
Region.removeFrom
(Buildable b) void
RegionGrid.removeFrom
(Buildable b) void
SquareGrid.removeFrom
(Buildable b) void
ZonedGrid.removeFrom
(Buildable parent) -
Uses of Buildable in VASSAL.build.module.map.boardPicker.board.mapgrid
Modifier and TypeClassDescriptionclass
class
Abstract base class for grid numbering classes for hexagonal and rectangular gridsclass
class
class
class
A Class that defines a method of highlighting the a zone in a multi-zoned grid.Modifier and TypeMethodDescriptionvoid
void
void
void
void
void
HexGridNumbering.removeFrom
(Buildable parent) void
SquareGridNumbering.removeFrom
(Buildable parent) void
Zone.removeFrom
(Buildable b) void
ZonedGridHighlighter.removeFrom
(Buildable b) void
ZoneHighlight.removeFrom
(Buildable b) -
Uses of Buildable in VASSAL.build.module.map.deck
Modifier and TypeClassDescriptionclass
Base class for additional Menu items (with Hotkeys) that can be added to a DrawPile/Deckclass
class
-
Uses of Buildable in VASSAL.build.module.properties
Modifier and TypeClassDescriptionclass
class
class
Adds a toolbar button that changes the value of a global propertyclass
Dummy component that acts as a simple container for GlobalProperty componentsclass
Adds a global property to a Map or Moduleclass
Adds a global property to a Map or Moduleclass
Dummy component that acts as a simple container for GlobalProperty componentsclass
class
class
class
class
Modifier and TypeMethodDescriptionvoid
void
void
void
void
void
void
void
void
void
ChangePropertyButton.removeFrom
(Buildable parent) void
GlobalProperties.removeFrom
(Buildable parent) void
GlobalProperty.removeFrom
(Buildable parent) void
GlobalTranslatableMessage.removeFrom
(Buildable parent) void
GlobalTranslatableMessages.removeFrom
(Buildable parent) void
ScenarioPropertiesOptionTab.removeFrom
(Buildable parent) -
Uses of Buildable in VASSAL.build.module.turn
Modifier and TypeClassDescriptionclass
class
class
Generic Turn Componentclass
class
class
Generic Turn CounterModifier and TypeMethodDescriptionvoid
void
void
void
void
TurnComponent.removeFrom
(Buildable parent) void
TurnGlobalHotkey.removeFrom
(Buildable parent) void
TurnLevel.removeFrom
(Buildable parent) void
TurnTracker.removeFrom
(Buildable b) -
Uses of Buildable in VASSAL.build.widget
Modifier and TypeClassDescriptionclass
class
A CardSlot is identical to a PieceSlot except that it is initialized with a card-like GamePiece.class
A Chart is used for displaying charts and tables for the module.class
An HtmlChart is used for displaying html information for the module.class
A Widget that corresponds to a panel with aJList
sitting to the right of aJPanel
with aCardLayout
layout.class
class
A Widget that corresponds to a JPanel with a GridLayout or BoxLayout layout.class
A Component that displays a GamePiece.class
A Widget that corresponds to a JTabbedPane.class
Modifier and TypeMethodDescriptionvoid
void
void
void
void
void
void
void
void
void
void
void
void
void
void
Chart.removeFrom
(Buildable parent) void
HtmlChart.removeFrom
(Buildable parent) void
PieceSlot.removeFrom
(Buildable parent) -
Uses of Buildable in VASSAL.chat
Modifier and TypeClassDescriptionclass
A window for private messages between the user and another player; -
Uses of Buildable in VASSAL.chat.ui
-
Uses of Buildable in VASSAL.configure
Modifier and TypeMethodDescriptionConfigureTree.AdditionalComponent.getChild()
ConfigureTree.AdditionalComponent.getParent()
Modifier and TypeMethodDescriptionvoid
Configurer.setContext
(Buildable context) void
CompoundValidityChecker.validate
(Buildable target, ValidationReport report) void
MandatoryComponent.validate
(Buildable b, ValidationReport report) void
NotNullConfigureName.validate
(Buildable b, ValidationReport report) void
RecursiveSingleChildInstance.validate
(Buildable b, ValidationReport report) void
SingleChildInstance.validate
(Buildable b, ValidationReport report) void
UniquelyNamedChildren.validate
(Buildable b, ValidationReport report) void
ValidityChecker.validate
(Buildable target, ValidationReport report) Modifier and TypeMethodDescriptionstatic void
ConfigureTree.addAdditionalComponent
(Class<? extends Buildable> parent, Class<? extends Buildable> child) Record additional available components to add to the popup menu.protected Action
ConfigureTree.buildAddAction
(Configurable target, Class<? extends Buildable> newConfig) protected Action
ConfigureTree.buildAddAction
(Configurable target, Class<? extends Buildable> newConfig, String key, int index, Configurable duplicate) protected Action
ExtensionTree.buildAddAction
(Configurable target, Class<? extends Buildable> newConfig) protected Action
ExtensionTree.buildAddAction
(Configurable target, Class<? extends Buildable> newConfig, String key, int index, Configurable duplicate) ModifierConstructorDescriptionAddAction
(Configurable target, Class<? extends Buildable> newConfig, String name, int index, Configurable duplicate) AdditionalComponent
(Class<? extends Buildable> p, Class<? extends Buildable> c) ChooseComponentDialog
(Frame owner, Class<? extends Buildable> targetClass) ChooseComponentPathDialog
(Frame owner, Class<? extends Buildable> targetClass) -
Uses of Buildable in VASSAL.i18n
Modifier and TypeInterfaceDescriptioninterface
Defines VASSAL's standard interface for getting and setting XML (buildFile) attributes, as well as attendant i18n translatable field infrastructure.Modifier and TypeClassDescriptionclass
Container for definitions of Translations.class
Singleton class for managing the translation of a module into other languagesclass
class
class
Utility class to allow translation of VASSAL using the Component Translation mechanism.Modifier and TypeMethodDescriptionvoid
void
void
void
void
Language.removeFrom
(Buildable parent) void
TranslatableMarker.removeFrom
(Buildable parent) void
Translation.removeFrom
(Buildable parent) -
Uses of Buildable in VASSAL.launch
Modifier and TypeClassDescriptionclass
Deprecated, for removal: This API element is subject to removal in a future version. -
Uses of Buildable in VASSAL.preferences
Modifier and TypeClassDescriptionclass
Base class for a Module Preference.class
A Checkbox Module Preference.class
A Decimal Number Module Preference.class
A Drop-down list preference.class
A whole number Module Preference.class
A String Module Preference.class
A multi-line textbox Module Preference. -
Uses of Buildable in VASSAL.script
Modifier and TypeClassDescriptionclass
class
class
Used by the Bsh Pluginclass
class
class
Container for Scripts.Modifier and TypeMethodDescriptionvoid
void
void
void
void
ActionScript.removeFrom
(Buildable parent) void
GeneralScript.removeFrom
(Buildable parent) void
ScriptContainer.removeFrom
(Buildable parent) void
ActionScript.validate
(Buildable target, ValidationReport report) void
GeneralScript.validate
(Buildable target, ValidationReport report) -
Uses of Buildable in VASSAL.tools
Modifier and TypeMethodDescriptionvoid
void
UniqueIdManager.validate
(Buildable target, ValidationReport report) Ensures that no other instance of the same class has the same name -
Uses of Buildable in VASSAL.tools.icon
Modifier and TypeClassDescriptionclass
An IconFamily is a named set of Icons in the four standard Tango sizes. -
Uses of Buildable in VASSAL.tools.imports
Modifier and TypeMethodDescriptionprotected static void
Importer.insertComponent
(Buildable child, Buildable parent)
AbstractBuildable.getBuildables()
instead.