taco.tacoapi.api

Class TacoPlugin

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

taco.tacoapi.api.TacoPlugin

All Implemented Interfaces:

org.bukkit.command.CommandExecutor, org.bukkit.plugin.Plugin

Direct Known Subclasses:

TacoAPI

public abstract class TacoPlugin
extends org.bukkit.plugin.java.JavaPlugin

Represents a plugin using the API.

Author:

KILL3RTACO

Field Summary

Fields

Modifier and Type	Field and Description
private static TacoChatUtils	cu
private static java.lang.String	name

Constructor Summary

Constructors

Constructor and Description
TacoPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
void	broadcast(java.lang.String message) Outputs a message to the server (and console).
static TacoChatUtils	getChatUtils() Gets the TacoChatUtils object for this plugin.
static java.lang.String	getInheritedPluginName() Gets the name of the inherited TacoPlugin.
abstract void	onDisable() Default Bukkit onDisable()
abstract void	onEnable() Default Bukkit onEnable()
void	print(java.lang.String msg) Outputs a message to the console.
protected void	registerCommand(TacoCommandHandler handler) Registers a command for the server, this should be used instead of the getCommand() method.
protected void	setName(java.lang.String pluginName) Sets the name of this plugin.

Methods inherited from class org.bukkit.plugin.java.JavaPlugin

getClassLoader, getCommand, getConfig, getDatabase, getDatabaseClasses, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPluginLoader, getResource, getServer, initialize, installDDL, isEnabled, isInitialized, isNaggable, onCommand, onLoad, reloadConfig, removeDDL, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString

Methods inherited from class org.bukkit.plugin.PluginBase

equals, getName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

cu

private static TacoChatUtils cu

name

private static java.lang.String name

Constructor Detail

TacoPlugin

public TacoPlugin()

Method Detail

onEnable

public abstract void onEnable()

Default Bukkit onEnable()

Specified by:

onEnable in interface org.bukkit.plugin.Plugin

Overrides:

onEnable in class org.bukkit.plugin.java.JavaPlugin

onDisable

public abstract void onDisable()

Default Bukkit onDisable()

Specified by:

onDisable in interface org.bukkit.plugin.Plugin

Overrides:

onDisable in class org.bukkit.plugin.java.JavaPlugin

print

public void print(java.lang.String msg)

Outputs a message to the console. The message will be prefixed with [<PluginName>]

Parameters:

msg - - The message to be printed

setName

protected void setName(java.lang.String pluginName)

Sets the name of this plugin.

broadcast

public void broadcast(java.lang.String message)

Outputs a message to the server (and console). This message can be color coded.

Parameters:

message - - The message to broadcast

registerCommand

protected void registerCommand(TacoCommandHandler handler)

Registers a command for the server, this should be used instead of the getCommand() method.

Parameters:

handler -

getChatUtils

public static TacoChatUtils getChatUtils()

Gets the TacoChatUtils object for this plugin.

Returns:

The TacoChatUtils object for this plugin

getInheritedPluginName

public static java.lang.String getInheritedPluginName()

Gets the name of the inherited TacoPlugin. This name must be initialized in the onEnable() method of the main class using setName() in order to work

Returns:

The name of the inherited TacoPlugin