Package com.zachsthings.libcomponents.bukkit

Class BasePlugin

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

com.zachsthings.libcomponents.bukkit.BasePlugin

All Implemented Interfaces:

org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.event.Listener, org.bukkit.plugin.Plugin

public abstract class BasePlugin
extends org.bukkit.plugin.java.JavaPlugin
implements org.bukkit.event.Listener

Base plugin for Bukkit libcomponents users

Field Summary

Fields

Modifier and Type	Field	Description
protected com.zachsthings.libcomponents.ComponentManager<BukkitComponent>	componentManager
protected com.sk89q.util.yaml.YAMLProcessor	config
boolean	lowPriorityCommandRegistration

Constructor Summary

Constructors

Constructor	Description
BasePlugin()

Method Summary

Modifier and Type	Method	Description
static <T extends org.bukkit.event.Event> T	callEvent(T event)
void	checkPermission(org.bukkit.command.CommandSender sender, String perm)	Checks permissions and throws an exception if permission is not met.
void	checkPermission(org.bukkit.command.CommandSender sender, org.bukkit.World world, String perm)
com.sk89q.util.yaml.YAMLProcessor	createConfiguration()	Create a new configuration.
void	createDefaultConfiguration(String name)	Create a default configuration file from the .jar.
com.zachsthings.libcomponents.ComponentManager<BukkitComponent>	getComponentManager()
com.sk89q.util.yaml.YAMLProcessor	getGlobalConfiguration()
com.sk89q.wepif.PermissionsResolverManager	getPermissionsResolver()	Get the permissions resolver.
boolean	hasPermission(org.bukkit.command.CommandSender sender, String perm)	Checks permissions.
boolean	hasPermission(org.bukkit.command.CommandSender sender, org.bukkit.World world, String perm)
void	loadConfiguration()
void	onDisable()
void	onEnable()
void	onPluginEnable(org.bukkit.event.server.PluginEnableEvent event)
com.sk89q.util.yaml.YAMLProcessor	populateConfiguration()	Deprecated. see populateConfiguration(YAMLProcessor) and createConfiguration()
void	populateConfiguration(com.sk89q.util.yaml.YAMLProcessor processor)
abstract void	registerComponentLoaders()
static org.bukkit.Server	server()

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

getClassLoader, getCommand, getConfig, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, isEnabled, isNaggable, onCommand, onLoad, onTabComplete, reloadConfig, 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

Methods inherited from interface org.bukkit.plugin.Plugin

getSLF4JLogger

Field Details

lowPriorityCommandRegistration

public boolean lowPriorityCommandRegistration

config

protected com.sk89q.util.yaml.YAMLProcessor config

componentManager

protected com.zachsthings.libcomponents.ComponentManager<BukkitComponent> componentManager

Constructor Details

BasePlugin

public BasePlugin()

Method Details

server

public static org.bukkit.Server server()

callEvent

public static <T extends org.bukkit.event.Event> T callEvent(T event)

onDisable

public void onDisable()

Specified by:

onDisable in interface org.bukkit.plugin.Plugin

Overrides:

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

onEnable

public void onEnable()

Specified by:

onEnable in interface org.bukkit.plugin.Plugin

Overrides:

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

onPluginEnable

public void onPluginEnable(org.bukkit.event.server.PluginEnableEvent event)

registerComponentLoaders

public abstract void registerComponentLoaders()

createConfiguration

public com.sk89q.util.yaml.YAMLProcessor createConfiguration()

Create a new configuration. This method is only called once on server start and should be used to setup base configuration information and migrate legacy configurations

Returns:

The initialized configuration

loadConfiguration

public void loadConfiguration()

populateConfiguration

@Deprecated
public com.sk89q.util.yaml.YAMLProcessor populateConfiguration()

Deprecated.

see populateConfiguration(YAMLProcessor) and createConfiguration()

No longer used

Returns:

The new configuration instance

populateConfiguration

public void populateConfiguration(com.sk89q.util.yaml.YAMLProcessor processor)

getPermissionsResolver

public com.sk89q.wepif.PermissionsResolverManager getPermissionsResolver()

Get the permissions resolver.

Returns:

The permissions resolver

getGlobalConfiguration

public com.sk89q.util.yaml.YAMLProcessor getGlobalConfiguration()

getComponentManager

public com.zachsthings.libcomponents.ComponentManager<BukkitComponent> getComponentManager()

createDefaultConfiguration

public void createDefaultConfiguration(String name)

Create a default configuration file from the .jar.

Parameters:

name - the filename for the default configuration file

hasPermission

public boolean hasPermission(org.bukkit.command.CommandSender sender,
 String perm)

Checks permissions.

Parameters:

sender - The sender to check

perm - The permission to check

Returns:

Whether the sender has the permission

hasPermission

public boolean hasPermission(org.bukkit.command.CommandSender sender,
 org.bukkit.World world,
 String perm)

checkPermission

public void checkPermission(org.bukkit.command.CommandSender sender,
 String perm)
                     throws com.sk89q.minecraft.util.commands.CommandPermissionsException

Checks permissions and throws an exception if permission is not met.

Parameters:

sender - The sender to check

perm - the permission to check

Throws:

com.sk89q.minecraft.util.commands.CommandPermissionsException - if the sender doesn't have the required permission

checkPermission

public void checkPermission(org.bukkit.command.CommandSender sender,
 org.bukkit.World world,
 String perm)
                     throws com.sk89q.minecraft.util.commands.CommandPermissionsException

Throws:

com.sk89q.minecraft.util.commands.CommandPermissionsException