Package VASSAL.counters

Interface EditablePiece

All Superinterfaces:

Auditable, GamePiece, PropertySource

All Known Subinterfaces:

TranslatablePiece

All Known Implementing Classes:

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

public interface EditablePiece
extends GamePiece

If class implementing GamePiece also implements the EditablePiece interface, then it can be manipulated from the Editor's Configuration Tree via the PieceDefiner dialog. All Decorator (Trait) 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
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.

Methods inherited from interface VASSAL.script.expression.Auditable

getComponentName, getComponentTypeName

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 trait/piece - includes data from fields where appropriate

mySetType

void mySetType(String type)

Sets the information for this piece. See Decorator.myGetType()

Parameters:

type - a serialized configuration string to set the "type information" of this piece, which is information that doesn't change during the course of a single game (e.g. Image Files, Context Menu strings, etc). Typically ready to be processed e.g. by SequenceEncoder.decode()

getEditor

PieceEditor getEditor()

Returns:

the configurer for this trait - the dialog which allows the editing the piece's type information

getHelpFile

HelpFile getHelpFile()

Returns:

the help file for this trait

getBaseDescription

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.

Returns:

name of trait/piece type, w/o additional data