Package VASSAL.counters

Interface EditablePiece

All Superinterfaces:
GamePiece, PropertySource
All Known Subinterfaces:
TranslatablePiece
All Known Implementing Classes:
ActionButton, AreaOfEffect, BasicPiece, CalculatedProperty, Clone, CounterGlobalKeyCommand, Delete, Deselect, DynamicProperty, Embellishment, Embellishment0, Footprint, FreeRotator, GlobalHotKey, Hideable, Immobilized, Labeler, Marker, 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 Details

    • getDescription

      String getDescription()
      A plain-English description of this type of piece

    • 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