PlugInterface
public class Trigger extends java.lang.Object implements PlugInterface
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
AND |
|
static java.lang.String |
COLOUR |
|
static java.lang.String |
DONE |
|
static java.lang.String |
GAG |
|
static java.lang.String |
LAUNCH |
|
static java.lang.String |
MATCHONLY |
|
static java.lang.String |
MEDIA |
|
static java.lang.String |
MODIFIER |
|
static java.lang.String |
NAME |
|
static java.lang.String |
NONE |
|
static java.lang.String |
NOT |
|
static java.lang.String |
RULENAME |
|
static java.lang.String |
RULES |
|
static java.lang.String |
TRIGGERSTR |
Constructor | Description |
---|---|
Trigger() |
Creates a new instance of Trigger This method is here for the sake of
"proper" code
|
Modifier and Type | Method | Description |
---|---|---|
void |
activate() |
This function tells the plug-in that it should be functioning.
|
void |
deactivate() |
The method deactivates the plug-in
|
boolean |
hasProperties() |
This tells the main program whether the plug-in has user-accessible
properties.
|
boolean |
haveConfig() |
Returns whether there is a (GUI) configuration available for the plug-in.
|
void |
initialiseAtLoad() |
This method initialises any variables needed by the plug-in audStream
soon audStream it is loaded.
|
boolean |
isActive() |
Allows JamochaMUD to check whether this plug-in is active
and should be used.
|
java.lang.String |
plugInDescription() |
This method returns a String with a brief description of the plug-in's
function.
|
java.lang.String |
plugInName() |
This returns the name of the plug-in for display to the user.
|
void |
plugInProperties() |
Displays properties for the plug-in that users can adjust.
|
java.lang.String |
plugInType() |
Type of plug-in: input, output, or other.
|
java.lang.String |
plugMain(java.lang.String jamochaString,
MuSocket mSock) |
The main method of the plug-in.
|
void |
setAtHalt() |
This is called when JamochaMUD stops, and can be used for any final
clean-up, file saving, etc.
|
void |
setSettings(JMConfig settings) |
|
void |
writeRulesToFile(java.util.Vector newRules) |
Upon approval by the user, we'll write the rules back to the file
|
public static final java.lang.String RULES
public static final java.lang.String RULENAME
public static final java.lang.String COLOUR
public static final java.lang.String LAUNCH
public static final java.lang.String MATCHONLY
public static final java.lang.String MEDIA
public static final java.lang.String NAME
public static final java.lang.String TRIGGERSTR
public static final java.lang.String DONE
public static final java.lang.String MODIFIER
public static final java.lang.String NOT
public static final java.lang.String AND
public static final java.lang.String NONE
public static final java.lang.String GAG
public Trigger()
public void activate()
PlugInterface
activate
in interface PlugInterface
public void deactivate()
deactivate
in interface PlugInterface
public boolean isActive()
PlugInterface
isActive
in interface PlugInterface
public boolean hasProperties()
hasProperties
in interface PlugInterface
public void initialiseAtLoad()
initialiseAtLoad
in interface PlugInterface
public java.lang.String plugInDescription()
plugInDescription
in interface PlugInterface
public java.lang.String plugInName()
plugInName
in interface PlugInterface
public void plugInProperties()
plugInProperties
in interface PlugInterface
public java.lang.String plugInType()
plugInType
in interface PlugInterface
public java.lang.String plugMain(java.lang.String jamochaString, MuSocket mSock)
plugMain
in interface PlugInterface
jamochaString
- The incoming StringmSock
- This is the socket this String belongs topublic void setAtHalt()
setAtHalt
in interface PlugInterface
public boolean haveConfig()
haveConfig
in interface PlugInterface
true
This plug-in has a configuration GUIpublic void setSettings(JMConfig settings)
settings
- public void writeRulesToFile(java.util.Vector newRules)
newRules
-