Class ADC2Module.PieceClass

java.lang.Object

VASSAL.tools.imports.adc2.ADC2Module.PieceClass

Direct Known Subclasses:

ADC2Module.CardClass

Enclosing class:

ADC2Module

public class ADC2Module.PieceClass
extends Object

A general class for a game piece. Typically all pieces that appear to be identical blong to the same class.

Field Summary

Fields

Modifier and Type	Field	Description
ADC2Module.PieceClass	backReplace
static final String	CLASS_PROPERTIES
protected static final int	NO_HIDDEN_SYMBOL
protected int	owner
protected static final int	PLAYER_DEFAULT_HIDDEN_SYMBOL
protected VASSAL.tools.imports.adc2.SymbolSet.SymbolData	symbol

Constructor Summary

Constructors

Constructor	Description
PieceClass(String name, VASSAL.tools.imports.adc2.SymbolSet.SymbolData symbol, int owner, int hiddenSymbol, int facing)

Method Summary

Modifier and Type	Method	Description
boolean	checkHidden(ADC2Module.Piece piece)
ADC2Module.FacingDirection	getAllowedFacings()
Embellishment	getAttackedEmbellishmentDecorator()
ADC2Module.PieceClass	getBackFlipClass()
protected ADC2Module.Piece	getDefaultPiece()
Embellishment	getDefendedEmbellishmentDecorator()
DynamicProperty	getDynamicPropertyDecorator()
ADC2Module.PieceClass	getFlipClass()
protected ADC2Module.Piece	getFlipDefinition()
FreeRotator	getFreeRotatorDecorator()
Decorator	getHiddenDecorator()
String	getHiddenName()
VASSAL.tools.imports.adc2.SymbolSet.SymbolData	getHiddenSymbol()
String	getImageName()
MovementMarkable	getMovementMarkableDecorator()
String	getName()
int	getNValues()
ADC2Module.Player	getOwner()
Obscurable	getPieceValueMask()
ADC2Module.Player	getPlayer(ADC2Module.Piece p)
PropertySheet	getPropertySheetDecorator()
Decorator	getReplaceWithOtherDecorator()
Decorator	getReplaceWithPreviousDecorator()
protected VASSAL.tools.imports.adc2.SymbolSet.SymbolData	getSymbol()
String	getUniqueName()
UsePrototype	getUsePrototypeDecorator()
Object	getValue(int index)
boolean	getValueAsBoolean(int index)
int	getValueAsInt(int index)
String	getValueAsString(int index)
protected void	setBackFlipClass(int from)
protected void	setFlipClass(int to)
protected void	setValue(int index, boolean value)
protected void	setValue(int index, int value)
protected void	setValue(int index, String value)
protected void	writeToArchive(ListWidget list)

Methods inherited from class java.lang.Object

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

Field Details

backReplace

public ADC2Module.PieceClass backReplace

CLASS_PROPERTIES

public static final String CLASS_PROPERTIES

See Also:

• Constant Field Values

NO_HIDDEN_SYMBOL

protected static final int NO_HIDDEN_SYMBOL

See Also:

• Constant Field Values

PLAYER_DEFAULT_HIDDEN_SYMBOL

protected static final int PLAYER_DEFAULT_HIDDEN_SYMBOL

See Also:

• Constant Field Values

symbol

protected VASSAL.tools.imports.adc2.SymbolSet.SymbolData symbol

owner

protected int owner

Constructor Details

PieceClass

public PieceClass(String name,
 VASSAL.tools.imports.adc2.SymbolSet.SymbolData symbol,
 int owner,
 int hiddenSymbol,
 int facing)

Method Details

getReplaceWithPreviousDecorator

public Decorator getReplaceWithPreviousDecorator()
                                          throws IOException

Throws:

IOException

getReplaceWithOtherDecorator

public Decorator getReplaceWithOtherDecorator()
                                       throws IOException

Throws:

IOException

getBackFlipClass

public ADC2Module.PieceClass getBackFlipClass()

getDynamicPropertyDecorator

public DynamicProperty getDynamicPropertyDecorator()

getUniqueName

public String getUniqueName()

checkHidden

public boolean checkHidden(ADC2Module.Piece piece)

getPropertySheetDecorator

public PropertySheet getPropertySheetDecorator()

getUsePrototypeDecorator

public UsePrototype getUsePrototypeDecorator()

getAttackedEmbellishmentDecorator

public Embellishment getAttackedEmbellishmentDecorator()
                                                throws IOException

Throws:

IOException

getDefendedEmbellishmentDecorator

public Embellishment getDefendedEmbellishmentDecorator()
                                                throws IOException

Throws:

IOException

getPieceValueMask

public Obscurable getPieceValueMask()
                             throws IOException

Throws:

IOException

getMovementMarkableDecorator

public MovementMarkable getMovementMarkableDecorator()
                                              throws IOException

Throws:

IOException

getHiddenDecorator

public Decorator getHiddenDecorator()
                             throws IOException

Throws:

IOException

getFreeRotatorDecorator

public FreeRotator getFreeRotatorDecorator()

getHiddenName

public String getHiddenName()

setValue

protected void setValue(int index,
 int value)

getAllowedFacings

public ADC2Module.FacingDirection getAllowedFacings()

getHiddenSymbol

public VASSAL.tools.imports.adc2.SymbolSet.SymbolData getHiddenSymbol()
                                                               throws IOException

Throws:

IOException

getImageName

public String getImageName()
                    throws IOException

Throws:

IOException

getOwner

public ADC2Module.Player getOwner()

getPlayer

public ADC2Module.Player getPlayer(ADC2Module.Piece p)

setFlipClass

protected void setFlipClass(int to)

setBackFlipClass

protected void setBackFlipClass(int from)

getFlipClass

public ADC2Module.PieceClass getFlipClass()

getName

public String getName()

setValue

protected void setValue(int index,
 String value)

setValue

protected void setValue(int index,
 boolean value)

getValueAsInt

public int getValueAsInt(int index)

getValueAsString

public String getValueAsString(int index)

getNValues

public int getNValues()

getValueAsBoolean

public boolean getValueAsBoolean(int index)

getValue

public Object getValue(int index)

writeToArchive

protected void writeToArchive(ListWidget list)
                       throws IOException

Throws:

IOException

getDefaultPiece

protected ADC2Module.Piece getDefaultPiece()

getFlipDefinition

protected ADC2Module.Piece getFlipDefinition()

getSymbol

protected VASSAL.tools.imports.adc2.SymbolSet.SymbolData getSymbol()
                                                            throws IOException

Throws:

IOException