Package VASSAL.counters

Interface Properties

public interface Properties
Defines the properties expected to be defined in each GamePiece

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    BAND_SELECT_EVENT_FILTER
    If non-null, then return an instance of EventFilter.
    static final String
    HIDDEN_BY
    If a piece is hidden to other players, return a STring identifying the player who hit it
    static final String
    IGNORE_GRID
    Return Boolean.TRUE if the piece should ignore map grids when being moved
    static final String
    INNER
    If this piece is a Decorator, return the decorated piece
    static final String
    INVISIBLE_DISABLE_AUTO_REPORT_MOVE
     
    static final String
    INVISIBLE_TO_ME
    Return Boolean.TRUE if the piece cannot be seen by the user
    static final String
    INVISIBLE_TO_OTHERS
     
    static final String
    KEY_COMMANDS
    Return a KeyCommand[] object representing the popup menu equivalencies for the key commands recognized by this piece
    static final String
    MAYBE_MOVED
    Write-only -- sets MOVED but only if ignore-same-location isn't checked in the trait
    static final String
    MOVE_EVENT_FILTER
    If non-null, then return an instance of EventFilter.
    static final String
    MOVED
    Return Boolean.TRUE if this piece has been moved
    static final String
    NO_STACK
    Return Boolean.TRUE if the piece does not form stacks
    static final String
    NON_MOVABLE
    Return Boolean.TRUE if the piece can never be moved
    static final String
    OBSCURED_BY
    If a piece is obscured to other players, return a String identifying the player who obscured it
    static final String
    OBSCURED_BY_PRE_DRAW
    In order to maintain Legacy support after the fix of bug 12951, we need to save the Obscured state prior to cards being drawn, let it be changed in the draw process, then restore it afterwards.
    static final String
    OBSCURED_TO_ME
    Return Boolean.TRUE if the piece's identity is not known to the user
    static final String
    OBSCURED_TO_OTHERS
    Return Boolean.TRUE if the piece's identity is not known to other players
    static final String
    OUTER
    If this piece decorated by a Decorator, return the Decorator
    static final String
    PIECE_ID
    Global Piece Id
    static final String
    RESTRICTED
    Return Boolean.TRUE if this piece has Restricted Access
    static final String
    RESTRICTED_MOVEMENT
    Return Boolean.TRUE if this piece has movement restricted by a Restricted Access trait
    static final String
    SELECT_EVENT_FILTER
    If non-null, then return an instance of EventFilter.
    static final String
    SELECTED
    Return Boolean.TRUE if the piece has been marked as selected
    static final String
    SNAPSHOT
    Used to store a duplicate of the target piece at some point in time
    static final String
    TERRAIN
    Return Boolean.TRUE if the piece behaves more like a terrain feature than a playing piece
    static final String
    USE_UNROTATED_SHAPE
    If Boolean.TRUE, then treat the piece as if it were not rotated.
    static final String
    VISIBLE_STATE
    Return a String representing the visible features of the piece.

  • Field Details

    • INVISIBLE_TO_ME

      static final String INVISIBLE_TO_ME
      Return Boolean.TRUE if the piece cannot be seen by the user
      See Also:

    • INVISIBLE_TO_OTHERS

      static final String INVISIBLE_TO_OTHERS
      See Also:

    • INVISIBLE_DISABLE_AUTO_REPORT_MOVE

      static final String INVISIBLE_DISABLE_AUTO_REPORT_MOVE
      See Also:

    • OBSCURED_TO_OTHERS

      static final String OBSCURED_TO_OTHERS
      Return Boolean.TRUE if the piece's identity is not known to other players
      See Also:

    • OBSCURED_TO_ME

      static final String OBSCURED_TO_ME
      Return Boolean.TRUE if the piece's identity is not known to the user
      See Also:

    • OBSCURED_BY

      static final String OBSCURED_BY
      If a piece is obscured to other players, return a String identifying the player who obscured it
      See Also:

    • OBSCURED_BY_PRE_DRAW

      static final String OBSCURED_BY_PRE_DRAW
      In order to maintain Legacy support after the fix of bug 12951, we need to save the Obscured state prior to cards being drawn, let it be changed in the draw process, then restore it afterwards. Don't ask.
      See Also:

    • BAND_SELECT_EVENT_FILTER

      static final String BAND_SELECT_EVENT_FILTER
      If non-null, then return an instance of EventFilter. The piece will not respond to band-select events if the filter rejects them
      See Also:

    • SELECT_EVENT_FILTER

      static final String SELECT_EVENT_FILTER
      If non-null, then return an instance of EventFilter. The piece will not respond to selection events if the filter rejects them
      See Also:

    • MOVE_EVENT_FILTER

      static final String MOVE_EVENT_FILTER
      If non-null, then return an instance of EventFilter. The piece will not respond to move events if the filter rejects them
      See Also:

    • HIDDEN_BY

      static final String HIDDEN_BY
      If a piece is hidden to other players, return a STring identifying the player who hit it
      See Also:

    • TERRAIN

      static final String TERRAIN
      Return Boolean.TRUE if the piece behaves more like a terrain feature than a playing piece
      See Also:

    • IGNORE_GRID

      static final String IGNORE_GRID
      Return Boolean.TRUE if the piece should ignore map grids when being moved
      See Also:

    • NO_STACK

      static final String NO_STACK
      Return Boolean.TRUE if the piece does not form stacks
      See Also:

    • SELECTED

      static final String SELECTED
      Return Boolean.TRUE if the piece has been marked as selected
      See Also:

    • KEY_COMMANDS

      static final String KEY_COMMANDS
      Return a KeyCommand[] object representing the popup menu equivalencies for the key commands recognized by this piece
      See Also:

    • INNER

      static final String INNER
      If this piece is a Decorator, return the decorated piece
      See Also:

    • OUTER

      static final String OUTER
      If this piece decorated by a Decorator, return the Decorator
      See Also:

    • RESTRICTED

      static final String RESTRICTED
      Return Boolean.TRUE if this piece has Restricted Access
      See Also:

    • RESTRICTED_MOVEMENT

      static final String RESTRICTED_MOVEMENT
      Return Boolean.TRUE if this piece has movement restricted by a Restricted Access trait
      See Also:

    • MOVED

      static final String MOVED
      Return Boolean.TRUE if this piece has been moved
      See Also:

    • MAYBE_MOVED

      static final String MAYBE_MOVED
      Write-only -- sets MOVED but only if ignore-same-location isn't checked in the trait
      See Also:

    • SNAPSHOT

      static final String SNAPSHOT
      Used to store a duplicate of the target piece at some point in time
      See Also:

    • USE_UNROTATED_SHAPE

      static final String USE_UNROTATED_SHAPE
      If Boolean.TRUE, then treat the piece as if it were not rotated. This effects the value returned by GamePiece.getShape() and the way the piece is drawn.
      See Also:

    • VISIBLE_STATE

      static final String VISIBLE_STATE
      Return a String representing the visible features of the piece. If this String changes value, then the piece should be refreshed
      See Also:

    • NON_MOVABLE

      static final String NON_MOVABLE
      Return Boolean.TRUE if the piece can never be moved
      See Also:

    • PIECE_ID

      static final String PIECE_ID
      Global Piece Id
      See Also: