Uses of Interface
VASSAL.build.module.GameComponent

Packages that use GameComponent

Package	Description
VASSAL.build	Provides classes for building Java instances automatically from XML files.
VASSAL.build.module	Contains classes that may be added to a GameModule.
VASSAL.build.module.chessclockcontrol
VASSAL.build.module.map	Contains classes that may be added to a Map.
VASSAL.build.module.map.boardPicker.board.mapgrid	Contains classes that may be added to a MapGrid.
VASSAL.build.module.noteswindow	Contains classes that may be added to a NotesWindow.
VASSAL.build.module.properties
VASSAL.build.module.turn
VASSAL.build.widget	Contains classes that can be added to a Widget.

Uses of GameComponent in VASSAL.build

Classes in VASSAL.build that implement GameComponent

Modifier and Type	Class	Description
class	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.

Uses of GameComponent in VASSAL.build.module

Classes in VASSAL.build.module that implement GameComponent

Modifier and Type	Class	Description
class	BasicLogger	BasicLogger deals with VLOG Vassal Log files (i.e.
class	ChessClockControl	CHESS CLOCK CONTROLLER for VASSAL.
class	DiceButton	This component places a button into the controls window toolbar.
class	DoActionButton	This component places a button into the controls window toolbar.
class	EventLog
final class	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.
class	GlobalKeyCommand	This version of MassKeyCommand is added directly to a GameModule and applies to all maps.
class	InternetDiceButton	This component places a button into the controls window toolbar.
class	Inventory
class	Map	The Map is the main component for displaying and containing GamePieces during play.
class	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
class	ModulePlugin	A ModulePlugin is basically identical to a ModuleExtension except that is loaded earlier and must throw Plugin specific error messages
class	MultiActionButton	Combines multiple buttons from the toolbar into a single button.
class	NewGameIndicator	Provides information about whether a game was started from File->New Game or loaded from a saved game
class	NotesWindow	This is a GameComponent that allows players to type and save text notes during a game.
class	ObscurableOptions	Determines whether players are allowed to unmask other players pieces.
class	PlayerHand
class	PlayerRoster	Maintains a list of players involved in the current game
class	PredefinedSetup	Defines a saved game that is accessible from the File menu.
class	PrivateMap	A Map that may be configured to be visible only a particular side.
class	RandomTextButton
class	SpecialDiceButton	...
class	StartupGlobalKeyCommand	A Global Key Command that is automatically invoked on game start-up, once the various Key Listeners have been started.
class	ToolbarMenu	Takes buttons from the toolbar of a Map or the main module and places them into a popup menu

Fields in VASSAL.build.module with type parameters of type GameComponent

Modifier and Type	Field	Description
protected List<GameComponent>	GameState.gameComponents

Methods in VASSAL.build.module that return types with arguments of type GameComponent

Modifier and Type	Method	Description
Collection<GameComponent>	GameState.getGameComponents()

Methods in VASSAL.build.module with parameters of type GameComponent

Modifier and Type	Method	Description
void	GameState.addGameComponent(GameComponent theComponent)	Add a GameComponent to the list of objects that will be notified when a game is started/ended
void	GameState.removeGameComponent(GameComponent theComponent)	Remove a GameComponent from the list of objects that will be notified when a game is started/ended

Uses of GameComponent in VASSAL.build.module.chessclockcontrol

Classes in VASSAL.build.module.chessclockcontrol that implement GameComponent

Modifier and Type	Class	Description
class	ChessClock	CHESS CLOCK class for VASSAL.

Uses of GameComponent in VASSAL.build.module.map

Classes in VASSAL.build.module.map that implement GameComponent

Modifier and Type	Class	Description
class	BoardPicker	This class is responsible for maintaining the Boards on a Map.
class	DeckGlobalKeyCommand	This version of MassKeyCommand is added to a DrawPile (which holds a Deck) and applies to pieces/cards currently in the deck.
class	DrawPile
class	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).
class	GlobalMap	This is scaled version of a Map that gives an overview.
class	HidePiecesButton	This removes all game pieces from the (@link Map) therefore providing an un-cluttered view.
class	HighlightLastMoved
class	ImageSaver	This allows the user to capture a snapshot of the entire map into a PNG file.
class	LayerControl	Adds a button to the toolbar to manipulate Game Piece Layers
class	LOS_Thread	A class that allows the user to draw a straight line on a Map (LOS = Line Of Sight).
class	MapShader	Draw shaded regions on a map.
class	MassKeyCommand	Adds a button to a map window toolbar.
class	MoveCameraButton	Adds a button to a Maps toolbar that moves the view/camera to a specific point
class	PieceMover	PieceMover handles the "Drag and Drop" of pieces and stacks, onto or within a Map window.
class	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
class	SetupStack	This is the "At-Start Stack" component, which initializes a Map or Board with a specified stack.
class	TextSaver
class	Zoomer	Controls the zooming in/out of a Map window.

Uses of GameComponent in VASSAL.build.module.map.boardPicker.board.mapgrid

Classes in VASSAL.build.module.map.boardPicker.board.mapgrid that implement GameComponent

Modifier and Type	Class	Description
class	Zone

Uses of GameComponent in VASSAL.build.module.noteswindow

Classes in VASSAL.build.module.noteswindow that implement GameComponent

Modifier and Type	Class	Description
class	PrivateNotesController	Holds PrivateText objects, only displaying the one owned by the current user
class	SecretNotesController

Uses of GameComponent in VASSAL.build.module.properties

Classes in VASSAL.build.module.properties that implement GameComponent

Modifier and Type	Class	Description
class	ChangePropertyButton	Adds a toolbar button that changes the value of a global property
class	GlobalProperty	Adds a global property to a Map or Module
class	GlobalTranslatableMessage	Adds a global property to a Map or Module
class	ZoneProperty

Uses of GameComponent in VASSAL.build.module.turn

Classes in VASSAL.build.module.turn that implement GameComponent

Modifier and Type	Class	Description
class	TurnTracker	Generic Turn Counter

Uses of GameComponent in VASSAL.build.widget

Classes in VASSAL.build.widget that implement GameComponent

Modifier and Type	Class	Description
class	WidgetMap