VASSAL.counters
Interface EditablePiece

All Superinterfaces:

GamePiece

All Known Implementing Classes:

BasicPiece, Embellishment, FreeRotator, Hideable, Immobilized, Labeler, Marker, MovementMarkable, Obscurable, PlaceMarker, ReportState, Restricted, ReturnToDeck, TableInfo

public interface EditablePiece

extends GamePiece

If a GamePiece implements the EditablePiece interface, then it can be manipulated from the Configuration Tree via the PieceDefiner dialog. All Decorator classes with a no-arg constructor will appear in the Available Traits list even if they don't implement EditablePiece

Method Summary

java.lang.String	getDescription() A plain-English description of this type of piece
PieceEditor	getEditor() Get the configurer for this trait
HelpFile	getHelpFile()
void	mySetType(java.lang.String type) Set the type information for this piece.

Methods inherited from interface VASSAL.counters.GamePiece

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

Method Detail

getDescription

public java.lang.String getDescription()

A plain-English description of this type of piece

mySetType

public void mySetType(java.lang.String type)

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

getEditor

public PieceEditor getEditor()

Get the configurer for this trait

getHelpFile

public HelpFile getHelpFile()