Uses of Interface
VASSAL.build.module.properties.PropertySource
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
Map
.Contains classes that may be added to a
MapGrid
.Contains classes that can be added to a
Widget
.Provides classes for building "Edit Property" dialogs, and for editing
GameModule
's and ModuleExtension
's.Provides classes that define game pieces.
Contains various utility classes.
-
Uses of PropertySource in VASSAL.build
Modifier and TypeClassDescriptionclass
The GameModule class is the base class for a VASSAL module. -
Uses of PropertySource in VASSAL.build.module
Modifier and TypeClassDescriptionclass
Holds static information of and a reference to a gamepiece.class
The Map is the main component for displaying and containingGamePiece
s during play.class
class
A Map that may be configured to be visible only a particular side.Modifier and TypeMethodDescriptionPrototypeDefinition.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
Modifier and TypeFieldDescriptionprotected PropertySource
MassKeyCommand.propertySource
protected PropertySource
DrawPile.source
-
Uses of PropertySource in VASSAL.build.module.map.boardPicker.board.mapgrid
-
Uses of PropertySource in VASSAL.build.module.properties
Modifier and TypeInterfaceDescriptionstatic interface
static interface
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
For property names of the form sum(name), returns the value of the named property summed over a list of pieces.class
Modifier and TypeFieldDescriptionprotected PropertySource
GlobalProperty.propertySource
protected PropertySource
GlobalTranslatableMessage.propertySource
protected PropertySource
RemoteIncrementProperty.targetPropertySource
Modifier and TypeMethodDescriptionChangePropertyButton.getPropertySource()
IncrementProperty.Constraints.getPropertySource()
PropertyPrompt.Constraints.getPropertySource()
IncrementProperty.getTargetPropertySource()
RemoteIncrementProperty.getTargetPropertySource()
Modifier and TypeMethodDescriptionRemoteEnumeratedPropertyPrompt.getNewValue
(DynamicProperty target, Auditable owner, PropertySource ps) RemoteIncrementProperty.getNewValue
(DynamicProperty target, Auditable owner, PropertySource ps) RemotePropertyChanger.getNewValue
(DynamicProperty target, Auditable owner, PropertySource ps) RemotePropertyPrompt.getNewValue
(DynamicProperty target, Auditable owner, PropertySource ps) RemotePropertySetter.getNewValue
(DynamicProperty remoteDP, Auditable owner, PropertySource ps) Evaluate any expression using the remote piece as the source of properties Pre-evaluate any $$ variables in the local piece. -
Uses of PropertySource in VASSAL.build.widget
-
Uses of PropertySource in VASSAL.configure
Modifier and TypeMethodDescriptionboolean
PropertyExpression.accept
(PropertySource source, GamePiece piece) boolean
PropertyExpression.accept
(PropertySource source, GamePiece piece, Auditable owner, AuditTrail trail) PropertyExpression.getFilter
(PropertySource source) PropertyExpression.getFilter
(PropertySource source, Auditable owner, String fieldKey) PropertyExpression.getFilter
(PropertySource source, Auditable owner, AuditTrail audit) boolean
PropertyExpression.isTrue
(PropertySource ps) Evaluate the Property Expression as true/false using a supplied property sourceboolean
PropertyExpression.isTrue
(PropertySource ps, Auditable owner, AuditTrail audit) -
Uses of PropertySource in VASSAL.counters
Modifier and TypeInterfaceDescriptioninterface
If class implementing GamePiece also implements the EditablePiece interface, then it can be manipulated from the Editor's Configuration Tree via thePieceDefiner
dialog.interface
Interface to deal with the behaviors of a physical component of the game, or a Trait of one.interface
Interface for classes that can export the names and values of the properties they maintainModifier and TypeClassDescriptionclass
A Trait (akaDecorator
that acts like a button on a GamePiece, such that clicking on a particular area of the piece invokes a key commandclass
class
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
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
Basic class for representing a physical component of the game.class
Trait to draw a colored border around a piececlass
Conditional Marker A marker with a variable value depending on conditions.class
This trait adds a command that creates a duplicate of the selected Gamepiececlass
A trait that exists in a Piece Definition, but is not included when the piece is created in a real game.class
Trait that sends a Key Command to other pieces, selected with various filters.class
A collection of pieces that behaves like a deck, i.e.: Doesn't move.class
The abstract class describing a generic 'Trait' of a full GamePiece.class
This trait adds a command that creates a duplicate of the selected Gamepiececlass
Implements a trait to allow a piece to be deselected from the KeyBuffer in response to a Key Command.class
Trait that contains a property accessible via getProperty() and updatable dynamically via key commandsclass
d/b/a "Layer" The "Layer" trait.class
Embellishment has been extensively re-written for Vassal 3.2 changing both the behavior and the visual look of the configurer.class
Displays a movement trail indicating where a piece has been movedclass
d/b/a "Can Rotate" A Decorator that rotates a GamePiece to an arbitrary angleclass
Adds a menu entry that fires a specified key event to the module window.class
class
d/b/a "Does Not Stack" Decorator that filters events to prevent a GamePiece from being selected and/or moved.class
d/b/a "Text Label" Displays a text label, with content specified by the user at runtime.class
A generic Decorator that retains in its state the value of a property.class
Designates the piece as a "Mat" on which other pieces ("Cargo") can be placed.class
Designates the piece as "Cargo", which can be placed on a "Mat" to move along with itclass
This trait puts a menu separator bar in the context menu for the piececlass
d/b/a "Mark When Moved" A GamePiece with this trait will automatically be marked whenever it is moved.class
Allows a single trait to generate multiple context menu commands, using a set of filtered map locations.class
A trait for assigning an arbitrary shape to aGamePiece
class
d/b/a "Mask" Trait that lets some traits of a piece be hidden "from some players, some of the time".class
d/b/a "Can Pivot" Provides commands to pivot a Game Piece around a given pointclass
This Decorator defines a key command to places another counter on top of this one.class
A trait that plays a sound clipclass
A Decorator class that endows a GamePiece with a dialog.class
GamePiece trait that replaces a GamePiece with another oneclass
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)static class
Looks in both the new and old piece for property values.class
RestrictCommands Restrict the availability of Key Commands, depending on a Property Match Stringclass
d/b/a "Restricted Access" A GamePiece with the Restricted trait can only be manipulated by the player playing a specific sideclass
GamePiece trait that returns a piece to aDrawPile
class
This trait adds a command that sends a piece to another location.class
class
class
A Stack is a collection of pieces in the same location that can often be moved with a single drag-and-drop.class
A trait that groups menu items of other traits into a sub-menuclass
d/b/a "Spreadsheet" A Decorator class that endows a GamePiece with an editable spreadsheet (i.e.class
A trait to expose a translated string as a readable/displayable property.class
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
Macro Execute a series of Keystrokes against this same piece - Triggered by own KeyCommand or list of keystrokes - Match against an optional Property Filterclass
d/b/a "Prototype" This trait is a placeholder for a pre-defined series of traits specified in aPrototypeDefinition
object.Modifier and TypeFieldDescriptionprotected PropertySource
Deck.propertySource
protected PropertySource
GlobalCommand.source
Modifier and TypeMethodDescriptionDynamicProperty.getPropertySource()
GlobalCommand.getPropertySource()
Modifier and TypeMethodDescriptionstatic SendToLocation.Destination
SendToLocation.getSendLocation
(PropertySource source, Auditable auditSource, String destination, FormattedString mapId, FormattedString boardName, FormattedString zone, FormattedString region, FormattedString gridLocation, FormattedString x, FormattedString y, PropertyExpression propertyFilter, Map sourceMap, Point startPosition) Compute a destination from the parametersstatic Command
Decorator.setDynamicProperties
(List<Parameter> parameters, GamePiece piece, PropertySource source, Auditable owner) Find and set a series of Dynamic Properties in the supplied GamePiece named propertyName and generate a Command to set it to the specified values in other clientsstatic Command
Decorator.setDynamicProperties
(List<Parameter> parameters, GamePiece piece, PropertySource source, Auditable owner, AuditTrail auditSoFar) static Command
Decorator.setDynamicProperty
(String propertyName, String value, GamePiece piece, PropertySource source, Auditable owner, AuditTrail audit) Find a Dynamic Property in the supplied GamePiece named propertyName and generate a Command to set it to the specified valuevoid
Deck.setPropertySource
(PropertySource source) Sets the Deck's property sourcevoid
GlobalCommand.setPropertySource
(PropertySource ps) ModifierConstructorDescriptionDeck
(GameModule gameModule, String type, PropertySource source) Creates an empty deck using specified type informationGlobalAttach
(Attachment attach, PropertySource p) GlobalDetach
(Attachment attach, PropertySource p) -
Uses of PropertySource in VASSAL.i18n
Modifier and TypeInterfaceDescriptioninterface
Decorators that contain localizable elements must implement this interface -
Uses of PropertySource in VASSAL.launch
Modifier and TypeClassDescriptionclass
Deprecated, for removal: This API element is subject to removal in a future version. -
Uses of PropertySource in VASSAL.script
Modifier and TypeMethodDescriptionExpressionInterpreter.audit
(Object message, Object conditionOrOptionList, Object optionList, PropertySource ps) Audit Write a message to the errorlogExpressionInterpreter.countAttachment
(Object attachment, Object property, Object expression, PropertySource ps) ExpressionInterpreter.countAttachment
(Object attachment, Object propertyOrExpression, PropertySource ps) CountAttach Beanshell function implementationExpressionInterpreter.countCurrentZone
(Object propertyName, Object expression, PropertySource ps) ExpressionInterpreter.countLocation
(Object propertyOrLocation, Object expressionOrMap, PropertySource ps) ExpressionInterpreter.countLocation
(Object propertyOrExpression, PropertySource ps) ExpressionInterpreter.countLocation
(PropertySource ps) BeanShell CountLocation implementation Return count of pieces in the same location as the current pieceExpressionInterpreter.countMap
(Object map, Object property, Object expression, PropertySource ps) ExpressionInterpreter.countMap
(Object propertyOrMap, Object expressionOrProperty, PropertySource ps) ExpressionInterpreter.countMap
(Object propertyOrExpressionOrMap, PropertySource ps) ExpressionInterpreter.countMap
(PropertySource ps) ExpressionInterpreter.countMapLocation
(Object locationName, Object mapName, Object property, Object expression, PropertySource ps) ExpressionInterpreter.countMapLocation
(Object locationName, Object mapName, Object propertyOrExpression, PropertySource ps) ExpressionInterpreter.countMat
(Object property, Object expression, PropertySource ps) ExpressionInterpreter.countMat
(Object propertyOrExpression, PropertySource ps) CountMat(property) function Return the total number of counters with a non-blank value for the specified property among the Mat-and-MatCargo grouping of the current pieceExpressionInterpreter.countMat
(PropertySource ps) ExpressionInterpreter.countRange
(Object propertyOrExpression, Object expression, Object minRange, Object maxRange, Boolean asPixels, PropertySource ps) Implementation of all flavours of CountRange and CounrRangePx functionsExpressionInterpreter.countStack
(Object property, Object expression, PropertySource ps) ExpressionInterpreter.countStack
(Object propertyOrExpression, PropertySource ps) CountStack(property) and CountStack(expression) function count the number of pieces in the same stack which have any non-blank value for the specified property.ExpressionInterpreter.countZone
(Object zoneName, Object mapName, Object property, Object expression, PropertySource ps) ExpressionInterpreter.countZone
(Object zoneName, Object mapName, Object propertyOrExpression, PropertySource ps) ExpressionInterpreter.countZone
(Object propertyOrZone, Object expressionOrMap, PropertySource ps) ExpressionInterpreter.countZone
(Object propertyOrExpression, PropertySource ps) ExpressionInterpreter.countZone
(PropertySource ps) CountZone() function.ActionScript.evaluate
(PropertySource target) ExpressionInterpreter.evaluate
(PropertySource ps) Evaluate the expression, setting the value of any undefined values to the matching Vassal property value.ExpressionInterpreter.evaluate
(PropertySource ps, boolean localized) ExpressionInterpreter.evaluate
(PropertySource ps, boolean localized, Auditable owner, AuditTrail audit) ExpressionInterpreter.evaluate
(PropertySource ps, Map<String, String> properties, boolean localized, Auditable owner, AuditTrail audit) GeneralScript.evaluate
(PropertySource target) ScriptInterpreter.evaluate
(String statement, PropertySource source) ExpressionInterpreter.getAttachmentProperty
(Object attachment, Object property, Object indexOrNameOrexpression, PropertySource ps) Callback for Beanshell getAttachProperty functionsExpressionInterpreter.maxAttachment
(Object attachment, Object property, PropertySource ps) MaxAttachment(attachment, property) function Highest value of the named property among all pieces attached, or 0 if no pieces are attachedExpressionInterpreter.minAttachment
(Object attachment, Object property, PropertySource ps) MinAttachment(attachment, property) function Lowest value of the named property among all pieces attached, or 0 if no pieces are attachedExpressionInterpreter.rangeAttach
(Object attachmentName, Object expression, boolean asPixels, PropertySource ps) Implementation of Range functionsExpressionInterpreter.rangeInCells
(Object x1, Object y1, Object x2, Object y2, Object mapName, PropertySource ps) ExpressionInterpreter.rangeInCells
(Object x1, Object y1, Object x2, Object y2, PropertySource ps) ExpressionInterpreter.rangeInCells
(Object x, Object y, PropertySource ps) ExpressionInterpreter.rangeInPixels
(Object x1, Object y1, Object x2, Object y2, Object mapName, PropertySource ps) ExpressionInterpreter.rangeInPixels
(Object x1, Object y1, Object x2, Object y2, PropertySource ps) ExpressionInterpreter.rangeInPixels
(Object x, Object y, PropertySource ps) ExpressionInterpreter.sleep
(Object ms, PropertySource ps) Refresh the screen, then delay for the specified number of milliseconds This is not pretty, but is the only way I have found to force a proper UI refresh - Open a modal dialog box way offscreen.ExpressionInterpreter.sumAttachment
(Object attachment, Object property, Object expression, PropertySource ps) ExpressionInterpreter.sumAttachment
(Object attachment, Object property, PropertySource ps) SumAttach Beanshell function implementationExpressionInterpreter.sumLocation
(Object property, Object location, Object map, Object expression, PropertySource ps) SumMapLocation(property, location, map, expression) function Total the value of the named property in all counters in the specified map and location that match the supplied expressionExpressionInterpreter.sumLocation
(Object property, Object location, Object map, PropertySource ps) SumMapLocation(property, location, map) function Total the value of the named property in all counters in the specified map and locationExpressionInterpreter.sumLocation
(Object property, Object expression, PropertySource ps) SumLocation(property, expression) function Total the value of the named property in all counters in the same location as the specified piece that meet the supplied expression.ExpressionInterpreter.sumLocation
(Object property, PropertySource ps) SumLocation(property) function Total the value of the named property in all counters in the same location as the specified piece.ExpressionInterpreter.sumMap
(Object property, Object map, Object expression, PropertySource ps) ExpressionInterpreter.sumMap
(Object property, Object mapOrExpression, PropertySource ps) ExpressionInterpreter.sumMap
(Object property, PropertySource ps) ExpressionInterpreter.sumMat
(Object property, Object expression, PropertySource ps) ExpressionInterpreter.sumMat
(Object propertyOrExpression, PropertySource ps) SumMat(property) function Total the value of the named property in all counters among the Mat-and-MatCargo grouping of the current pieceExpressionInterpreter.sumRange
(Object propertyName, Object expression, Object minRange, Object maxRange, Boolean asPixels, PropertySource ps) Implementation of all flavours of SumRange and SumRangePx functionsExpressionInterpreter.sumStack
(Object property, Object expression, PropertySource ps) SumStack(property, expression) function Total the value of the named property in all counters in the same stack as the specified piece that meet the specified expressionExpressionInterpreter.sumStack
(Object property, PropertySource ps) SumStack(property) function Total the value of the named property in all counters in the same stack as the specified piece.ExpressionInterpreter.sumZone
(Object property, Object zone, Object map, Object expression, PropertySource ps) SumZone(property, location, map, expression) function Total the value of the named property in all counters in the specified map and zone that match the supplied expression -
Uses of PropertySource in VASSAL.script.expression
Modifier and TypeMethodDescriptionBeanShellExpression.evaluate
(PropertySource ps, Map<String, String> properties, boolean localized) Deprecated.BeanShellExpression.evaluate
(PropertySource ps, Map<String, String> properties, boolean localized, Auditable owner, AuditTrail audit) Evaluate this expression using a BeanShell InterpreterExpression.evaluate
(PropertySource ps) Deprecated.Expression.evaluate
(PropertySource ps, boolean localized) Expression.evaluate
(PropertySource ps, boolean localized, Auditable owner, AuditTrail audit) Expression.evaluate
(PropertySource ps, Map<String, String> properties, boolean localized) Expression.evaluate
(PropertySource ps, Map<String, String> properties, boolean localized, Auditable owner, AuditTrail audit) Each subclass must implement evaluate() to evaluate itself The default implementation just returns the expression itself, which works correctly for simple Expression types like NullExpression and IntExpression.Expression.evaluate
(PropertySource ps, Auditable owner, AuditTrail audit) FormattedStringExpression.evaluate
(PropertySource ps, Map<String, String> properties, boolean localized) FormattedStringExpression.evaluate
(PropertySource ps, Map<String, String> properties, boolean localized, Auditable owner, AuditTrail audit) PropertyMatchExpression.evaluate
(PropertySource ps, Map<String, String> properties, boolean localized) Deprecated.SinglePropertyExpression.evaluate
(PropertySource ps, Map<String, String> properties, boolean localized) SinglePropertyExpression.evaluate
(PropertySource ps, Map<String, String> properties, boolean localized, Auditable owner, AuditTrail audit) BeanShellExpression.getFilter
(PropertySource ps) BeanShellExpression.getFilter
(PropertySource ps, Auditable owner, AuditTrail audit) Expression.getFilter
(PropertySource ps) Deprecated.Expression.getFilter
(PropertySource ps, Auditable owner, AuditTrail audit) Return a PieceFilter using the expression.PropertyMatchExpression.getFilter
(PropertySource ps) Deprecated.PropertyMatchExpression.getFilter
(PropertySource ps, Auditable owner, AuditTrail audit) Expression.quietEvaluate
(PropertySource ps, Map<String, String> properties, boolean localized, Auditable owner, AuditTrail audit) A version of tryEvaluate the supresses error messages.Expression.quietEvaluate
(PropertySource ps, Auditable owner, String fieldKey) Expression.tryEvaluate
(PropertySource ps) Deprecated.Expression.tryEvaluate
(PropertySource ps, boolean localized) Expression.tryEvaluate
(PropertySource ps, boolean localized, Auditable owner, AuditTrail audit) Evaluate an expression with data warning support built inExpression.tryEvaluate
(PropertySource ps, Map<String, String> properties, boolean localized) Expression.tryEvaluate
(PropertySource ps, Map<String, String> properties, boolean localized, Auditable owner, AuditTrail audit) Core tryEvaluate implementation.Expression.tryEvaluate
(PropertySource ps, Auditable owner, String fieldKey) Expression.tryEvaluate
(PropertySource ps, Auditable owner, AuditTrail audit) Evaluate an expression with data warning support built in -
Uses of PropertySource in VASSAL.tools
Modifier and TypeMethodDescriptionFormattedString.getLocalizedText
(PropertySource ps) FormattedString.getLocalizedText
(PropertySource ps, Auditable owner, String fieldKey) Evaulate a formatted String and return localized text Use the supplied property source to find property values Create an AuditTrail object if expression auditing enabledFormattedString.getLocalizedText
(PropertySource ps, Auditable owner, String fieldKey, boolean quietly) FormattedString.getLocalizedText
(PropertySource ps, Auditable owner, AuditTrail audit) Evaulate a formatted String and return localized text Use the supplied property source to find property valuesFormattedString.getText
(PropertySource ps) Deprecated.FormattedString.getText
(PropertySource ps, boolean localized) FormattedString.getText
(PropertySource ps, boolean localized, Auditable owner, AuditTrail audit) Evaluate the supplied Formmatted String, using the supplied property source to replace any property references.FormattedString.getText
(PropertySource ps, boolean localized, Auditable owner, AuditTrail audit, boolean quietly) Core implementation of getText.FormattedString.getText
(PropertySource ps, String def) FormattedString.getText
(PropertySource ps, String def, Auditable owner, String fieldKey) Evaulate a formatted String and return unlocalized text Use the supplied property source to find property values If any property value is found to be null, use the supplied default value instead Create an AuditTrail object if expression auditing enabledFormattedString.getText
(PropertySource ps, String def, Auditable owner, AuditTrail audit) Evaulate a formatted String and return unlocalized text Use the supplied property source to find property values If any property value is found to be null, use the supplied default value insteadFormattedString.getText
(PropertySource ps, Auditable owner, String fieldKey) Evaulate a formatted String and return unlocalized text Use the supplied property source to find property values Create an AuditTrail object if expression auditing enabledFormattedString.getText
(PropertySource ps, Auditable owner, String fieldKey, boolean quietly) Evaluate a formatted String and return unlocalized text Use the supplied property source to find property values Create an AuditTrail object if expression auditing enabledFormattedString.getText
(PropertySource ps, Auditable owner, AuditTrail audit) Evaulate a formatted String and return unlocalized text Use the supplied property source to find property valuesint
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.int
FormattedString.getTextAsInt
(PropertySource ps, String description, EditablePiece source, Auditable owner, AuditTrail audit) void
FormattedString.setDefaultProperties
(PropertySource defaultProperties) ModifierConstructorDescriptionFormattedString
(String formatString, PropertySource defaultProperties) FormattedString
(PropertySource defaultProperties)
BeanShellExpression.evaluate(PropertySource, Map, boolean, Auditable, AuditTrail)