Package anecho.JamochaMUD.plugins

Class DictPlugin

java.lang.Object

anecho.JamochaMUD.plugins.DictPlugin

All Implemented Interfaces:

PlugInterface

public class DictPlugin
extends java.lang.Object
implements PlugInterface

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	COMMANDS_FILE

Constructor Summary

Constructors

Constructor	Description
DictPlugin()

Method Summary

Modifier and Type	Method	Description
void	activate()	This function tells the plug-in that it should be functioning.
void	deactivate()	This function tells the plug-in that it should not be active.
protected java.lang.String	DefaultDict()
protected java.lang.String	DefaultQuery()
boolean	hasProperties()	Check to see if the plug-in has configurable properties
boolean	haveConfig()	This function indicates whether a directory is required to hold settings for our plug-in.
void	initialiseAtLoad()	This function is called at load-up, in case properties are needed...
boolean	isActive()	Allows JamochaMUD to check whether this plug-in is active and should be used.
java.lang.String	plugInDescription()	Returns a description, eg.
java.lang.String	plugInName()	This method returns the name of the plug-in
void	plugInProperties()	Any user configurable options for the plugin
java.lang.String	plugInType()	Returns a type of either input, output, or other
java.lang.String	plugMain(java.lang.String jamochaString, MuSocket mSock)	the core of the plugin
protected void	readSettings()	This method reads the MusicBox settings from a file.
void	setAtHalt()	Previously this function did most of the functions of deactivate() but now this is reserved solely for shutting down the plug-in and doing any necessary clean-up.
void	setSettings(JMConfig mainSettings)

Methods inherited from class java.lang.Object

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

Field Detail

COMMANDS_FILE

public static final java.lang.String COMMANDS_FILE

See Also:

Constant Field Values

Constructor Detail

DictPlugin

public DictPlugin()

Method Detail

setSettings

public void setSettings(JMConfig mainSettings)

plugInName

public java.lang.String plugInName()

This method returns the name of the plug-in

Specified by:

plugInName in interface PlugInterface

Returns:

plugInDescription

public java.lang.String plugInDescription()

Description copied from interface: PlugInterface

Returns a description, eg. author, date, build...

Specified by:

plugInDescription in interface PlugInterface

Returns:

Returns a human-readable description of what the plug-in does, as well as any other information such as author, date, version... what-ever the author deems important.

plugInType

public java.lang.String plugInType()

Description copied from interface: PlugInterface

Returns a type of either input, output, or other

Specified by:

plugInType in interface PlugInterface

Returns:

plugMain

public java.lang.String plugMain(java.lang.String jamochaString,
                                 MuSocket mSock)

Description copied from interface: PlugInterface

the core of the plugin

Specified by:

plugMain in interface PlugInterface

Returns:

plugInProperties

public void plugInProperties()

Description copied from interface: PlugInterface

Any user configurable options for the plugin

Specified by:

plugInProperties in interface PlugInterface

initialiseAtLoad

public void initialiseAtLoad()

Description copied from interface: PlugInterface

This function is called at load-up, in case properties are needed... eg. lists, settings

Specified by:

initialiseAtLoad in interface PlugInterface

setAtHalt

public void setAtHalt()

Description copied from interface: PlugInterface

Previously this function did most of the functions of deactivate() but now this is reserved solely for shutting down the plug-in and doing any necessary clean-up.

Specified by:

setAtHalt in interface PlugInterface

haveConfig

public boolean haveConfig()

Description copied from interface: PlugInterface

This function indicates whether a directory is required to hold settings for our plug-in. It is recommended for consistency to let JamochaMUD create and handle any plug-in directories. Plus, it means you can use less code in your plug-in!

Specified by:

haveConfig in interface PlugInterface

Returns:

true

- create a settings directory

false

- no directory required

hasProperties

public boolean hasProperties()

Description copied from interface: PlugInterface

Check to see if the plug-in has configurable properties

Specified by:

hasProperties in interface PlugInterface

Returns:

true

- plug-in can be configured

false

- plug-in cannot be configured

activate

public void activate()

Description copied from interface: PlugInterface

This function tells the plug-in that it should be functioning. See Deactive() for the inverse function. activate may be called more than once.

Specified by:

activate in interface PlugInterface

deactivate

public void deactivate()

Description copied from interface: PlugInterface

This function tells the plug-in that it should not be active. deactivate may be called more than once. Formerly this function was handled by setAtHalt.

Specified by:

deactivate in interface PlugInterface

isActive

public boolean isActive()

Description copied from interface: PlugInterface

Allows JamochaMUD to check whether this plug-in is active and should be used.

Specified by:

isActive in interface PlugInterface

Returns:

true - this plug-in is active false - this plug-in is not active

readSettings

protected void readSettings()

This method reads the MusicBox settings from a file.

DefaultDict

protected java.lang.String DefaultDict()

DefaultQuery

protected java.lang.String DefaultQuery()