VASSAL.counters
Interface Properties

public interface Properties

Defines the properties expected to be defined in each GamePiece

Field Summary

static java.lang.String	IGNORE_GRID Return Boolean.TRUE if the piece should ignore map grids when being moved
static java.lang.String	IMMOBILE Return Boolean.TRUE if the piece cannot move;
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_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	SHAPE Return a non-rectangular Shape for this piece, null if not applicable

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

IMMOBILE

public static final java.lang.String IMMOBILE

Return Boolean.TRUE if the piece cannot move;

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

SHAPE

public static final java.lang.String SHAPE

Return a non-rectangular Shape for this piece, null if not applicable