Bukkit  1.5.2-R1.0
 All Classes Namespaces Files Functions Variables Enumerator Pages
org.bukkit.plugin.PluginBase Class Reference

Represents a base Plugin. More...

+ Inheritance diagram for org.bukkit.plugin.PluginBase:
+ Collaboration diagram for org.bukkit.plugin.PluginBase:

Public Member Functions

final int hashCode ()
 
final boolean equals (Object obj)
 
final String getName ()
 
- Public Member Functions inherited from org.bukkit.plugin.Plugin
File getDataFolder ()
 Returns the folder that the plugin data's files are located in.
 
PluginDescriptionFile getDescription ()
 Returns the plugin.yaml file containing the details for this plugin.
 
FileConfiguration getConfig ()
 Gets a FileConfiguration for this plugin, read through "config.yml".
 
InputStream getResource (String filename)
 Gets an embedded resource in this plugin.
 
void saveConfig ()
 Saves the FileConfiguration retrievable by getConfig().
 
void saveDefaultConfig ()
 Saves the raw contents of the default config.yml file to the location retrievable by getConfig().
 
void saveResource (String resourcePath, boolean replace)
 Saves the raw contents of any resource embedded with a plugin's .jar file assuming it can be found using getResource(String).
 
void reloadConfig ()
 Discards any data in getConfig() and reloads from disk.
 
PluginLoader getPluginLoader ()
 Gets the associated PluginLoader responsible for this plugin.
 
Server getServer ()
 Returns the Server instance currently running this plugin.
 
boolean isEnabled ()
 Returns a value indicating whether or not this plugin is currently enabled.
 
void onDisable ()
 Called when this plugin is disabled.
 
void onLoad ()
 Called after a plugin is loaded but before it has been enabled.
 
void onEnable ()
 Called when this plugin is enabled.
 
boolean isNaggable ()
 Simple boolean if we can still nag to the logs about things.
 
void setNaggable (boolean canNag)
 Set naggable state.
 
EbeanServer getDatabase ()
 Gets the EbeanServer tied to this plugin.
 
ChunkGenerator getDefaultWorldGenerator (String worldName, String id)
 Gets a ChunkGenerator for use in a default world, as specified in the server configuration.
 
Logger getLogger ()
 Returns the primary logger associated with this server instance.
 
String getName ()
 Returns the name of the plugin.
 

Detailed Description

Represents a base Plugin.

Extend this class if your plugin is not a org.bukkit.plugin.java.JavaPlugin

Definition at line 8 of file PluginBase.java.

Member Function Documentation

final boolean org.bukkit.plugin.PluginBase.equals ( Object  obj)

Definition at line 15 of file PluginBase.java.

References org.bukkit.plugin.PluginBase.getName().

final String org.bukkit.plugin.PluginBase.getName ( )
final int org.bukkit.plugin.PluginBase.hashCode ( )

Definition at line 10 of file PluginBase.java.

References org.bukkit.plugin.PluginBase.getName().


The documentation for this class was generated from the following file: