Package VASSAL.counters
Class GlobalCommandTarget
java.lang.Object
VASSAL.counters.GlobalCommandTarget
- All Implemented Interfaces:
ConfigurerFactory
,SearchTarget
GlobalCommandTarget configures and stores the "Fast Match" parameters of Global Key Commands, allowing certain
simple filters to be "pre-matched" without having to initiate the (relatively slower) BeanShell filters.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Comparison Modes for property matchstatic class
Specifies the type of GKC being configured (affects which Target options are allowed)static class
Specifies the kind of target matching -
Field Summary
Modifier and TypeFieldDescriptionprotected static char
protected boolean
protected boolean
protected GlobalCommandTarget.GKCtype
protected Expression
protected GlobalCommandTarget.CompareMode
protected Expression
protected Expression
protected Expression
protected Expression
protected GlobalCommandTarget.Target
protected Expression
protected Expression
protected Expression
protected Expression
-
Constructor Summary
ConstructorDescription -
Method Summary
Modifier and TypeMethodDescriptionvoid
Decoder for loading GlobalCommandTarget from the module XMLencode()
Encoder for the part of GlobalCommandTarget that gets stored in the moduleboolean
Compares two GlobalCommandTargetsgetConfigurer(AutoConfigurable c, String key, String name)
boolean
boolean
void
setCurPiece(GamePiece curPiece)
void
setFastMatchLocation(boolean fastMatchLocation)
void
setFastMatchProperty(boolean fastMatchProperty)
void
setGKCtype(GlobalCommandTarget.GKCtype gkcType)
void
setTargetBoard(String targetBoard)
void
setTargetBoard(Expression targetBoard)
void
setTargetCompare(String targetCompare)
void
setTargetCompare(GlobalCommandTarget.CompareMode targetCompare)
void
setTargetDeck(String targetDeck)
void
setTargetDeck(Expression targetDeck)
void
setTargetLocation(String targetLocation)
void
setTargetLocation(Expression targetLocation)
void
setTargetMap(String targetMap)
void
setTargetMap(Expression targetMap)
void
setTargetProperty(String targetProperty)
void
setTargetProperty(Expression targetProperty)
void
setTargetType(String targetType)
void
setTargetType(GlobalCommandTarget.Target targetType)
void
setTargetValue(String targetValue)
void
setTargetValue(Expression targetValue)
void
setTargetX(int targetX)
void
setTargetX(String targetX)
void
setTargetX(Expression targetX)
void
setTargetY(int targetY)
void
setTargetY(String targetY)
void
setTargetY(Expression targetY)
void
setTargetZone(String targetZone)
void
setTargetZone(Expression targetZone)
-
Field Details
-
ENCODE_DELIMITER
protected static final char ENCODE_DELIMITER- See Also:
- Constant Field Values
-
gkcType
-
fastMatchLocation
protected boolean fastMatchLocation -
targetType
-
targetMap
-
targetBoard
-
targetZone
-
targetLocation
-
targetDeck
-
targetX
-
targetY
-
fastMatchProperty
protected boolean fastMatchProperty -
targetProperty
-
targetValue
-
targetCompare
-
-
Constructor Details
-
GlobalCommandTarget
public GlobalCommandTarget() -
GlobalCommandTarget
-
GlobalCommandTarget
-
GlobalCommandTarget
-
-
Method Details
-
getConfigurer
- Specified by:
getConfigurer
in interfaceConfigurerFactory
-
encode
Encoder for the part of GlobalCommandTarget that gets stored in the module- Returns:
- Fast Match parameters encoded in string form
-
decode
Decoder for loading GlobalCommandTarget from the module XML- Parameters:
code
- String to decode into our fields.
-
equals
Compares two GlobalCommandTargets -
getExpressionList
- Specified by:
getExpressionList
in interfaceSearchTarget
- Returns:
- a list of the item's string/expression fields if any (for search)
-
getFormattedStringList
- Specified by:
getFormattedStringList
in interfaceSearchTarget
- Returns:
- a list of any Message Format strings referenced in the item, if any (for search)
-
getMenuTextList
- Specified by:
getMenuTextList
in interfaceSearchTarget
- Returns:
- a list of any Menu/Button/Tooltip Text strings referenced in the item, if any (for search)
-
getNamedKeyStrokeList
- Specified by:
getNamedKeyStrokeList
in interfaceSearchTarget
- Returns:
- a list of any Named KeyStrokes referenced in the item, if any (for search)
-
getPropertyList
- Specified by:
getPropertyList
in interfaceSearchTarget
- Returns:
- a list of any Property Names referenced in the item, if any (for search)
-
getGKCtype
-
setGKCtype
-
isFastMatchLocation
public boolean isFastMatchLocation() -
setFastMatchLocation
public void setFastMatchLocation(boolean fastMatchLocation) -
isFastMatchProperty
public boolean isFastMatchProperty() -
setFastMatchProperty
public void setFastMatchProperty(boolean fastMatchProperty) -
getTargetType
-
setTargetType
-
setTargetType
-
getTargetMap
-
setTargetMap
-
setTargetMap
-
getTargetBoard
-
setTargetBoard
-
setTargetBoard
-
getTargetZone
-
setTargetZone
-
setTargetZone
-
getTargetLocation
-
setTargetLocation
-
setTargetLocation
-
getTargetDeck
-
setTargetDeck
-
setTargetDeck
-
getTargetProperty
-
setTargetProperty
-
setTargetProperty
-
getTargetValue
-
setTargetValue
-
setTargetValue
-
getTargetCompare
-
setTargetCompare
-
setTargetCompare
-
getTargetX
-
setTargetX
-
setTargetX
-
setTargetX
public void setTargetX(int targetX) -
getTargetY
-
setTargetY
-
setTargetY
-
setTargetY
public void setTargetY(int targetY) -
setCurPiece
-
getCurPiece
-