Package anecho.JamochaMUD.plugins

Class PathWalker

java.lang.Object

anecho.JamochaMUD.plugins.PathWalker

All Implemented Interfaces:

PlugInterface

public class PathWalker
extends java.lang.Object
implements PlugInterface

Constructor Summary

Constructors

Constructor	Description
PathWalker()	useless constructor

Method Summary

Modifier and Type	Method	Description
void	activate()	Interface method to activate the plug-in
void	deactivate()	Interface method to deactivate the plug-in
boolean	hasProperties()	Interface method to determine if we have configuration -- we don't.
boolean	haveConfig()	Interface method to determine if we have external config; we do.
void	initialiseAtLoad()	Interface method for initialization -- read in saved macros
boolean	isActive()	Interface method to determine if we're active
java.lang.String	plugInDescription()	Interface method to return plug-in description
java.lang.String	plugInName()	Interface method to return plug-in name
void	plugInProperties()	Interface method for configuring properties; don't have any.
java.lang.String	plugInType()	Interface method to return plug-in type
java.lang.String	plugMain(java.lang.String jString, MuSocket mSock)	primary interface method
void	setAtHalt()	interface method to clean up at shutdown -- save our paths.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathWalker

public PathWalker()

useless constructor

Method Detail

plugInName

public java.lang.String plugInName()

Interface method to return plug-in name

Specified by:

plugInName in interface PlugInterface

Returns:

Returns a human-readable string of the plug-in's name.

plugInDescription

public java.lang.String plugInDescription()

Interface method to return plug-in description

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

Interface method to return plug-in type

Specified by:

plugInType in interface PlugInterface

Returns:

plugMain

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

primary interface method

Specified by:

plugMain in interface PlugInterface

Parameters:

jString - input command

mSock - mud connection

Returns:

modified string written to gui and connection

plugInProperties

public void plugInProperties()

Interface method for configuring properties; don't have any.

Specified by:

plugInProperties in interface PlugInterface

hasProperties

public boolean hasProperties()

Interface method to determine if we have configuration -- we don't.

Specified by:

hasProperties in interface PlugInterface

Returns:

true

- plug-in can be configured

false

- plug-in cannot be configured

initialiseAtLoad

public void initialiseAtLoad()

Interface method for initialization -- read in saved macros

Specified by:

initialiseAtLoad in interface PlugInterface

activate

public void activate()

Interface method to activate the plug-in

Specified by:

activate in interface PlugInterface

setAtHalt

public void setAtHalt()

interface method to clean up at shutdown -- save our paths. Depending on how the client is shutdown, this method may not get called.

Specified by:

setAtHalt in interface PlugInterface

deactivate

public void deactivate()

Interface method to deactivate the plug-in

Specified by:

deactivate in interface PlugInterface

isActive

public boolean isActive()

Interface method to determine if we're active

Specified by:

isActive in interface PlugInterface

Returns:

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

haveConfig

public boolean haveConfig()

Interface method to determine if we have external config; we do.

Specified by:

haveConfig in interface PlugInterface

Returns:

true

- create a settings directory

false

- no directory required