Package VASSAL.counters
Interface Properties
public interface Properties
Defines the properties expected to be defined in each GamePiece
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringIf non-null, then return an instance ofEventFilter.static final StringIf a piece is hidden to other players, return a STring identifying the player who hit itstatic final StringReturn Boolean.TRUE if the piece should ignore map grids when being movedstatic final StringIf this piece is a Decorator, return the decorated piecestatic final Stringstatic final StringReturn Boolean.TRUE if the piece cannot be seen by the userstatic final Stringstatic final StringReturn a KeyCommand[] object representing the popup menu equivalencies for the key commands recognized by this piecestatic final StringWrite-only -- sets MOVED but only if ignore-same-location isn't checked in the traitstatic final StringIf non-null, then return an instance ofEventFilter.static final StringReturn Boolean.TRUE if this piece has been movedstatic final StringReturn Boolean.TRUE if the piece does not form stacksstatic final StringReturn Boolean.TRUE if the piece can never be movedstatic final StringIf a piece is obscured to other players, return a String identifying the player who obscured itstatic final StringIn 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 StringReturn Boolean.TRUE if the piece's identity is not known to the userstatic final StringReturn Boolean.TRUE if the piece's identity is not known to other playersstatic final StringIf this piece decorated by a Decorator, return the Decoratorstatic final StringGlobal Piece Idstatic final StringReturn Boolean.TRUE if this piece has Restricted Accessstatic final StringReturn Boolean.TRUE if this piece has movement restricted by a Restricted Access traitstatic final StringIf non-null, then return an instance ofEventFilter.static final StringReturn Boolean.TRUE if the piece has been marked as selectedstatic final StringUsed to store a duplicate of the target piece at some point in timestatic final StringReturn Boolean.TRUE if the piece behaves more like a terrain feature than a playing piecestatic final StringIf Boolean.TRUE, then treat the piece as if it were not rotated.static final StringReturn a String representing the visible features of the piece.
-
Field Details
-
INVISIBLE_TO_ME
Return Boolean.TRUE if the piece cannot be seen by the user- See Also:
-
INVISIBLE_TO_OTHERS
- See Also:
-
INVISIBLE_DISABLE_AUTO_REPORT_MOVE
- See Also:
-
OBSCURED_TO_OTHERS
Return Boolean.TRUE if the piece's identity is not known to other players- See Also:
-
OBSCURED_TO_ME
Return Boolean.TRUE if the piece's identity is not known to the user- See Also:
-
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
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
If non-null, then return an instance ofEventFilter. The piece will not respond to band-select events if the filter rejects them- See Also:
-
SELECT_EVENT_FILTER
If non-null, then return an instance ofEventFilter. The piece will not respond to selection events if the filter rejects them- See Also:
-
MOVE_EVENT_FILTER
If non-null, then return an instance ofEventFilter. The piece will not respond to move events if the filter rejects them- See Also:
-
HIDDEN_BY
If a piece is hidden to other players, return a STring identifying the player who hit it- See Also:
-
TERRAIN
Return Boolean.TRUE if the piece behaves more like a terrain feature than a playing piece- See Also:
-
IGNORE_GRID
Return Boolean.TRUE if the piece should ignore map grids when being moved- See Also:
-
NO_STACK
-
SELECTED
-
KEY_COMMANDS
Return a KeyCommand[] object representing the popup menu equivalencies for the key commands recognized by this piece- See Also:
-
INNER
-
OUTER
-
RESTRICTED
-
RESTRICTED_MOVEMENT
Return Boolean.TRUE if this piece has movement restricted by a Restricted Access trait- See Also:
-
MOVED
-
MAYBE_MOVED
Write-only -- sets MOVED but only if ignore-same-location isn't checked in the trait- See Also:
-
SNAPSHOT
Used to store a duplicate of the target piece at some point in time- See Also:
-
USE_UNROTATED_SHAPE
If Boolean.TRUE, then treat the piece as if it were not rotated. This effects the value returned byGamePiece.getShape()and the way the piece is drawn.- See Also:
-
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
-
PIECE_ID
-