Package VASSAL.counters

Class GlobalCommandTarget

java.lang.Object
VASSAL.counters.GlobalCommandTarget
All Implemented Interfaces:
ConfigurerFactory, SearchTarget
public class GlobalCommandTarget
extends Object
implements 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.

  • Field Details

  • Constructor Details

    • GlobalCommandTarget

      public GlobalCommandTarget()

    • GlobalCommandTarget

      public GlobalCommandTarget​(GlobalCommandTarget.GKCtype gkc)

    • GlobalCommandTarget

      public GlobalCommandTarget​(String s)

    • GlobalCommandTarget

      public GlobalCommandTarget​(GlobalCommandTarget gc)

  • Method Details

    • getConfigurer

      public Configurer getConfigurer​(AutoConfigurable c, String key, String name)
      Specified by:
      getConfigurer in interface ConfigurerFactory

    • encode

      public String encode()
      Encoder for the part of GlobalCommandTarget that gets stored in the module
      Returns:
      Fast Match parameters encoded in string form

    • decode

      public void decode​(String code)
      Decoder for loading GlobalCommandTarget from the module XML
      Parameters:
      code - String to decode into our fields.

    • equals

      public boolean equals​(Object o)
      Compares two GlobalCommandTargets
      Overrides:
      equals in class Object
      Parameters:
      o - GlobalCommandTarget to compare to this one
      Returns:
      true if their meaningful parts are equal

    • getExpressionList

      public List<String> getExpressionList()
      Specified by:
      getExpressionList in interface SearchTarget
      Returns:
      a list of the item's string/expression fields if any (for search)

    • getFormattedStringList

      public List<String> getFormattedStringList()
      Specified by:
      getFormattedStringList in interface SearchTarget
      Returns:
      a list of any Message Format strings referenced in the item, if any (for search)

    • getMenuTextList

      public List<String> getMenuTextList()
      Specified by:
      getMenuTextList in interface SearchTarget
      Returns:
      a list of any Menu/Button/Tooltip Text strings referenced in the item, if any (for search)

    • getNamedKeyStrokeList

      public List<NamedKeyStroke> getNamedKeyStrokeList()
      Specified by:
      getNamedKeyStrokeList in interface SearchTarget
      Returns:
      a list of any Named KeyStrokes referenced in the item, if any (for search)

    • getPropertyList

      public List<String> getPropertyList()
      Specified by:
      getPropertyList in interface SearchTarget
      Returns:
      a list of any Property Names referenced in the item, if any (for search)

    • getGKCtype

      public GlobalCommandTarget.GKCtype getGKCtype()

    • setGKCtype

      public void setGKCtype​(GlobalCommandTarget.GKCtype gkcType)

    • isFastMatchLocation

      public boolean isFastMatchLocation()

    • setFastMatchLocation

      public void setFastMatchLocation​(boolean fastMatchLocation)

    • isFastMatchProperty

      public boolean isFastMatchProperty()

    • setFastMatchProperty

      public void setFastMatchProperty​(boolean fastMatchProperty)

    • getTargetType

      public GlobalCommandTarget.Target getTargetType()

    • setTargetType

      public void setTargetType​(GlobalCommandTarget.Target targetType)

    • setTargetType

      public void setTargetType​(String targetType)

    • getTargetMap

      public Expression getTargetMap()

    • setTargetMap

      public void setTargetMap​(Expression targetMap)

    • setTargetMap

      public void setTargetMap​(String targetMap)

    • getTargetBoard

      public Expression getTargetBoard()

    • setTargetBoard

      public void setTargetBoard​(Expression targetBoard)

    • setTargetBoard

      public void setTargetBoard​(String targetBoard)

    • getTargetZone

      public Expression getTargetZone()

    • setTargetZone

      public void setTargetZone​(Expression targetZone)

    • setTargetZone

      public void setTargetZone​(String targetZone)

    • getTargetLocation

      public Expression getTargetLocation()

    • setTargetLocation

      public void setTargetLocation​(Expression targetLocation)

    • setTargetLocation

      public void setTargetLocation​(String targetLocation)

    • getTargetDeck

      public Expression getTargetDeck()

    • setTargetDeck

      public void setTargetDeck​(Expression targetDeck)

    • setTargetDeck

      public void setTargetDeck​(String targetDeck)

    • getTargetProperty

      public Expression getTargetProperty()

    • setTargetProperty

      public void setTargetProperty​(Expression targetProperty)

    • setTargetProperty

      public void setTargetProperty​(String targetProperty)

    • getTargetValue

      public Expression getTargetValue()

    • setTargetValue

      public void setTargetValue​(Expression targetValue)

    • setTargetValue

      public void setTargetValue​(String targetValue)

    • getTargetCompare

      public GlobalCommandTarget.CompareMode getTargetCompare()

    • setTargetCompare

      public void setTargetCompare​(GlobalCommandTarget.CompareMode targetCompare)

    • setTargetCompare

      public void setTargetCompare​(String targetCompare)

    • getTargetX

      public Expression getTargetX()

    • setTargetX

      public void setTargetX​(Expression targetX)

    • setTargetX

      public void setTargetX​(String targetX)

    • setTargetX

      public void setTargetX​(int targetX)

    • getTargetY

      public Expression getTargetY()

    • setTargetY

      public void setTargetY​(Expression targetY)

    • setTargetY

      public void setTargetY​(String targetY)

    • setTargetY

      public void setTargetY​(int targetY)

    • setCurPiece

      public void setCurPiece​(GamePiece curPiece)

    • getCurPiece

      public GamePiece getCurPiece()