Package VASSAL.tools.imports.adc2

Class ADC2Module

java.lang.Object

VASSAL.tools.imports.Importer

VASSAL.tools.imports.adc2.ADC2Module

public class ADC2Module
extends Importer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ADC2Module.CardClass
class	ADC2Module.Cards
class	ADC2Module.DeckPool
static enum	ADC2Module.FacingDirection
class	ADC2Module.ForcePool
protected static class	ADC2Module.ForcePoolList
class	ADC2Module.HandPool
static enum	ADC2Module.HideState
class	ADC2Module.Piece
class	ADC2Module.PieceClass	A general class for a game piece.
static class	ADC2Module.Player
class	ADC2Module.Pool
static class	ADC2Module.StateFlag
class	ADC2Module.StatusDots
static enum	ADC2Module.ValueType

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	ALL_PLAYERS
static final String	COMMON_PROPERTIES
static final String	DRAW_ON_TOP_OF_OTHERS
static final Color	FLAG_BACKGROUND
static final Color	FLAG_FOREGROUND
protected static final int	NO_PLAYERS
static final String	PIECE

Fields inherited from class VASSAL.tools.imports.Importer

action, file

Constructor Summary

Constructors

Constructor	Description
ADC2Module()

Method Summary

Modifier and Type	Method	Description
protected void	configureDiceRoller(GameModule gameModule)
protected void	configureMapLayers()
protected void	configureMouseOverStackViewer(GameModule gameModule)
protected void	configureTurnCounter(GameModule gameModule)
protected SymbolSet	getCardDeck(int deck)
protected ADC2Module.PieceClass	getClassFromIndex(int index)
protected MapBoard	getMap()
protected SymbolSet	getSet()
boolean	isValidImportFile(File f)	Determine whether the file is valid for the given importer.
protected void	load(File f)	The method that actually loads the file and creates the classes containing information needed for the archive.
protected void	readAllianceBlock(DataInputStream in)
protected void	readAutoRevealWhenMovingLOSFlagBlock(DataInputStream in)
protected void	readClassBlock(DataInputStream in)
protected void	readClassValueBlock(DataInputStream in)
protected void	readCombatRevealFlagBlock(DataInputStream in)
protected void	readCombatSummaryBlock(DataInputStream in)
protected void	readDeckNameBlock(DataInputStream in)
protected void	readDiceBlock(DataInputStream in)
protected void	readFacingBlock(DataInputStream in)
protected void	readFlipDefinitionBlock(DataInputStream in)
protected void	readGameTurnBlock(DataInputStream in)
protected void	readInfoPageBlock(DataInputStream in)
protected void	readInfoSizeBlock(DataInputStream in)
protected void	readLOSBlock(DataInputStream in)
protected void	readLOSFlagBlock(DataInputStream in)
protected void	readPieceBlock(DataInputStream in)
protected void	readPieceStatusDotsBlock(DataInputStream in)
protected void	readPieceValueBlock(DataInputStream in)
protected void	readPlayerBlock(DataInputStream in)
protected void	readPoolBlock(DataInputStream in)
protected void	readPoolOwnerBlock(DataInputStream in)
protected void	readReplayBlock(DataInputStream in)
protected void	readSoundSettingBlock(DataInputStream in)
protected void	readStackBlock(DataInputStream in)
protected void	readTurnNameBlock(DataInputStream in)
boolean	usePieceValues()
protected void	writeClassesToArchive(GameModule gameModule)
protected void	writeDecksToArchive(GameModule gameModule)
protected void	writeForcePoolsToArchive(GameModule gameModule)	Creates a board with deck stacks in which force pools are kept.
protected void	writeHandsToArchive(GameModule module)
protected void	writeInfoPagesToArchive(GameModule gameModule)
protected void	writePlayersToArchive(GameModule gameModule)
protected void	writePrototypesToArchive(GameModule gameModule)
protected void	writeSetupStacksToArchive(GameModule gameModule)
void	writeToArchive()	Create the VASSAL module based on the classes created by load.
protected void	writeToolbarMenuToArchive(GameModule gameModule)

Methods inherited from class VASSAL.tools.imports.Importer

forceExtension, getExtension, getFileName, getLayeredPieceCollection, getMainMap, getUniqueImageFileName, getUniqueImageFileName, importFile, insertComponent, readNullTerminatedString, readNullTerminatedString, readWindowsFileName, stripExtension

Methods inherited from class java.lang.Object

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

Field Details

DRAW_ON_TOP_OF_OTHERS

public static final String DRAW_ON_TOP_OF_OTHERS

See Also:

• Constant Field Values

PIECE

public static final String PIECE

See Also:

• Constant Field Values

ALL_PLAYERS

protected static final int ALL_PLAYERS

See Also:

• Constant Field Values

NO_PLAYERS

protected static final int NO_PLAYERS

See Also:

• Constant Field Values

COMMON_PROPERTIES

public static final String COMMON_PROPERTIES

See Also:

• Constant Field Values

FLAG_BACKGROUND

public static final Color FLAG_BACKGROUND

FLAG_FOREGROUND

public static final Color FLAG_FOREGROUND

Constructor Details

ADC2Module

public ADC2Module()

Method Details

getClassFromIndex

protected ADC2Module.PieceClass getClassFromIndex(int index)

getCardDeck

protected SymbolSet getCardDeck(int deck)
                         throws IOException

Throws:

IOException

usePieceValues

public boolean usePieceValues()

load

protected void load(File f)
             throws IOException

Description copied from class: Importer

The method that actually loads the file and creates the classes containing information needed for the archive. The archive is written in writeToArchive.

Overrides:

load in class Importer

Parameters:

f - The base file to be imported.

Throws:

IOException - oops

readAllianceBlock

protected void readAllianceBlock(DataInputStream in)
                          throws IOException

Throws:

IOException

readInfoSizeBlock

protected void readInfoSizeBlock(DataInputStream in)
                          throws IOException

Throws:

IOException

readInfoPageBlock

protected void readInfoPageBlock(DataInputStream in)
                          throws IOException

Throws:

IOException

readCombatRevealFlagBlock

protected void readCombatRevealFlagBlock(DataInputStream in)
                                  throws IOException

Throws:

IOException

readAutoRevealWhenMovingLOSFlagBlock

protected void readAutoRevealWhenMovingLOSFlagBlock(DataInputStream in)
                                             throws IOException

Throws:

IOException

readPoolOwnerBlock

protected void readPoolOwnerBlock(DataInputStream in)
                           throws IOException

Throws:

IOException

readDeckNameBlock

protected void readDeckNameBlock(DataInputStream in)
                          throws IOException

Throws:

IOException

readLOSFlagBlock

protected void readLOSFlagBlock(DataInputStream in)
                         throws IOException

Throws:

IOException

readLOSBlock

protected void readLOSBlock(DataInputStream in)
                     throws IOException

Throws:

IOException

readTurnNameBlock

protected void readTurnNameBlock(DataInputStream in)
                          throws IOException

Throws:

IOException

readDiceBlock

protected void readDiceBlock(DataInputStream in)
                      throws IOException

Throws:

IOException

readPieceStatusDotsBlock

protected void readPieceStatusDotsBlock(DataInputStream in)
                                 throws IOException

Throws:

IOException

readFlipDefinitionBlock

protected void readFlipDefinitionBlock(DataInputStream in)
                                throws IOException

Throws:

IOException

readSoundSettingBlock

protected void readSoundSettingBlock(DataInputStream in)
                              throws IOException

Throws:

IOException

readFacingBlock

protected void readFacingBlock(DataInputStream in)
                        throws IOException

Throws:

IOException

readCombatSummaryBlock

protected void readCombatSummaryBlock(DataInputStream in)
                               throws IOException

Throws:

IOException

readStackBlock

protected void readStackBlock(DataInputStream in)
                       throws IOException

Throws:

IOException

readReplayBlock

protected void readReplayBlock(DataInputStream in)
                        throws IOException

Throws:

IOException

readPoolBlock

protected void readPoolBlock(DataInputStream in)
                      throws IOException

Throws:

IOException

readPlayerBlock

protected void readPlayerBlock(DataInputStream in)
                        throws IOException

Throws:

IOException

readPieceBlock

protected void readPieceBlock(DataInputStream in)
                       throws IOException

Throws:

IOException

readClassValueBlock

protected void readClassValueBlock(DataInputStream in)
                            throws IOException

Throws:

IOException

readPieceValueBlock

protected void readPieceValueBlock(DataInputStream in)
                            throws IOException

Throws:

IOException

readClassBlock

protected void readClassBlock(DataInputStream in)
                       throws IOException

Throws:

IOException

readGameTurnBlock

protected void readGameTurnBlock(DataInputStream in)
                          throws IOException

Throws:

IOException

writePrototypesToArchive

protected void writePrototypesToArchive(GameModule gameModule)

writeToArchive

public void writeToArchive()
                    throws IOException

Description copied from class: Importer

Create the VASSAL module based on the classes created by load. This should not be called directly but rather importFile.

Specified by:

writeToArchive in class Importer

Throws:

IOException - oops

writeInfoPagesToArchive

protected void writeInfoPagesToArchive(GameModule gameModule)
                                throws IOException

Throws:

IOException

configureMapLayers

protected void configureMapLayers()

configureTurnCounter

protected void configureTurnCounter(GameModule gameModule)

configureDiceRoller

protected void configureDiceRoller(GameModule gameModule)

configureMouseOverStackViewer

protected void configureMouseOverStackViewer(GameModule gameModule)

writeClassesToArchive

protected void writeClassesToArchive(GameModule gameModule)
                              throws IOException

Throws:

IOException

writePlayersToArchive

protected void writePlayersToArchive(GameModule gameModule)

writeHandsToArchive

protected void writeHandsToArchive(GameModule module)
                            throws IOException

Throws:

IOException

writeDecksToArchive

protected void writeDecksToArchive(GameModule gameModule)
                            throws IOException

Throws:

IOException

writeToolbarMenuToArchive

protected void writeToolbarMenuToArchive(GameModule gameModule)

writeForcePoolsToArchive

protected void writeForcePoolsToArchive(GameModule gameModule)
                                 throws IOException

Creates a board with deck stacks in which force pools are kept.

Throws:

IOException

writeSetupStacksToArchive

protected void writeSetupStacksToArchive(GameModule gameModule)
                                  throws IOException

Throws:

IOException

getMap

protected MapBoard getMap()

getSet

protected SymbolSet getSet()

isValidImportFile

public boolean isValidImportFile(File f)
                          throws IOException

Description copied from class: Importer

Determine whether the file is valid for the given importer.

Specified by:

isValidImportFile in class Importer

Parameters:

f - File

Returns:

true if f is a valid file for this type.

Throws:

IOException - oops