Package VASSAL.counters

Class Embellishment

java.lang.Object
VASSAL.search.AbstractImageFinder
VASSAL.counters.Decorator
VASSAL.counters.Embellishment
All Implemented Interfaces:
PropertyNameSource, PropertySource, EditablePiece, GamePiece, PropertyExporter, StateMergeable, TranslatablePiece, PersistentPropertyContainer, Auditable, ImageSearchTarget, SearchTarget, RecursionLimiter.Loopable
public class Embellishment extends Decorator implements TranslatablePiece, RecursionLimiter.Loopable
d/b/a "Layer" The "Layer" trait. Contains a list of images that the user may cycle through. The current image is superimposed over the inner piece. The entire layer may be activated or deactivated. Changes to support NamedKeyStrokes: - Random and reset command changed directly to Name Key Strokes. - Disentangle alwaysActive flag from length of activateKey field. Make a separate field and save in type - Add a Version field to type to enable conversion of Activate/Increase/Decrease commands. Note commands with more than 1 target keycode cannot be converted - Simplify code. Removed Version 0 (3.1) code to a separate class Embellishment0. The BasicCommandEncoder replaces this class with an Embellishment0 if Embellishment(type, inner) returns a version 0 Embellishment trait.

  • Field Details

    • OLD_ID

      public static final String OLD_ID
      See Also:

    • ID

      public static final String ID
      See Also:

    • IMAGE

      public static final String IMAGE
      See Also:

    • NAME

      public static final String NAME
      See Also:

    • LEVEL

      public static final String LEVEL
      See Also:

    • ACTIVE

      public static final String ACTIVE
      See Also:

    • activateKey

      protected String activateKey

    • upKey

      protected String upKey

    • downKey

      protected String downKey

    • activateModifiers

      protected int activateModifiers

    • upModifiers

      protected int upModifiers

    • downModifiers

      protected int downModifiers

    • upCommand

      protected String upCommand

    • downCommand

      protected String downCommand

    • activateCommand

      protected String activateCommand

    • resetCommand

      protected String resetCommand

    • resetLevel

      protected FormattedString resetLevel

    • loopLevels

      protected boolean loopLevels

    • resetKey

      protected NamedKeyStroke resetKey

    • followProperty

      protected boolean followProperty

    • propertyName

      protected String propertyName

    • followPropertyExpression

      protected Expression followPropertyExpression

    • firstLevelValue

      protected int firstLevelValue

    • onlyPropertyName

      protected String onlyPropertyName

    • onlyPropertyState

      protected String onlyPropertyState

    • rndKey

      protected NamedKeyStroke rndKey

    • value

      protected int value

    • nValues

      protected int nValues

    • xOff

      protected int xOff

    • yOff

      protected int yOff

    • imageName

      protected String[] imageName

    • commonName

      protected String[] commonName

    • size

      protected Rectangle[] size

    • imagePainter

      protected ScaledImagePainter[] imagePainter

    • drawUnderneathWhenSelected

      protected boolean drawUnderneathWhenSelected

    • name

      protected String name

    • commands

      protected KeyCommand[] commands

    • up

      protected KeyCommand up

    • down

      protected KeyCommand down

    • lastBounds

      @Deprecated(since="2021-03-14", forRemoval=true) protected Rectangle lastBounds
      Deprecated, for removal: This API element is subject to removal in a future version.

    • lastShape

      @Deprecated(since="2021-03-14", forRemoval=true) protected Area lastShape
      Deprecated, for removal: This API element is subject to removal in a future version.

    • BASE_VERSION

      public static final int BASE_VERSION
      See Also:

    • CURRENT_VERSION

      public static final int CURRENT_VERSION
      See Also:

    • version

      protected int version

    • alwaysActive

      protected boolean alwaysActive

    • activateKeyStroke

      protected NamedKeyStroke activateKeyStroke

    • increaseKeyStroke

      protected NamedKeyStroke increaseKeyStroke

    • decreaseKeyStroke

      protected NamedKeyStroke decreaseKeyStroke

    • description

      protected String description

    • scale

      protected double scale

  • Constructor Details

    • Embellishment

      public Embellishment()

    • Embellishment

      public Embellishment(String type, GamePiece d)

  • Method Details

    • isActive

      public boolean isActive()

    • setActive

      public void setActive(boolean act)

    • getValue

      public int getValue()

    • setValue

      public void setValue(int level)
      Set the current level; Does not change the active status
      Parameters:
      level - 0-based level to set

    • mySetType

      public void mySetType(String s)
      Description copied from interface: EditablePiece
      Sets the information for this piece. See Decorator.myGetType()
      Specified by:
      mySetType in interface EditablePiece
      Parameters:
      s - a serialized configuration string to set the "type information" of this piece, which is information that doesn't change during the course of a single game (e.g. Image Files, Context Menu strings, etc). Typically ready to be processed e.g. by SequenceEncoder.decode()

    • canBeActivated

      public boolean canBeActivated()
      Can this Layer be Activated? Old-style depended on checking if any activation keys where specified. New-stule maintains a separate alwaysActive variable
      Returns:
      true if this layer trait has an activate command

    • getLocalizedName

      public String getLocalizedName()
      Description copied from interface: GamePiece
      And the translated name for this piece
      Specified by:
      getLocalizedName in interface GamePiece
      Overrides:
      getLocalizedName in class Decorator
      Returns:
      the translated name for this piece. Most pieces do not have translatable elements, so just return the standard name

    • getName

      public String getName()
      Description copied from interface: GamePiece
      The plain English name for this piece
      Specified by:
      getName in interface GamePiece

    • getName

      public String getName(boolean localized)

    • getLayerName

      public String getLayerName()
      Return raw Embellishment name
      Returns:
      Embellishment name

    • mySetState

      public void mySetState(String s)
      Description copied from class: Decorator
      Sets the state of this-trait-only (inverse of Decorator.myGetState()). The "state information" is information that can change during the course of a game. State information is saved when the game is saved and is transferred between players on the server. For example, the relative order of pieces in a stack is state information, but whether the stack is expanded is not.
      Specified by:
      mySetState in class Decorator
      Parameters:
      s - New state information serialized in string form, ready to be passed to a SequenceEncoder#decode.

    • myGetType

      public String myGetType()
      Description copied from class: Decorator
      The "type information" of a piece or trait is information that does not change during the course of a game. Image file names, context menu strings, etc., all should be reflected in the type. The type information is returned serialized string form, ready to be decoded by a SequenceEncoder#decode.
      Specified by:
      myGetType in class Decorator
      Returns:
      the type information of this trait alone
      See Also:

    • myGetState

      public String myGetState()
      Description copied from class: Decorator
      The "state information" is "game state" information that can change during the course of a game. State information is saved when the game is saved and is transferred between players on the server. For example, the relative order of pieces in a stack is state information, but whether the stack is expanded is not.
      Specified by:
      myGetState in class Decorator
      Returns:
      the game state information of this trait alone
      See Also:

    • checkProperty

      protected boolean checkProperty(String name)
      Parameters:
      name - Property name
      Returns:
      false only if property name is non-blank/non-null, and property itself is false/0/null (return true otherwise)

    • draw

      public void draw(Graphics g, int x, int y, Component obs, double zoom)
      Description copied from interface: GamePiece
      Draw this GamePiece
      Specified by:
      draw in interface GamePiece
      Parameters:
      g - target Graphics object
      x - x-location of the center of the piece
      y - y-location of the center of the piece
      obs - the Component on which this piece is being drawn
      zoom - the scaling factor.

    • checkPropertyLevel

      protected void checkPropertyLevel()

    • myGetKeyCommands

      public KeyCommand[] myGetKeyCommands()
      Specified by:
      myGetKeyCommands in class Decorator
      Returns:
      the key commands for this trait alone
      See Also:

    • myKeyEvent

      public Command myKeyEvent(KeyStroke stroke)
      Description copied from class: Decorator
      The response of this trait alone to the given KeyStroke or the virtual keystroke of a NamedKeyStroke. NamedKeyStrokes are allocated a unique internal KeyStroke when they are first used in a module, and that KeyStroke is passed up and down the decorator stack to represent them (see NamedKeyStroke.getKeyStroke()).
      Specified by:
      myKeyEvent in class Decorator
      Parameters:
      stroke - KeyStroke to apply (to apply a Named Keystroke send NamedKeyStroke.getKeyStroke()
      Returns:
      Generated Command to reproduce any changes just made to to the game state, or null if no effect
      See Also:

    • doIncrease

      protected void doIncrease()

    • doDecrease

      protected void doDecrease()

    • boundingBox

      public Rectangle boundingBox()
      Specified by:
      boundingBox in interface GamePiece
      Returns:
      The area which this GamePiece occupies when drawn at the point (0,0)

    • getCurrentImageBounds

      public Rectangle getCurrentImageBounds()

    • getShape

      public Shape getShape()
      Return the Shape of the counter by adding the shape of this layer to the shape of all inner traits. Minimize generation of new Area objects.
      Specified by:
      getShape in interface GamePiece
      Returns:
      The shape of the piece from the user's viewpoint. This defines the area in which the user must click to select or move the piece, for example. Like GamePiece.boundingBox(), it assumes the position is (0,0) -- which to be clear is normally aligned with the CENTER of the piece image -- and must be translated to the actual location where the piece is being drawn. For most ordinary pieces, the shape returned here will simply be equivalent to the bounding box, but see NonRectangular.

    • getDescription

      public String getDescription()
      Description copied from interface: EditablePiece
      A plain-English description of this type of trait/piece - includes data from fields where appropriate
      Specified by:
      getDescription in interface EditablePiece

    • getBaseDescription

      public String getBaseDescription()
      Description copied from interface: EditablePiece
      Support for a basic-name-only description introduced later, so this default retrofits it from the full description if an explicit one is not defined.
      Specified by:
      getBaseDescription in interface EditablePiece
      Returns:
      name of trait/piece type, w/o additional data

    • getDescriptionField

      public String getDescriptionField()
      Description copied from class: Decorator
      If Decorator contains a description *field*, returns the current contents of it.
      Overrides:
      getDescriptionField in class Decorator
      Returns:
      contents of "description" field, if it exists.

    • getProperty

      public Object getProperty(Object key)
      Description copied from class: Decorator
      Properties can be associated with a piece -- many may be game-specific, but others are standard, such as the LocationName property exposed by BasicPiece -- and can be read through this interface. The properties may or may not need to be encoded in the piece's Decorator.getState() method. Properties include the value of e.g. Marker Traits, DynamicProperty Traits, and so forth. Furthermore they include the values of any visible "Global Property" in a Vassal module, whether at the module level, map level, or zone level -- but these "higher level" properties, coming from "outside the piece", CANNOT be written to by the Decorator.setProperty(java.lang.Object, java.lang.Object) method even though they can be read by this method -- in this sense the two methods are NOT perfect mirrors.

      Within a Trait/Decorator, default behavior is to process some requests directly (e.g. requests for our "inner" or "outer" link), process our *part* of certain other requests (e.g. request for our game state information we supply state information for this trait and then append any information obtained from passing the same request inward), and then for any other requests that we cannot process we simply pass the request to the next trait/member inward.

      When using this interface a piece's own properties are preferred to those of "Global Properties", and those in turn are searched Zone-first then Map, then Module.

      This method implements the PropertySource interface, which allows Global Properties to be read by other types of object than GamePieces.
      Specified by:
      getProperty in interface GamePiece
      Specified by:
      getProperty in interface PropertySource
      Overrides:
      getProperty in class Decorator
      Parameters:
      key - String key of property to be returned
      Returns:
      Object containing new value of the specified property

    • getLocalizedProperty

      public Object getLocalizedProperty(Object key)
      Description copied from class: Decorator
      Returns a localized translation of the specified property value, if available. Otherwise returns the non-localized version. See Decorator.getProperty(java.lang.Object).
      Specified by:
      getLocalizedProperty in interface PropertySource
      Overrides:
      getLocalizedProperty in class Decorator
      Parameters:
      key - String key of property to be returned
      Returns:
      Object containing localized text of the specified property, if available, otherwise non-localized value

    • strip

      protected String strip(String s)

    • getCommonName

      protected String getCommonName(boolean localized, int i)
      Get the name of this level (alone)

    • getLocalizedCommonName

      protected String getLocalizedCommonName(int i)
      Get the localized name of this level (alone)

    • getExpressionList

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

    • getNamedKeyStrokeList

      public List<NamedKeyStroke> getNamedKeyStrokeList()
      Description copied from class: Decorator
      SearchTarget
      Specified by:
      getNamedKeyStrokeList in interface SearchTarget
      Overrides:
      getNamedKeyStrokeList in class Decorator
      Returns:
      a list of any Named KeyStrokes referenced in the Decorator, if any (for search)

    • getMenuTextList

      public List<String> getMenuTextList()
      Description copied from class: Decorator
      SearchTarget
      Specified by:
      getMenuTextList in interface SearchTarget
      Overrides:
      getMenuTextList in class Decorator
      Returns:
      a list of any Menu Text strings referenced in the Decorator, if any (for search)

    • getFormattedStringList

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

    • getHelpFile

      public HelpFile getHelpFile()
      Specified by:
      getHelpFile in interface EditablePiece
      Returns:
      the help file for this trait

    • getEditor

      public PieceEditor getEditor()
      Specified by:
      getEditor in interface EditablePiece
      Overrides:
      getEditor in class Decorator
      Returns:
      the configurer for this trait - the dialog which allows the editing the piece's type information. Default configurer is a SimplePieceEditor, but many traits will want to provide custom versions.

    • getVersion

      public int getVersion()

    • getLayerWithMatchingActivateCommand

      public static Embellishment getLayerWithMatchingActivateCommand(GamePiece piece, KeyStroke stroke, boolean active)
      If the argument GamePiece contains a Layer whose "activate" command matches the given keystroke, and whose active status matches the boolean argument, return that Layer

    • getLayerWithMatchingActivateCommand

      public static Embellishment getLayerWithMatchingActivateCommand(GamePiece piece, NamedKeyStroke stroke, boolean active)

    • getPropertyNames

      public List<String> getPropertyNames()
      Specified by:
      getPropertyNames in interface PropertyNameSource
      Overrides:
      getPropertyNames in class Decorator
      Returns:
      List of property names "exposed" by this piece -- that are available to other Traits and components to read. Default behavior for a Trait is not to expose any properties, but Traits which should expose some (e.g. DynamicProperty or Marker) would provide an array of the property names here.

    • getPropertyList

      public List<String> getPropertyList()
      Description copied from class: Decorator
      SearchTarget
      Specified by:
      getPropertyList in interface SearchTarget
      Overrides:
      getPropertyList in class Decorator
      Returns:
      a list of any Property Names referenced in the Decorator, if any (for search)

    • testEquals

      public boolean testEquals(Object o)
      Description copied from class: Decorator
      Test if this Decorator's Class, Type and State are equal to another trait. Implementations of this method should compare the individual values of the fields that make up the Decorators Type and State. Implementations should NOT compare the values returned by myGetType() or myGetState(). This method is intended to be used by Unit Tests to verify that a trait is unchanged after going through a process such as serialization/deserialization.
      Overrides:
      testEquals in class Decorator
      Parameters:
      o - Object to compare this Decorator to
      Returns:
      true if the Class, type and state all match

    • getI18nData

      public PieceI18nData getI18nData()
      Description copied from class: Decorator
      Return Internationalization (I18n) data for this piece
      Specified by:
      getI18nData in interface TranslatablePiece
      Overrides:
      getI18nData in class Decorator
      Returns:
      I18n data, used to hold translations of strings

    • addLocalImageNames

      public void addLocalImageNames(Collection<String> s)
      Description copied from class: AbstractImageFinder
      Classes extending AbstractImageFinder should override this method in order to add the names of any image files they use to the collection.
      Specified by:
      addLocalImageNames in interface ImageSearchTarget
      Overrides:
      addLocalImageNames in class AbstractImageFinder
      Parameters:
      s - Collection to add image names to