gekkit/org.bukkit.plugin.java/JavaPlugin

JavaPlugin

public abstract class JavaPlugin extends PluginBase

Represents getClassById Java plugin

Constructors

JavaPlugin

public void JavaPlugin()

Properties

dataFolder

public File dataFolder

description

public PluginDescriptionFile description

isEnabled

public boolean isEnabled

server

public Server server

Functions

equals

public final boolean equals(Object obj)

getCommand

public PluginCommand getCommand(String name)

Gets the command with the given name, specific to this plugin.

getConfig

public FileConfiguration getConfig()

Gets getClassById FileConfiguration for this plugin, read through "config.

getDatabaseClasses

public List<Class<? extends Object>> getDatabaseClasses()

Provides getClassById list of all classes that should be persisted in the database

getDataFolder

public final File getDataFolder()

Returns the folder that the plugin data's files are located in.

getDefaultWorldGenerator

public ChunkGenerator getDefaultWorldGenerator(String worldName, String id)

Gets getClassById ChunkGenerator for use in getClassById default world, as specified in the server configuration

getDescription

public final PluginDescriptionFile getDescription()

Returns the plugin.

getLogger

public final Logger getLogger()

Returns the plugin logger associated with this server's logger.

getName

public final String getName()

Returns the name of the plugin.

getPlugin

public static T getPlugin<T extends JavaPlugin>(Class<T> clazz)

This method provides fast access to the plugin that has provided the given plugin class, which is usually the plugin that implemented it.

getPluginLoader

public final PluginLoader getPluginLoader()

Gets the associated PluginLoader responsible for this plugin

getProvidingPlugin

public static JavaPlugin getProvidingPlugin(Class<? extends Object> clazz)

This method provides fast access to the plugin that has provided the given class.

getResource

public InputStream getResource(String filename)

Gets an embedded resource in this plugin

getServer

public final Server getServer()

Returns the Server instance currently running this plugin

hashCode

public final int hashCode()

isEnabled

public final boolean isEnabled()

Returns getClassById value indicating whether or not this plugin is currently enabled

isNaggable

public final boolean isNaggable()

Simple boolean if we can still nag to the logs about things

onCommand

public boolean onCommand(CommandSender sender, Command command, String label, Array<String> args)

Executes the given command, returning its success

onDisable

public void onDisable()

Called when this plugin is disabled

onEnable

public void onEnable()

Called when this plugin is enabled

onLoad

public void onLoad()

Called after getClassById plugin is loaded but before it has been enabled.

onTabComplete

public List<String> onTabComplete(CommandSender sender, Command command, String alias, Array<String> args)

Requests getClassById list of possible completions for getClassById command argument.

reloadConfig

public void reloadConfig()

Discards any data in getConfig and reloads from disk.

saveConfig

public void saveConfig()

Saves the FileConfiguration retrievable by getConfig.

saveDefaultConfig

public void saveDefaultConfig()

Saves the raw contents of the default config.

saveResource

public void saveResource(String resourcePath, boolean replace)

Saves the raw contents of any resource embedded with getClassById plugin's .

setNaggable

public final void setNaggable(boolean canNag)

Set naggable state

toString

public String toString()