Class ModulePlugin

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.module.ModuleExtension

VASSAL.build.module.ModulePlugin

All Implemented Interfaces:

Buildable, GpIdSupport, GameComponent, PluginsLoader.PluginElement, PropertyNameSource, ValidityChecker, Auditable, ImageSearchTarget

public class ModulePlugin
extends ModuleExtension

A ModulePlugin is basically identical to a ModuleExtension except that is loaded earlier and must throw Plugin specific error messages

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModulePlugin.RegCmd

Field Summary

Fields inherited from class ModuleExtension

BASE_MODULE_NAME, BASE_MODULE_VERSION, description, DESCRIPTION, EXTENSION_ID, extensionId, idDisplay, NEXT_PIECESLOT_ID, nextGpId, universal, UNIVERSAL, VASSAL_VERSION_CREATED, VERSION

Fields inherited from class AbstractBuildable

buildComponents, validator

Constructor Summary

Constructors

Constructor	Description
ModulePlugin(DataArchive archive)

Method Summary

Modifier and Type	Method	Description
Command	getRestoreCommand()	When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null

Methods inherited from class ModuleExtension

addTo, build, checkGpIds, confirmExit, generateGpId, getAllowableConfigureComponents, getAttributeNames, getAttributeValueString, getDataArchive, getDescription, getEditAction, getExtensionId, getHelpFile, getName, getNextGpId, getUniversal, getVersion, remove, removeFrom, save, saveAs, setAttribute, setNextGpId, setup, updateGpIds, updateGpIds, write

Methods inherited from class AbstractBuildable

add, addImageNamesRecursively, build, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, getPropertyNames, setAncestor, validate

Methods inherited from class AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Methods inherited from class Object

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

Methods inherited from interface Auditable

getComponentName, getComponentTypeName

Methods inherited from interface Buildable

isMandatory, isMovable, isUnique

Constructor Details

ModulePlugin

public ModulePlugin(DataArchive archive)

Method Details

getRestoreCommand

public Command getRestoreCommand()

Description copied from interface: GameComponent

When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null

Specified by:

getRestoreCommand in interface GameComponent

Overrides:

getRestoreCommand in class ModuleExtension