VASSAL.counters
Interface Properties

public interface Properties

Defines the properties expected to be defined in each GamePiece

Field Summary

static java.lang.String	EVENT_FILTER If non-null, then return an instance of EventFilter.
static java.lang.String	HIDDEN_BY If a piece is hidden to other players, return a STring identifying the player who hit it
static java.lang.String	IGNORE_GRID Return Boolean.TRUE if the piece should ignore map grids when being moved
static java.lang.String	INNER If this piece is a Decorator, return the decorated piece
static java.lang.String	INVISIBLE_TO_ME Return Boolean.TRUE if the piece cannot be seen by the user
static java.lang.String	INVISIBLE_TO_OTHERS
static java.lang.String	KEY_COMMANDS Return a KeyCommand[] object representing the popup menu equivalencies for the key commands recognized by this piece
static java.lang.String	MOVED Return Boolean.TRUE if this piece has been moved
static java.lang.String	NO_STACK Return Boolean.TRUE if the piece does not form stacks
static java.lang.String	OBSCURED_BY If a piece is obscured to other players, return a String identifying the player who obscured it
static java.lang.String	OBSCURED_TO_ME Return Boolean.TRUE if the piece's identity is not known to the user
static java.lang.String	OBSCURED_TO_OTHERS Return Boolean.TRUE if the piece's identity is not known to other players
static java.lang.String	OUTER If this piece decorated by a Decorator, return the Decorator
static java.lang.String	RESTRICTED Return Boolean.TRUE if this piece has Restricted Access
static java.lang.String	SELECTED Return Boolean.TRUE if the piece has been marked as selected
static java.lang.String	SNAPSHOT Used to store a duplicate of the target piece at some point in time
static java.lang.String	TERRAIN Return Boolean.TRUE if the piece behaves more like a terrain feature than a playing piece
static java.lang.String	USE_UNROTATED_SHAPE If Boolean.TRUE, then the shape returned by GamePiece.getShape() is the shape of the piece when not rotated.

Field Detail

INVISIBLE_TO_ME

public static final java.lang.String INVISIBLE_TO_ME

Return Boolean.TRUE if the piece cannot be seen by the user

INVISIBLE_TO_OTHERS

public static final java.lang.String INVISIBLE_TO_OTHERS

OBSCURED_TO_OTHERS

public static final java.lang.String OBSCURED_TO_OTHERS

Return Boolean.TRUE if the piece's identity is not known to other players

OBSCURED_TO_ME

public static final java.lang.String OBSCURED_TO_ME

Return Boolean.TRUE if the piece's identity is not known to the user

OBSCURED_BY

public static final java.lang.String OBSCURED_BY

If a piece is obscured to other players, return a String identifying the player who obscured it

See Also:

GameModule.getUserId()

EVENT_FILTER

public static final java.lang.String EVENT_FILTER

If non-null, then return an instance of EventFilter. The piece will not respond to events if the filter rejects them

HIDDEN_BY

public static final java.lang.String HIDDEN_BY

If a piece is hidden to other players, return a STring identifying the player who hit it

See Also:

GameModule.getUserId()

TERRAIN

public static final java.lang.String TERRAIN

Return Boolean.TRUE if the piece behaves more like a terrain feature than a playing piece

IGNORE_GRID

public static final java.lang.String IGNORE_GRID

Return Boolean.TRUE if the piece should ignore map grids when being moved

NO_STACK

public static final java.lang.String NO_STACK

Return Boolean.TRUE if the piece does not form stacks

SELECTED

public static final java.lang.String SELECTED

Return Boolean.TRUE if the piece has been marked as selected

KEY_COMMANDS

public static final java.lang.String KEY_COMMANDS

Return a KeyCommand[] object representing the popup menu equivalencies for the key commands recognized by this piece

INNER

public static final java.lang.String INNER

If this piece is a Decorator, return the decorated piece

OUTER

public static final java.lang.String OUTER

If this piece decorated by a Decorator, return the Decorator

RESTRICTED

public static final java.lang.String RESTRICTED

Return Boolean.TRUE if this piece has Restricted Access

MOVED

public static final java.lang.String MOVED

Return Boolean.TRUE if this piece has been moved

SNAPSHOT

public static final java.lang.String SNAPSHOT

Used to store a duplicate of the target piece at some point in time

USE_UNROTATED_SHAPE

public static final java.lang.String USE_UNROTATED_SHAPE

If Boolean.TRUE, then the shape returned by GamePiece.getShape() is the shape of the piece when not rotated.

See Also:

FreeRotator