Package VASSAL.counters
Interface Properties
public interface Properties
Defines the properties expected to be defined in each GamePiece
-
Field Summary
Modifier and TypeFieldDescriptionstatic String
If non-null, then return an instance ofEventFilter
.static String
If a piece is hidden to other players, return a STring identifying the player who hit itstatic String
Return Boolean.TRUE if the piece should ignore map grids when being movedstatic String
If this piece is a Decorator, return the decorated piecestatic String
Return Boolean.TRUE if the piece cannot be seen by the userstatic String
static String
Return a KeyCommand[] object representing the popup menu equivalencies for the key commands recognized by this piecestatic String
If non-null, then return an instance ofEventFilter
.static String
Return Boolean.TRUE if this piece has been movedstatic String
Return Boolean.TRUE if the piece does not form stacksstatic String
Return Boolean.TRUE if the piece can never be movedstatic String
If a piece is obscured to other players, return a String identifying the player who obscured itstatic String
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 String
Return Boolean.TRUE if the piece's identity is not known to the userstatic String
Return Boolean.TRUE if the piece's identity is not known to other playersstatic String
If this piece decorated by a Decorator, return the Decoratorstatic String
Global Piece Idstatic String
Return Boolean.TRUE if this piece has Restricted Accessstatic String
Return Boolean.TRUE if this piece has movement restricted by a Restricted Access traitstatic String
If non-null, then return an instance ofEventFilter
.static String
Return Boolean.TRUE if the piece has been marked as selectedstatic String
Used to store a duplicate of the target piece at some point in timestatic String
Return Boolean.TRUE if the piece behaves more like a terrain feature than a playing piecestatic String
If Boolean.TRUE, then treat the piece as if it were not rotated.static String
Return 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:
- Constant Field Values
-
INVISIBLE_TO_OTHERS
- See Also:
- Constant Field Values
-
OBSCURED_TO_OTHERS
Return Boolean.TRUE if the piece's identity is not known to other players- See Also:
- Constant Field Values
-
OBSCURED_TO_ME
Return Boolean.TRUE if the piece's identity is not known to the user- See Also:
- Constant Field Values
-
OBSCURED_BY
If a piece is obscured to other players, return a String identifying the player who obscured it- See Also:
GameModule.getUserId()
, Constant Field Values
-
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:
- Constant Field Values
-
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:
- Constant Field Values
-
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:
- Constant Field Values
-
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:
- Constant Field Values
-
HIDDEN_BY
If a piece is hidden to other players, return a STring identifying the player who hit it- See Also:
GameModule.getUserId()
, Constant Field Values
-
TERRAIN
Return Boolean.TRUE if the piece behaves more like a terrain feature than a playing piece- See Also:
- Constant Field Values
-
IGNORE_GRID
Return Boolean.TRUE if the piece should ignore map grids when being moved- See Also:
- Constant Field Values
-
NO_STACK
Return Boolean.TRUE if the piece does not form stacks- See Also:
- Constant Field Values
-
SELECTED
Return Boolean.TRUE if the piece has been marked as selected- See Also:
- Constant Field Values
-
KEY_COMMANDS
Return a KeyCommand[] object representing the popup menu equivalencies for the key commands recognized by this piece- See Also:
- Constant Field Values
-
INNER
If this piece is a Decorator, return the decorated piece- See Also:
- Constant Field Values
-
OUTER
If this piece decorated by a Decorator, return the Decorator- See Also:
- Constant Field Values
-
RESTRICTED
Return Boolean.TRUE if this piece has Restricted Access- See Also:
- Constant Field Values
-
RESTRICTED_MOVEMENT
Return Boolean.TRUE if this piece has movement restricted by a Restricted Access trait- See Also:
- Constant Field Values
-
MOVED
Return Boolean.TRUE if this piece has been moved- See Also:
- Constant Field Values
-
SNAPSHOT
Used to store a duplicate of the target piece at some point in time- See Also:
- Constant Field Values
-
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:
FreeRotator
, Constant Field Values
-
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:
- Constant Field Values
-
NON_MOVABLE
Return Boolean.TRUE if the piece can never be moved- See Also:
- Constant Field Values
-
PIECE_ID
Global Piece Id- See Also:
- Constant Field Values
-