Interface TranslatablePiece

All Superinterfaces:

Auditable, EditablePiece, GamePiece, PropertySource

All Known Implementing Classes:

AreaOfEffect, Attachment, BasicName, BasicPiece, BorderOutline, Clone, CounterGlobalKeyCommand, Delete, Deselect, DynamicProperty, Embellishment, Embellishment0, Footprint, FreeRotator, GlobalHotKey, Hideable, Labeler, Mat, MatCargo, MenuSeparator, MovementMarkable, MultiLocationCommand, Obscurable, Pivot, PlaceMarker, PlaySound, PropertySheet, Replace, ReportState, ReturnToDeck, SendToLocation, SetGlobalProperty, SetPieceProperty, SubMenu, TableInfo, TranslatableMessage, Translate, TriggerAction

public interface TranslatablePiece
extends EditablePiece

Decorators that contain localizable elements must implement this interface

Author:

Brent Easton

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX

Method Summary

Modifier and Type	Method	Description
PieceI18nData	getI18nData()	Return a PieceI18nData object returning the I18n data about this GamePiece.

Methods inherited from interface Auditable

getComponentName, getComponentTypeName

Modifier and Type	Method	Description
default String	getComponentName()	Return the name of the trait or Component an Auditable is
default String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is

Methods inherited from interface EditablePiece

checkTrueMoved, finishMove, finishMove, getBaseDescription, getDescription, getEditor, getHelpFile, mySetType, prepareMove

Modifier and Type	Method	Description
default Command	checkTrueMoved()	Centralized method used when finishing up after a piece moves.
default Command	finishMove(Command c, boolean afterburner, boolean findmat)
default Command	finishMove(Command c, boolean afterburner, boolean findmat, boolean mark_moved)	Centralized method for finishing up after a piece moves.
default String	getBaseDescription()	Support for a basic-name-only description introduced later, so this default retrofits it from the full description if an explicit one is not defined.
String	getDescription()	A plain-English description of this type of trait/piece - includes data from fields where appropriate
PieceEditor	getEditor()
HelpFile	getHelpFile()
void	mySetType(String type)	Sets the information for this piece.
default Command	prepareMove(Command c, boolean mark_moved)	Centralized method for preparing a piece to move.

Methods inherited from interface GamePiece

boundingBox, draw, getId, getLocalizedName, getMap, getName, getParent, getPosition, getProperty, getShape, getState, getType, keyEvent, setId, setMap, setParent, setPosition, setProperty, setState

Modifier and Type	Method	Description
Rectangle	boundingBox()
void	draw(Graphics g, int x, int y, Component obs, double zoom)	Draw this GamePiece
String	getId()	Each GamePiece must have a unique String identifier
String	getLocalizedName()	And the translated name for this piece
Map	getMap()
String	getName()	The plain English name for this piece
Stack	getParent()
Point	getPosition()
Object	getProperty(Object key)	Properties can be associated with a piece -- many may be game-specific, but others are standard, such as the LocationName property exposed by BasicPiece -- and can be read through this interface.
Shape	getShape()
String	getState()
String	getType()
Command	keyEvent(KeyStroke stroke)	The primary way for the piece or trait to receive events.
void	setId(String id)	Each GamePiece must have a unique String identifier
void	setMap(Map map)
void	setParent(Stack s)
void	setPosition(Point p)
void	setProperty(Object key, Object val)	Properties can be associated with a piece -- many may be game-specific, but others are standard, such as the LocationName property exposed by BasicPiece -- and can be set through this interface.
void	setState(String newState)

Methods inherited from interface PropertySource

getLocalizedProperty

Modifier and Type	Method	Description
Object	getLocalizedProperty(Object key)	Returns a localized translation of the specified property value, if available.

Field Details

PREFIX

static final String PREFIX

See Also:

• Constant Field Values

Method Details

getI18nData

PieceI18nData getI18nData()

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