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

Modifier and Type	Field	Description
static final String	BASE_MODULE_NAME
static final String	BASE_MODULE_VERSION
protected String	description
static final String	DESCRIPTION
static final String	EXTENSION_ID
protected String	extensionId
protected JTextField	idDisplay
static final String	NEXT_PIECESLOT_ID
protected int	nextGpId
protected boolean	universal
static final String	UNIVERSAL
static final String	VASSAL_VERSION_CREATED
static final String	VERSION

Fields inherited from class AbstractBuildable

buildComponents, validator

Modifier and Type	Field	Description
protected List<Buildable>	buildComponents
protected ValidityChecker	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

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Adds this component to its parent.
void	build()
protected void	checkGpIds(Buildable b, GpIdChecker checker)
boolean	confirmExit()
String	generateGpId()	Generate a new Unique GamePiece Id
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
String	getAttributeValueString(String key)
DataArchive	getDataArchive()
String	getDescription()
Action	getEditAction(JDialog d)
String	getExtensionId()
HelpFile	getHelpFile()
String	getName()
int	getNextGpId()	Accessors to check and update the next GpId if necessary.
boolean	getUniversal()
String	getVersion()
void	remove(ExtensionElement el)
void	removeFrom(Buildable parent)
void	save()
void	saveAs()
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setNextGpId(int id)
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended
protected void	updateGpIds()	Allocate new gpid's to all PieceSlots defined in a Buildable and all of it's children
protected void	updateGpIds(Buildable b)
protected void	write(boolean saveAs)

Methods inherited from class AbstractBuildable

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

Modifier and Type	Method	Description
void	add(Buildable b)	Add a Buildable object to this object
void	addImageNamesRecursively(Collection<String> s)	Adds all images used by this component AND any subcomponents to the collection
void	build(Element e)	Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(String, Object) with the String value of the attribute
String	buildString()
<T> List<T>	getAllDescendantComponentsOf(Class<T> target)	Recursively descend the build tree and return a List of all components that are instances of the given class
Buildable	getAncestor()
List<Buildable>	getBuildables()
Enumeration<Buildable>	getBuildComponents()	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getBuildables() instead.
Element	getBuildElement(Document doc)
<T> Enumeration<T>	getComponents(Class<T> target)	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getComponentsOf(Class) instead.
<T> List<T>	getComponentsOf(Class<T> target)
Buildable	getNonFolderAncestor()
List<String>	getPropertyNames()	Override this method to provide a list of properties to be exposed for use by expressions in the module.
void	setAncestor(Buildable ancestor)
void	validate(Buildable target, ValidationReport report)

Methods inherited from class AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	Classes extending AbstractImageFinder should override this method in order to add the names of any image files they use to the collection.
SortedSet<String>	getAllImageNames()
SortedSet<String>	getLocalImageNames()

Methods inherited from class Object

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

Methods inherited from interface Auditable

getComponentName, getComponentTypeName

Modifier and Type	Method	Description
default String	getComponentName()	Return the name of the trait or Component an Auditable is
default String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is

Methods inherited from interface Buildable

isMandatory, isMovable, isUnique

Modifier and Type	Method	Description
default boolean	isMandatory()	Is this component a reqired component within its parent?
default boolean	isMovable()	Is this component allowed to be moved around the Configure Tree?
default boolean	isUnique()	Does this component need to be unique within it's parent?

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