anecho.JamochaMUD.plugins
Class TimeStamp

java.lang.Object
  anecho.JamochaMUD.plugins.TimeStamp

All Implemented Interfaces:

PlugInterface

public class TimeStamp
extends java.lang.Object
implements PlugInterface

TimeStamp is a class that allows the user to put a time stamp at the beginning of lines of text received in the output window. The format of the time is user-definable.

Constructor Summary

TimeStamp()

Method Summary

void	activate() This function is automatically called by JamochaMUD when the plug-in is first activated (at each JamochaMUD start-up).
void	deactivate() This function is automatically called by JamochaMUD when the plug-in is set inactive from the JamochaMUD "Manage Plug-Ins" dialogue.
boolean	hasProperties() If a plug-in has properties that can be configured via a GUI, this method should return true, otherwise it should return false.
boolean	haveConfig() This method tells JamochaMUD whether this plugin should have its own person configuration directory where it can keep its settings.
void	initialiseAtLoad() This method is called as soon as the plugin is first loaded.
boolean	isActive() Allows JamochaMUD to check whether this plug-in is active and should be used.
java.lang.String	plugInDescription() A basic description of the plug-in that is shown in the JamochaMUD "Manage Plugins" dialogue box
java.lang.String	plugInName() This method returns the name of the plug-in
void	plugInProperties() This method is called by the "Properties" option in the JamochaMUD "Manage plugins" dialogue box.
java.lang.String	plugInType() This indicates what type of plugin this is, ie: input or output.
java.lang.String	plugMain(java.lang.String jamochaString, MuSocket mSock) This is the main method of the plug-in.
protected void	saveSettings() This method saves the current MusicBox settings to a file.
void	setAtHalt() The method is automatically called when JamochaMUD is quit by using the File -> Exit menu or the close window icon.
void	setSettings(JMConfig mainSettings)

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeStamp

public TimeStamp()

Method Detail

setSettings

public void setSettings(JMConfig mainSettings)

Parameters:

mainSettings -

plugInName

public java.lang.String plugInName()

This method returns the name of the plug-in

Specified by:

plugInName in interface PlugInterface

Returns:

A string containing the human readable name of this plug-in.

plugInDescription

public java.lang.String plugInDescription()

A basic description of the plug-in that is shown in the JamochaMUD "Manage Plugins" dialogue box

Specified by:

plugInDescription in interface PlugInterface

Returns:

A human-readable String with a brief description of what this plug-in does.

plugInType

public java.lang.String plugInType()

This indicates what type of plugin this is, ie: input or output. This setting will affect what information JamochaMUD tries to process with this plug-in. If the plug-in is set to a setting that JamochaMUD does not understand than the plugin will be ignored.

Specified by:

plugInType in interface PlugInterface

Returns:

plugMain

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

This is the main method of the plug-in. It is passed both a string for processing as well as and associated MU* that the message is coming from/going to.

Specified by:

plugMain in interface PlugInterface

Parameters:

jamochaString - The string received from the MU* and to be processed.

mSock - The connection that the given string belongs to.

Returns:

This returns the processed version of the originally received string.

plugInProperties

public void plugInProperties()

This method is called by the "Properties" option in the JamochaMUD "Manage plugins" dialogue box. Any settings that you wish the user to have access to can be configured through this method

Specified by:

plugInProperties in interface PlugInterface

initialiseAtLoad

public void initialiseAtLoad()

This method is called as soon as the plugin is first loaded. It is useful for loading or configuring anything needed by the plug-in at start-up (such as loading settings). This method is only called when JamochaMUD first loads the plug-in, even if the plug-in is not currently enabled.

Specified by:

initialiseAtLoad in interface PlugInterface

setAtHalt

public void setAtHalt()

The method is automatically called when JamochaMUD is quit by using the File -> Exit menu or the close window icon. This method will not be called if JamochaMUD is "killed" or crashes. This section is useful for writing any settings back to disk.

Specified by:

setAtHalt in interface PlugInterface

haveConfig

public boolean haveConfig()

This method tells JamochaMUD whether this plugin should have its own person configuration directory where it can keep its settings. A return of false means that the plugin has no settings that need to be saved to disk. A return of true tells JamochaMUD to create a settings directory for this plugin (if one does not already exist).

Specified by:

haveConfig in interface PlugInterface

Returns:

hasProperties

public boolean hasProperties()

If a plug-in has properties that can be configured via a GUI, this method should return true, otherwise it should return false. When settings this result to true, it indicates to JamochaMUD that the PlugInProperties method may be called.

Specified by:

hasProperties in interface PlugInterface

Returns:

activate

public void activate()

This function is automatically called by JamochaMUD when the plug-in is first activated (at each JamochaMUD start-up). This may be called if the plug-in was active the last time JamochaMUD was stopped, or when it is set active from the "Manage Plug-Ins" dialogue. It can be useful for setting up items that you did not want setup during the normal initialisation of the plug-in.

Specified by:

activate in interface PlugInterface

deactivate

public void deactivate()

This function is automatically called by JamochaMUD when the plug-in is set inactive from the JamochaMUD "Manage Plug-Ins" dialogue. With this method, you can easily deactive items that may have initially been setup by the Activate method (such as removing listeners, etc.).

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:

saveSettings

protected void saveSettings()

This method saves the current MusicBox settings to a file.