anecho.JamochaMUD.plugins
Class FBLocationPlugIn

java.lang.Object
  anecho.JamochaMUD.plugins.FBLocationPlugIn

All Implemented Interfaces:

PlugInterface

public class FBLocationPlugIn
extends java.lang.Object
implements PlugInterface

This PlugIn strips the [fmcl] indicators from FurryMUCK locations, and places them as the window'start title

Constructor Summary

FBLocationPlugIn()

Method Summary

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.
boolean	hasProperties() We have no editable properties
boolean	haveConfig() We don't require a directory for our settings
void	initialiseAtLoad() Call to initialise any functions required immediately when the plug-in is loaded.
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() Returns the plugin's proper name
void	plugInProperties() This plug-in has no properties to display
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
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) Set the variable for the JamochaMUD settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

FBLocationPlugIn

public FBLocationPlugIn()

Method Detail

setSettings

public void setSettings(JMConfig mainSettings)

Set the variable for the JamochaMUD settings. This method may need to be deprecated. Fix Me XXX

Parameters:

mainSettings - Main JamochaMUD settings.

plugInName

public java.lang.String plugInName()

Description copied from interface: PlugInterface

Returns the plugin's proper name

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:

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

Parameters:

jamochaString -

mSock -

Returns:

plugInProperties

public void plugInProperties()

This plug-in has no properties to display

Specified by:

plugInProperties in interface PlugInterface

initialiseAtLoad

public void initialiseAtLoad()

Call to initialise any functions required immediately when the plug-in is loaded.

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()

We don't require a directory for our settings

Specified by:

haveConfig in interface PlugInterface

Returns:

hasProperties

public boolean hasProperties()

We have no editable properties

Specified by:

hasProperties in interface PlugInterface

Returns:

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: