Package VASSAL.counters

Class BasicPiece

java.lang.Object

VASSAL.counters.BasicPiece

All Implemented Interfaces:

PropertyNameSource, PropertySource, EditablePiece, GamePiece, PropertyExporter, StateMergeable, TranslatablePiece, PersistentPropertyContainer

public class BasicPiece
extends Object
implements TranslatablePiece, StateMergeable, PropertyNameSource, PersistentPropertyContainer, PropertyExporter

Basic class for representing a physical component of the game Can be a counter, a card, or an overlay

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASIC_NAME
static String	CLICKED_X
static String	CLICKED_Y
static String	CURRENT_BOARD
static String	CURRENT_MAP
static String	CURRENT_X
static String	CURRENT_Y
static String	CURRENT_ZONE
static String	DECK_NAME
static String	DECK_POSITION
static String	ID
protected Image	image	Deprecated. Replaced by
protected Rectangle	imageBounds
protected String	imageName
protected ScaledImagePainter	imagePainter
static String	LOCATION_NAME	Return information about the current location of the piece through getProperty(): LocationName - Current Location Name of piece as displayed in Chat Window CurrentX - Current X position CurrentY - Current Y position CurrentMap - Current Map name or "" if not on a map CurrentBoard - Current Board name or "" if not on a map CurrentZone - If the current map has a multi-zoned grid, then return the name of the Zone the piece is in, or "" if the piece is not in any zone, or not on a map
static String	OLD_BOARD
static String	OLD_LOCATION_NAME
static String	OLD_MAP
static String	OLD_X
static String	OLD_Y
static String	OLD_ZONE
static String	PIECE_NAME
protected JPopupMenu	popup
static Font	POPUP_MENU_FONT

Fields inherited from interface VASSAL.counters.PropertyExporter

LOCALIZED_NAME

Fields inherited from interface VASSAL.i18n.TranslatablePiece

PREFIX

Constructor Summary

Constructors

Constructor	Description
BasicPiece()
BasicPiece(String type)

Method Summary

Modifier and Type	Method	Description
Rectangle	boundingBox()	The area which this GamePiece occupies when drawn at the point (0,0)
void	draw(Graphics g, int x, int y, Component obs, double zoom)	Draw this GamePiece
boolean	equals(GamePiece c)
String	getDescription()	A plain-English description of this type of piece
PieceEditor	getEditor()	Get the configurer for this trait
String	getGpId()
HelpFile	getHelpFile()
static Highlighter	getHighlighter()	Get the Highlighter instance for drawing selected pieces.
PieceI18nData	getI18nData()	Return a PieceI18nData object returning the I18n data about this GamePiece.
String	getId()	Each GamePiece must have a unique String identifier
protected KeyCommand[]	getKeyCommands()
String	getLocalizedName()	And the translated name for this piece
Object	getLocalizedProperty(Object key)
Object	getLocalizedPublicProperty(Object key)
Map	getMap()
String	getName()	The plain English name for this piece
Stack	getParent()
Object	getPersistentProperty(Object key)
Point	getPosition()
Object	getProperty(Object key)
List<String>	getPropertyNames()	Return Property names exposed by this trait
Object	getPublicProperty(Object key)
Shape	getShape()	The shape of the piece from the user's viewpoint.
String	getState()	The state information is information that can change during the course of a game.
String	getType()	The type information is information that does not change during the course of a game.
Command	keyEvent(KeyStroke stroke)	Keyboard events are forward to this method when a piece is selected The GamePiece can respond in any way it likes
void	mergeState(String newState, String oldState)	Compute the difference between newState and oldState and appy that difference to the current state
void	mySetType(String type)	Set the type information for this piece.
protected Object	prefsValue(String s)
void	setGpId(String id)
static void	setHighlighter(Highlighter h)	Set the Highlighter for all pieces
void	setId(String id)
void	setMap(Map map)	Each GamePiece belongs to a single Map
void	setParent(Stack s)
Command	setPersistentProperty(Object key, Object newValue)
void	setPosition(Point p)
void	setProperty(Object key, Object val)	Other properties, possibly game-specific, can be associated with a piece.
void	setState(String s)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface VASSAL.counters.PropertyExporter

getProperties, getProperties

Field Details

ID

public static final String ID

See Also:

Constant Field Values

LOCATION_NAME

public static final String LOCATION_NAME

Return information about the current location of the piece through getProperty(): LocationName - Current Location Name of piece as displayed in Chat Window CurrentX - Current X position CurrentY - Current Y position CurrentMap - Current Map name or "" if not on a map CurrentBoard - Current Board name or "" if not on a map CurrentZone - If the current map has a multi-zoned grid, then return the name of the Zone the piece is in, or "" if the piece is not in any zone, or not on a map

See Also:

Constant Field Values

CURRENT_MAP

public static final String CURRENT_MAP

See Also:

Constant Field Values

CURRENT_BOARD

public static final String CURRENT_BOARD

See Also:

Constant Field Values

CURRENT_ZONE

public static final String CURRENT_ZONE

See Also:

Constant Field Values

CURRENT_X

public static final String CURRENT_X

See Also:

Constant Field Values

CURRENT_Y

public static final String CURRENT_Y

See Also:

Constant Field Values

OLD_LOCATION_NAME

public static final String OLD_LOCATION_NAME

See Also:

Constant Field Values

OLD_MAP

public static final String OLD_MAP

See Also:

Constant Field Values

OLD_BOARD

public static final String OLD_BOARD

See Also:

Constant Field Values

OLD_ZONE

public static final String OLD_ZONE

See Also:

Constant Field Values

OLD_X

public static final String OLD_X

See Also:

Constant Field Values

OLD_Y

public static final String OLD_Y

See Also:

Constant Field Values

BASIC_NAME

public static final String BASIC_NAME

See Also:

Constant Field Values

PIECE_NAME

public static final String PIECE_NAME

See Also:

Constant Field Values

DECK_NAME

public static final String DECK_NAME

See Also:

Constant Field Values

DECK_POSITION

public static final String DECK_POSITION

See Also:

Constant Field Values

CLICKED_X

public static final String CLICKED_X

See Also:

Constant Field Values

CLICKED_Y

public static final String CLICKED_Y

See Also:

Constant Field Values

POPUP_MENU_FONT

public static Font POPUP_MENU_FONT

popup

protected JPopupMenu popup

imageBounds

protected Rectangle imageBounds

imagePainter

protected ScaledImagePainter imagePainter

image

@Deprecated
protected Image image

Deprecated.

Replaced by

imageName

protected String imageName

Constructor Details

BasicPiece

public BasicPiece()

BasicPiece

public BasicPiece(String type)

Method Details

mySetType

public void mySetType(String type)

Description copied from interface: EditablePiece

Set the type information for this piece. See Decorator.myGetType()

Specified by:

mySetType in interface EditablePiece

getType

public String getType()

Description copied from interface: GamePiece

The type information is information that does not change during the course of a game. Image file names, popup menu command names, etc., all should be reflected in the type.

Specified by:

getType in interface GamePiece

See Also:

BasicCommandEncoder

setMap

public void setMap(Map map)

Description copied from interface: GamePiece

Each GamePiece belongs to a single Map

Specified by:

setMap in interface GamePiece

getMap

public Map getMap()

Specified by:

getMap in interface GamePiece

getProperty

public Object getProperty(Object key)

Specified by:

getProperty in interface GamePiece

Specified by:

getProperty in interface PropertySource

getPublicProperty

public Object getPublicProperty(Object key)

getLocalizedProperty

public Object getLocalizedProperty(Object key)

Specified by:

getLocalizedProperty in interface PropertySource

getLocalizedPublicProperty

public Object getLocalizedPublicProperty(Object key)

setProperty

public void setProperty(Object key,
Object val)

Description copied from interface: GamePiece

Other properties, possibly game-specific, can be associated with a piece. The properties may or may not need to be encoded in the piece's GamePiece.getState() method.

Specified by:

setProperty in interface GamePiece

setPersistentProperty

public Command setPersistentProperty(Object key,
Object newValue)

Specified by:

setPersistentProperty in interface PersistentPropertyContainer

getPersistentProperty

public Object getPersistentProperty(Object key)

Specified by:

getPersistentProperty in interface PersistentPropertyContainer

prefsValue

protected Object prefsValue(String s)

draw

public void draw(Graphics g,
int x,
int y,
Component obs,
double zoom)

Description copied from interface: GamePiece

Draw this GamePiece

Specified by:

draw in interface GamePiece

x - x-location of the center of the piece

y - y-location of the center of the piece

obs - the Component on which this piece is being drawn

zoom - the scaling factor.

getKeyCommands

protected KeyCommand[] getKeyCommands()

getPosition

public Point getPosition()

Specified by:

getPosition in interface GamePiece

Returns:

the location of this piece on its owning Map

setPosition

public void setPosition(Point p)

Specified by:

setPosition in interface GamePiece

getParent

public Stack getParent()

Specified by:

getParent in interface GamePiece

Returns:

the Stack to which this piece belongs, or null if it doesn't belong to a stack.

setParent

public void setParent(Stack s)

Specified by:

setParent in interface GamePiece

boundingBox

public Rectangle boundingBox()

Description copied from interface: GamePiece

The area which this GamePiece occupies when drawn at the point (0,0)

Specified by:

boundingBox in interface GamePiece

getShape

public Shape getShape()

Description copied from interface: GamePiece

The shape of the piece from the user's viewpoint. This defines the area in which the user must click to select or move the piece, for example. Like GamePiece.boundingBox(), it assumes the position is (0,0) and must be translated to the actual location where the piece is being drawn.

Specified by:

getShape in interface GamePiece

equals

public boolean equals(GamePiece c)

getName

public String getName()

Description copied from interface: GamePiece

The plain English name for this piece

Specified by:

getName in interface GamePiece

getLocalizedName

public String getLocalizedName()

Description copied from interface: GamePiece

And the translated name for this piece

Specified by:

getLocalizedName in interface GamePiece

keyEvent

public Command keyEvent(KeyStroke stroke)

Description copied from interface: GamePiece

Keyboard events are forward to this method when a piece is selected The GamePiece can respond in any way it likes

Specified by:

keyEvent in interface GamePiece

Returns:

a Command that, when executed, will invoke the same response. Usually a ChangePiece command.

See Also:

ForwardToKeyBuffer

getState

public String getState()

Description copied from interface: GamePiece

The state information is information that can change during the course of a game. State information is saved when the game is saved and is transferred between players on the server. For example, the relative order of pieces in a stack is state information, but whether the stack is expanded is not

Specified by:

getState in interface GamePiece

setState

public void setState(String s)

Specified by:

setState in interface GamePiece

mergeState

public void mergeState(String newState,
String oldState)

Description copied from interface: StateMergeable

Compute the difference between newState and oldState and appy that difference to the current state

Specified by:

mergeState in interface StateMergeable

getId

public String getId()

Description copied from interface: GamePiece

Each GamePiece must have a unique String identifier

Specified by:

getId in interface GamePiece

See Also:

GameState.getNewPieceId()

setId

public void setId(String id)

Specified by:

setId in interface GamePiece

getHighlighter

public static Highlighter getHighlighter()

Get the Highlighter instance for drawing selected pieces. Note that since this is a static method, all pieces in a module will always use the same Highlighter

setHighlighter

public static void setHighlighter(Highlighter h)

Set the Highlighter for all pieces

getDescription

public String getDescription()

Description copied from interface: EditablePiece

A plain-English description of this type of piece

Specified by:

getDescription in interface EditablePiece

getGpId

public String getGpId()

setGpId

public void setGpId(String id)

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface EditablePiece

getEditor

public PieceEditor getEditor()

Description copied from interface: EditablePiece

Get the configurer for this trait

Specified by:

getEditor in interface EditablePiece

toString

public String toString()

Overrides:

toString in class Object

getI18nData

public PieceI18nData getI18nData()

Description copied from interface: TranslatablePiece

Return a PieceI18nData object returning the I18n data about this GamePiece.

Specified by:

getI18nData in interface TranslatablePiece

getPropertyNames

public List<String> getPropertyNames()

Return Property names exposed by this trait

Specified by:

getPropertyNames in interface PropertyNameSource