Uses of Interface
VASSAL.build.module.properties.PropertySource

Packages that use PropertySource

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.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.properties
VASSAL.build.widget	Contains classes that can be added to a Widget.
VASSAL.configure	Provides classes for building "Edit Property" dialogs, and for editing GameModule's and ModuleExtension's.
VASSAL.counters	Provides classes that define game pieces.
VASSAL.i18n
VASSAL.launch
VASSAL.script
VASSAL.script.expression
VASSAL.tools	Contains various utility classes.

Uses of PropertySource in VASSAL.build

Classes in VASSAL.build that implement PropertySource

Modifier and Type	Class	Description
class	GameModule	The GameModule class is the base class for a VASSAL module.

Uses of PropertySource in VASSAL.build.module

Classes in VASSAL.build.module that implement PropertySource

Modifier and Type	Class	Description
class	Inventory.Counter	Holds static information of and a reference to a gamepiece.
class	Map	The Map is the main component for displaying and containing GamePieces during play.
class	PlayerHand
class	PrivateMap	A Map that may be configured to be visible only a particular side.

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

Modifier and Type	Method	Description
GamePiece	PrototypeDefinition.getPiece(PropertySource props)	For the case when the piece definition is a Message Format, expand the definition using the given properties

Uses of PropertySource in VASSAL.build.module.map

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

Modifier and Type	Class	Description
class	DrawPile

Fields in VASSAL.build.module.map declared as PropertySource

Modifier and Type	Field	Description
protected PropertySource	MassKeyCommand.propertySource
protected PropertySource	DrawPile.source

Methods in VASSAL.build.module.map with parameters of type PropertySource

Modifier and Type	Method	Description
void	MassKeyCommand.setPropertySource(PropertySource source)

Constructors in VASSAL.build.module.map with parameters of type PropertySource

Modifier	Constructor	Description
	DeckGlobalKeyCommand(String code, PropertySource source)

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

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

Modifier and Type	Class	Description
class	Zone

Uses of PropertySource in VASSAL.build.module.properties

Subinterfaces of PropertySource in VASSAL.build.module.properties

Modifier and Type	Interface	Description
static interface	IncrementProperty.Constraints
static interface	PropertyChangerConfigurer.Constraints

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

Modifier and Type	Class	Description
class	ChangePropertyButton	Adds a toolbar button that changes the value of a global property
class	GlobalProperties	Dummy component that acts as a simple container for GlobalProperty components
class	GlobalProperty	Adds a global property to a Map or Module
class	GlobalTranslatableMessage	Adds a global property to a Map or Module
class	GlobalTranslatableMessages	Dummy component that acts as a simple container for GlobalProperty components
class	SumProperties	For property names of the form sum(name), returns the value of the named property summed over a list of pieces.
class	ZoneProperty

Fields in VASSAL.build.module.properties declared as PropertySource

Modifier and Type	Field	Description
protected PropertySource	GlobalProperty.propertySource
protected PropertySource	GlobalTranslatableMessage.propertySource

Methods in VASSAL.build.module.properties that return PropertySource

Modifier and Type	Method	Description
PropertySource	ChangePropertyButton.getPropertySource()
PropertySource	IncrementProperty.Constraints.getPropertySource()
PropertySource	PropertyPrompt.Constraints.getPropertySource()

Uses of PropertySource in VASSAL.build.widget

Classes in VASSAL.build.widget that implement PropertySource

Modifier and Type	Class	Description
class	WidgetMap

Uses of PropertySource in VASSAL.configure

Methods in VASSAL.configure with parameters of type PropertySource

Modifier and Type	Method	Description
PieceFilter	PropertyExpression.getFilter(PropertySource source)
boolean	PropertyExpression.isTrue(PropertySource ps)	Evaluate the Property Expression as true/false using a supplied property source

Uses of PropertySource in VASSAL.counters

Subinterfaces of PropertySource in VASSAL.counters

Modifier and Type	Interface	Description
interface	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.
interface	GamePiece	Interface to deal with the behaviors of a physical component of the game, or a Trait of one.
interface	PropertyExporter	Interface for classes that can exporty the names and values of the properties they maintain

Classes in VASSAL.counters that implement PropertySource

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	BasicPiece	Basic class for representing a physical component of the game.
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	CounterGlobalKeyCommand	Trait that sends a Key Command to other pieces, selected with various filters.
class	Deck	A collection of pieces that behaves like a deck, i.e.: Doesn't move.
class	Decorator	The abstract class describing a generic 'Trait' of a full GamePiece.
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	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	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	Decorator that filters events to prevent a GamePiece from being selected and/or moved.
class	Labeler	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	MenuSeparator	This trait adds a command that creates a duplicate of the selected Gamepiece
class	MovementMarkable	A GamePiece with this trait will automatically be marked whenever it is moved.
class	NonRectangular	A trait for assigning an arbitrary shape to a GamePiece
class	Obscurable
class	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	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	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	Stack	A Stack is a collection of pieces in the same location that can often be moved with a single drag-and-drop.
class	SubMenu	A trait that groups menu items of other traits into a sub-menu
class	TableInfo	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	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	This trait is a placeholder for a pre-defined series of traits specified in a PrototypeDefinition object.

Fields in VASSAL.counters declared as PropertySource

Modifier and Type	Field	Description
protected PropertySource	Deck.propertySource
protected PropertySource	GlobalCommand.source

Methods in VASSAL.counters that return PropertySource

Modifier and Type	Method	Description
PropertySource	DynamicProperty.getPropertySource()

Methods in VASSAL.counters with parameters of type PropertySource

Modifier and Type	Method	Description
void	Deck.setPropertySource(PropertySource source)	Sets the Deck's property source
void	GlobalCommand.setPropertySource(PropertySource ps)

Constructors in VASSAL.counters with parameters of type PropertySource

Modifier	Constructor	Description
	Deck(String type, PropertySource source)	Deprecated, for removal: This API element is subject to removal in a future version. use Deck(GameModule, String, PropertySource)
	Deck(GameModule gameModule, String type, PropertySource source)	Creates an empty deck using specified type information
	GlobalCommand(RecursionLimiter.Loopable l, PropertySource p)

Uses of PropertySource in VASSAL.i18n

Subinterfaces of PropertySource in VASSAL.i18n

Modifier and Type	Interface	Description
interface	TranslatablePiece	Decorators that contain localizable elements must implement this interface

Uses of PropertySource in VASSAL.launch

Classes in VASSAL.launch that implement PropertySource

Modifier and Type	Class	Description
class	BasicModule	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of PropertySource in VASSAL.script

Fields in VASSAL.script declared as PropertySource

Modifier and Type	Field	Description
protected PropertySource	ExpressionInterpreter.source

Methods in VASSAL.script with parameters of type PropertySource

Modifier and Type	Method	Description
String	ActionScript.evaluate(PropertySource target)
String	ExpressionInterpreter.evaluate(PropertySource ps)	Evaluate the expression, setting the value of any undefined values to the matching Vassal property value.
String	ExpressionInterpreter.evaluate(PropertySource ps, boolean localized)
String	GeneralScript.evaluate(PropertySource target)
Object	ScriptInterpreter.evaluate(String statement, PropertySource source)
Object	ExpressionInterpreter.sumLocation(String property, PropertySource ps)	SumLocation(property) function Total the value of the named property in all counters in the same location as the specified piece.
Object	ExpressionInterpreter.sumStack(String property, PropertySource ps)	SumStack(property) function Total the value of the named property in all counters in the same stack as the specified piece.

Uses of PropertySource in VASSAL.script.expression

Methods in VASSAL.script.expression with parameters of type PropertySource

Modifier and Type	Method	Description
String	BeanShellExpression.evaluate(PropertySource ps, Map<String,String> properties, boolean localized)	Evaluate this expression using a BeanShell Interpreter
String	Expression.evaluate(PropertySource ps)
String	Expression.evaluate(PropertySource ps, boolean localized)
String	Expression.evaluate(PropertySource ps, Map<String,String> properties, boolean localized)	Each subclass must implement evaluate() to evaluate itself
String	FormattedStringExpression.evaluate(PropertySource ps, Map<String,String> properties, boolean localized)	Evaluate this expression.
String	PropertyMatchExpression.evaluate(PropertySource ps, Map<String,String> properties, boolean localized)
String	SinglePropertyExpression.evaluate(PropertySource ps, Map<String,String> properties, boolean localized)
PieceFilter	BeanShellExpression.getFilter(PropertySource ps)	Return a PieceFilter that selects GamePieces that cause this expression to evaluate to true
PieceFilter	Expression.getFilter(PropertySource ps)	Return a PieceFilter using the expression.
PieceFilter	PropertyMatchExpression.getFilter(PropertySource ps)
String	Expression.tryEvaluate(PropertySource ps)	Evaluate an expression with data warning support built in
String	Expression.tryEvaluate(PropertySource ps, boolean localized)	Evaluate an expression with data warning support built in
String	Expression.tryEvaluate(PropertySource ps, Map<String,String> properties, boolean localized)	Evaluate an expression with data warning support built in

Uses of PropertySource in VASSAL.tools

Methods in VASSAL.tools that return PropertySource

Modifier and Type	Method	Description
PropertySource	FormattedString.getDefaultProperties()

Methods in VASSAL.tools with parameters of type PropertySource

Modifier and Type	Method	Description
String	FormattedString.getLocalizedText(PropertySource ps)
String	FormattedString.getText(PropertySource ps)	Return the resulting string after substituting properties Also, if any property keys match a property in the given GamePiece, substitute the value of that property
protected String	FormattedString.getText(PropertySource ps, boolean localized)
String	FormattedString.getText(PropertySource ps, String def)	Return the resulting string after substituting properties Also, if any property keys match a property in the given GamePiece, substitute the value of that property.
int	FormattedString.getTextAsInt(PropertySource ps, String description, AbstractConfigurable source)
int	FormattedString.getTextAsInt(PropertySource ps, String description, EditablePiece source)	Expand a FormattedString using the supplied propertySource and parse it as an integer.
void	FormattedString.setDefaultProperties(PropertySource defaultProperties)

Constructors in VASSAL.tools with parameters of type PropertySource

Modifier	Constructor	Description
	FormattedString(String formatString, PropertySource defaultProperties)
	FormattedString(PropertySource defaultProperties)