Uses of Interface
VASSAL.build.module.properties.PropertySource
Packages that use 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
Classes in VASSAL.build that implement PropertySourceModifier and TypeClassDescriptionclassThe GameModule class is the base class for a VASSAL module. -
Uses of PropertySource in VASSAL.build.module
Classes in VASSAL.build.module that implement PropertySourceModifier and TypeClassDescriptionclassHolds static information of and a reference to a gamepiece.classThe Map is the main component for displaying and containingGamePieces during play.classclassA Map that may be configured to be visible only a particular side.Methods in VASSAL.build.module with parameters of type PropertySourceModifier 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
Classes in VASSAL.build.module.map that implement PropertySourceFields in VASSAL.build.module.map declared as PropertySourceModifier and TypeFieldDescriptionprotected PropertySourceMassKeyCommand.propertySourceprotected PropertySourceDrawPile.sourceMethods in VASSAL.build.module.map with parameters of type PropertySourceConstructors in VASSAL.build.module.map with parameters of type PropertySource -
Uses of PropertySource in VASSAL.build.module.map.boardPicker.board.mapgrid
Classes in VASSAL.build.module.map.boardPicker.board.mapgrid that implement PropertySource -
Uses of PropertySource in VASSAL.build.module.properties
Subinterfaces of PropertySource in VASSAL.build.module.propertiesModifier and TypeInterfaceDescriptionstatic interfacestatic interfaceClasses in VASSAL.build.module.properties that implement PropertySourceModifier and TypeClassDescriptionclassclassclassAdds a toolbar button that changes the value of a global propertyclassDummy component that acts as a simple container for GlobalProperty componentsclassAdds a global property to a Map or ModuleclassAdds a global property to a Map or ModuleclassDummy component that acts as a simple container for GlobalProperty componentsclassclassclassclassFor property names of the form sum(name), returns the value of the named property summed over a list of pieces.classFields in VASSAL.build.module.properties declared as PropertySourceModifier and TypeFieldDescriptionprotected PropertySourceGlobalProperty.propertySourceprotected PropertySourceGlobalTranslatableMessage.propertySourceprotected PropertySourceRemoteIncrementProperty.targetPropertySourceMethods in VASSAL.build.module.properties that return PropertySourceModifier and TypeMethodDescriptionChangePropertyButton.getPropertySource()IncrementProperty.Constraints.getPropertySource()PropertyPrompt.Constraints.getPropertySource()IncrementProperty.getTargetPropertySource()RemoteIncrementProperty.getTargetPropertySource()Methods in VASSAL.build.module.properties with parameters of type PropertySourceModifier 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
Classes in VASSAL.build.widget that implement PropertySource -
Uses of PropertySource in VASSAL.configure
Methods in VASSAL.configure with parameters of type PropertySourceModifier and TypeMethodDescriptionbooleanPropertyExpression.accept(PropertySource source, GamePiece piece) booleanPropertyExpression.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) booleanPropertyExpression.isTrue(PropertySource ps) Evaluate the Property Expression as true/false using a supplied property sourcebooleanPropertyExpression.isTrue(PropertySource ps, Auditable owner, AuditTrail audit) -
Uses of PropertySource in VASSAL.counters
Subinterfaces of PropertySource in VASSAL.countersModifier and TypeInterfaceDescriptioninterfaceIf class implementing GamePiece also implements the EditablePiece interface, then it can be manipulated from the Editor's Configuration Tree via thePieceDefinerdialog.interfaceInterface to deal with the behaviors of a physical component of the game, or a Trait of one.interfaceInterface for classes that can export the names and values of the properties they maintainClasses in VASSAL.counters that implement PropertySourceModifier and TypeClassDescriptionclassA Trait (akaDecoratorthat acts like a button on a GamePiece, such that clicking on a particular area of the piece invokes a key commandclassclassTrait 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)classThis 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.classBasic class for representing a physical component of the game.classTrait to draw a colored border around a piececlassConditional Marker A marker with a variable value depending on conditions.classThis trait adds a command that creates a duplicate of the selected GamepiececlassA trait that exists in a Piece Definition, but is not included when the piece is created in a real game.classTrait that sends a Key Command to other pieces, selected with various filters.classA collection of pieces that behaves like a deck, i.e.: Doesn't move.classThe abstract class describing a generic 'Trait' of a full GamePiece.classThis trait adds a command that creates a duplicate of the selected GamepiececlassImplements a trait to allow a piece to be deselected from the KeyBuffer in response to a Key Command.classTrait that contains a property accessible via getProperty() and updatable dynamically via key commandsclassd/b/a "Layer" The "Layer" trait.classEmbellishment has been extensively re-written for Vassal 3.2 changing both the behavior and the visual look of the configurer.classDisplays a movement trail indicating where a piece has been movedclassd/b/a "Can Rotate" A Decorator that rotates a GamePiece to an arbitrary angleclassAdds a menu entry that fires a specified key event to the module window.classclassd/b/a "Does Not Stack" Decorator that filters events to prevent a GamePiece from being selected and/or moved.classd/b/a "Text Label" Displays a text label, with content specified by the user at runtime.classA generic Decorator that retains in its state the value of a property.classDesignates the piece as a "Mat" on which other pieces ("Cargo") can be placed.classDesignates the piece as "Cargo", which can be placed on a "Mat" to move along with itclassThis trait puts a menu separator bar in the context menu for the piececlassd/b/a "Mark When Moved" A GamePiece with this trait will automatically be marked whenever it is moved.classAllows a single trait to generate multiple context menu commands, using a set of filtered map locations.classA trait for assigning an arbitrary shape to aGamePiececlassd/b/a "Mask" Trait that lets some traits of a piece be hidden "from some players, some of the time".classd/b/a "Can Pivot" Provides commands to pivot a Game Piece around a given pointclassThis Decorator defines a key command to places another counter on top of this one.classA trait that plays a sound clipclassA Decorator class that endows a GamePiece with a dialog.classGamePiece trait that replaces a GamePiece with another oneclassd/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 classLooks in both the new and old piece for property values.classRestrictCommands Restrict the availability of Key Commands, depending on a Property Match String.classd/b/a "Restricted Access" A GamePiece with the Restricted trait can only be manipulated by the player playing a specific sideclassGamePiece trait that returns a piece to aDrawPileclassThis trait adds a command that sends a piece to another location.classclassclassA Stack is a collection of pieces in the same location that can often be moved with a single drag-and-drop.classA trait that groups menu items of other traits into a sub-menuclassd/b/a "Spreadsheet" A Decorator class that endows a GamePiece with an editable spreadsheet (i.e.classA trait to expose a translated string as a readable/displayable property.classd/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.classMacro Execute a series of Keystrokes against this same piece - Triggered by own KeyCommand or list of keystrokes - Match against an optional Property Filterclassd/b/a "Prototype" This trait is a placeholder for a pre-defined series of traits specified in aPrototypeDefinitionobject.Fields in VASSAL.counters declared as PropertySourceModifier and TypeFieldDescriptionprotected PropertySourceDeck.propertySourceprotected PropertySourceGlobalCommand.sourceMethods in VASSAL.counters that return PropertySourceModifier and TypeMethodDescriptionDynamicProperty.getPropertySource()GlobalCommand.getPropertySource()Methods in VASSAL.counters with parameters of type PropertySourceModifier and TypeMethodDescriptionstatic SendToLocation.DestinationSendToLocation.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 CommandDecorator.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 CommandDecorator.setDynamicProperties(List<Parameter> parameters, GamePiece piece, PropertySource source, Auditable owner, AuditTrail auditSoFar) static CommandDecorator.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 valuevoidDeck.setPropertySource(PropertySource source) Sets the Deck's property sourcevoidGlobalCommand.setPropertySource(PropertySource ps) Constructors in VASSAL.counters with parameters of type PropertySourceModifierConstructorDescriptionDeck(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
Subinterfaces of PropertySource in VASSAL.i18nModifier and TypeInterfaceDescriptioninterfaceDecorators that contain localizable elements must implement this interface -
Uses of PropertySource in VASSAL.launch
Classes in VASSAL.launch that implement PropertySourceModifier and TypeClassDescriptionclassDeprecated, 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 PropertySourceMethods in VASSAL.script with parameters of type PropertySourceModifier 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
Methods in VASSAL.script.expression with parameters of type PropertySourceModifier 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
Methods in VASSAL.tools that return PropertySourceMethods in VASSAL.tools with parameters of type PropertySourceModifier 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, 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) 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, AuditTrail audit) Evaulate a formatted String and return unlocalized text Use the supplied property source to find property valuesintFormattedString.getTextAsInt(PropertySource ps, String description, AbstractConfigurable source) intFormattedString.getTextAsInt(PropertySource ps, String description, EditablePiece source) Expand a FormattedString using the supplied propertySource and parse it as an integer.intFormattedString.getTextAsInt(PropertySource ps, String description, EditablePiece source, Auditable owner, AuditTrail audit) voidFormattedString.setDefaultProperties(PropertySource defaultProperties) Constructors in VASSAL.tools with parameters of type PropertySourceModifierConstructorDescriptionFormattedString(String formatString, PropertySource defaultProperties) FormattedString(PropertySource defaultProperties)
BeanShellExpression.evaluate(PropertySource, Map, boolean, Auditable, AuditTrail)