Uses of Class
VASSAL.counters.Decorator

Packages that use Decorator

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.counters	Provides classes that define game pieces.
VASSAL.script
VASSAL.tools.imports.adc2

Uses of Decorator in VASSAL.build

Methods in VASSAL.build with parameters of type Decorator

Modifier and Type	Method	Description
protected String	GpIdChecker.findState(GamePiece oldPiece, GamePiece pNew, Decorator decoratorNewPc, Class<? extends GamePiece> classToFind)	Locate a Decorator in the old piece that has the exact same type as the new Decorator and return it's state

Uses of Decorator in VASSAL.build.module

Methods in VASSAL.build.module that return Decorator

Modifier and Type	Method	Description
Decorator	BasicCommandEncoder.createDecorator(String type, GamePiece inner)	Creates a Decorator instance - a GamePiece "Trait".
Decorator	BasicCommandEncoder.DecoratorFactory.createDecorator(String type, GamePiece inner)

Uses of Decorator in VASSAL.counters

Subclasses of Decorator in VASSAL.counters

Modifier and Type	Class	Description
class	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
class	AreaOfEffect
class	Attachment	Trait allowing creation of an "attachment" to one or more other pieces, which can then be sent GKCs very swiftly and whose properties can be easily read (and if a Dynamic Property can also be set with a Set Global Property trait)
class	BasicName	This trait overrides the $BasicName$ property provided by the "Basic Piece", allowing a module designer decking to define pieces entirely by prototype to safely ignore and leave empty the Basic Piece.
class	BorderOutline	Trait to draw a colored border around a piece
class	CalculatedProperty	Conditional Marker A marker with a variable value depending on conditions.
class	Clone	This trait adds a command that creates a duplicate of the selected Gamepiece
class	Comment	A trait that exists in a Piece Definition, but is not included when the piece is created in a real game.
class	CounterGlobalKeyCommand	Trait that sends a Key Command to other pieces, selected with various filters.
class	Delete	This trait adds a command that creates a duplicate of the selected Gamepiece
class	Deselect	Implements a trait to allow a piece to be deselected from the KeyBuffer in response to a Key Command.
class	DynamicProperty	Trait that contains a property accessible via getProperty() and updatable dynamically via key commands
class	Embellishment	d/b/a "Layer" The "Layer" trait.
class	Embellishment0	Embellishment has been extensively re-written for Vassal 3.2 changing both the behavior and the visual look of the configurer.
class	Footprint	Displays a movement trail indicating where a piece has been moved
class	FreeRotator	d/b/a "Can Rotate" A Decorator that rotates a GamePiece to an arbitrary angle
class	GlobalHotKey	Adds a menu entry that fires a specified key event to the module window.
class	Hideable
class	Immobilized	d/b/a "Does Not Stack" Decorator that filters events to prevent a GamePiece from being selected and/or moved.
class	Labeler	d/b/a "Text Label" Displays a text label, with content specified by the user at runtime.
class	Marker	A generic Decorator that retains in its state the value of a property.
class	Mat	Designates the piece as a "Mat" on which other pieces ("Cargo") can be placed.
class	MatCargo	Designates the piece as "Cargo", which can be placed on a "Mat" to move along with it
class	MenuSeparator	This trait puts a menu separator bar in the context menu for the piece
class	MovementMarkable	d/b/a "Mark When Moved" A GamePiece with this trait will automatically be marked whenever it is moved.
class	MultiLocationCommand	Allows a single trait to generate multiple context menu commands, using a set of filtered map locations.
class	NonRectangular	A trait for assigning an arbitrary shape to a GamePiece
class	Obscurable	d/b/a "Mask" Trait that lets some traits of a piece be hidden "from some players, some of the time".
class	Pivot	d/b/a "Can Pivot" Provides commands to pivot a Game Piece around a given point
class	PlaceMarker	This Decorator defines a key command to places another counter on top of this one.
class	PlaySound	A trait that plays a sound clip
class	PropertySheet	A Decorator class that endows a GamePiece with a dialog.
class	Replace	GamePiece trait that replaces a GamePiece with another one
class	ReportState	d/b/a "Report Action" 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)
class	RestrictCommands	RestrictCommands Restrict the availability of Key Commands, depending on a Property Match String
class	Restricted	d/b/a "Restricted Access" A GamePiece with the Restricted trait can only be manipulated by the player playing a specific side
class	ReturnToDeck	GamePiece trait that returns a piece to a DrawPile
class	SendToLocation	This trait adds a command that sends a piece to another location.
class	SetGlobalProperty
class	SetPieceProperty
class	SubMenu	A trait that groups menu items of other traits into a sub-menu
class	TableInfo	d/b/a "Spreadsheet" A Decorator class that endows a GamePiece with an editable spreadsheet (i.e.
class	TranslatableMessage	A trait to expose a translated string as a readable/displayable property.
class	Translate	d/b/a "Move Fixed Distance" Give a piece a command that moves it a fixed amount in a particular direction, optionally tracking the current rotation of the piece.
class	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
class	UsePrototype	d/b/a "Prototype" This trait is a placeholder for a pre-defined series of traits specified in a PrototypeDefinition object.

Fields in VASSAL.counters declared as Decorator

Modifier and Type	Field	Description
protected Decorator	SetGlobalProperty.dec
protected Decorator	SetPieceProperty.dec

Methods in VASSAL.counters that return Decorator

Modifier and Type	Method	Description
Decorator	Decorator.getOuter()

Methods in VASSAL.counters with parameters of type Decorator

Modifier and Type	Method	Description
protected void	MassPieceDefiner.addTrait(Decorator c)
protected void	MassPieceDefiner.addTrait(Decorator c, int insertIndex)
protected void	PieceDefiner.addTrait(Decorator c)
protected void	PieceDefiner.addTrait(Decorator c, int insertIndex)

Constructors in VASSAL.counters with parameters of type Decorator

Modifier	Constructor	Description
	TraitClipboard(Decorator copy)

Uses of Decorator in VASSAL.script

Methods in VASSAL.script that return Decorator

Modifier and Type	Method	Description
Decorator	BshCommandEncoder.createDecorator(String type, GamePiece inner)

Uses of Decorator in VASSAL.tools.imports.adc2

Methods in VASSAL.tools.imports.adc2 that return Decorator

Modifier and Type	Method	Description
protected Decorator	ADC2Module.Piece.getHidden()
Decorator	ADC2Module.PieceClass.getHiddenDecorator()
Decorator	ADC2Module.PieceClass.getReplaceWithOtherDecorator()
Decorator	ADC2Module.PieceClass.getReplaceWithPreviousDecorator()