Package VASSAL.counters

Interface EditablePiece

All Superinterfaces:

GamePiece, PropertySource

All Known Subinterfaces:

TranslatablePiece

All Known Implementing Classes:

ActionButton, AreaOfEffect, BasicPiece, CalculatedProperty, Clone, CounterGlobalKeyCommand, Delete, DynamicProperty, Embellishment, Embellishment0, Footprint, FreeRotator, GlobalHotKey, Hideable, Immobilized, Labeler, Marker, MovementMarkable, NonRectangular, Obscurable, Pivot, PlaceMarker, PlaySound, PropertySheet, Replace, ReportState, RestrictCommands, Restricted, ReturnToDeck, SendToLocation, SetGlobalProperty, SubMenu, TableInfo, Translate, TriggerAction, UsePrototype

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

Modifier and Type	Method	Description
String	getDescription()	A plain-English description of this type of piece
PieceEditor	getEditor()	Get the configurer for this trait
HelpFile	getHelpFile()
void	mySetType(String type)	Set the type information for this piece.

Methods inherited from interface VASSAL.counters.GamePiece

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

Methods inherited from interface VASSAL.build.module.properties.PropertySource

getLocalizedProperty

Method Details

getDescription

String getDescription()

A plain-English description of this type of piece

mySetType

void mySetType(String type)

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

getEditor

PieceEditor getEditor()

Get the configurer for this trait

getHelpFile

HelpFile getHelpFile()