Package VASSAL.script

Class BshCommandEncoder

java.lang.Object

VASSAL.build.module.BasicCommandEncoder

VASSAL.script.BshCommandEncoder

All Implemented Interfaces:

Buildable, CommandEncoder

public class BshCommandEncoder
extends BasicCommandEncoder

Used by the Bsh Plugin

Author:

Brent

Nested Class Summary

Nested classes/interfaces inherited from class VASSAL.build.module.BasicCommandEncoder

BasicCommandEncoder.BasicPieceFactory, BasicCommandEncoder.DecoratorFactory

Field Summary

Fields inherited from class VASSAL.build.module.BasicCommandEncoder

ADD, CHANGE, MOVE, REMOVE

Constructor Summary

Constructors

Constructor	Description
BshCommandEncoder()

Method Summary

Modifier and Type	Method	Description
Decorator	createDecorator(String type, GamePiece inner)	Creates a Decorator instance - a GamePiece "Trait".

Methods inherited from class VASSAL.build.module.BasicCommandEncoder

add, addTo, build, createBasic, createPiece, decode, encode, getBuildElement

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BshCommandEncoder

public BshCommandEncoder()

Method Details

createDecorator

public Decorator createDecorator(String type,
 GamePiece inner)

Description copied from class: BasicCommandEncoder

Creates a Decorator instance - a GamePiece "Trait". Modules which wish to provide their own custom classes should subclass BasicCommandEncoder and override this class. The override should check for and parse any definitions that match desired custom Traits(Decorators), and then use super to call this method for any unmatched definitions. Further documentation on creating custom traits appears in BasicCommandEncoder's own javadoc entry, or alternatively at the top of BasicCommandEncoder.java.

Overrides:

createDecorator in class BasicCommandEncoder

Parameters:

type - the type of the Decorator ("Trait") to be created. Once created, the Decorator should return this value from its Decorator.myGetType() method.

inner - the inner trait/piece of the Decorator (the "innermost" member of a game piece will be a BasicPiece; each successive Trait in the trait list presented in a piece's PieceDefiner dialog represents a sep "outward").