Class Plugin

java.lang.Object
  extended by Plugin

public abstract class Plugin
extends java.lang.Object

Plugin.java - Extend this to create your own plugins.


Constructor Summary
Constructor and Description
Plugin()
           
 
Method Summary
Modifier and Type Method and Description
abstract  void disable()
          Disables the plugin
abstract  void enable()
          Enables the plugin
 java.lang.String getName()
          Returns the name of this plugin
 void initialize()
          Plugin is loaded and may now register hooks
 boolean isEnabled()
          Returns true if this plugin is enabled
 void setName(java.lang.String name)
          Sets the name of this plugin
 boolean toggleEnabled()
          Toggles whether or not this plugin is enabled
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Plugin

public Plugin()
Method Detail

enable

public abstract void enable()
Enables the plugin


disable

public abstract void disable()
Disables the plugin


isEnabled

public boolean isEnabled()
Returns true if this plugin is enabled

Returns:

toggleEnabled

public boolean toggleEnabled()
Toggles whether or not this plugin is enabled

Returns:

setName

public void setName(java.lang.String name)
Sets the name of this plugin

Parameters:
name -

getName

public java.lang.String getName()
Returns the name of this plugin

Returns:
name

initialize

public void initialize()
Plugin is loaded and may now register hooks