com.github.fierioziy.particlenativeapi.plugin

Class ParticleNativePlugin

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

com.github.fierioziy.particlenativeapi.plugin.ParticleNativePlugin

All Implemented Interfaces:

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

public class ParticleNativePlugin
extends org.bukkit.plugin.java.JavaPlugin

A main JavaPlugin instance.

It is responsible for providing class implementation for particle type list. If any error occurs during class generation, a isValid method will return false and any API access to this instance will throw ParticleException.

Therefore, before accessing any particles list you must check, if plugin API is valid by a isValid method call.

Constructor Summary

Constructors

Constructor and Description
ParticleNativePlugin()

Method Summary

Modifier and Type	Method and Description
static com.github.fierioziy.particlenativeapi.api.ParticleNativeAPI	getAPI() Gets underlying particle API generated by a plugin.
static ParticleNativePlugin	getPlugin() Gets this plugin's instance
static boolean	isValid() Checks if an API has been properly generated and is ready for use.
void	onDisable()
void	onEnable()
void	onLoad()

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, 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

Constructor Detail

ParticleNativePlugin

public ParticleNativePlugin()

Method Detail

onLoad

public void onLoad()

Specified by:

onLoad in interface org.bukkit.plugin.Plugin

Overrides:

onLoad 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

onDisable

public void onDisable()

Specified by:

onDisable in interface org.bukkit.plugin.Plugin

Overrides:

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

getPlugin

public static ParticleNativePlugin getPlugin()

Gets this plugin's instance

Returns:

a ParticleNativePlugin instance.

getAPI

public static com.github.fierioziy.particlenativeapi.api.ParticleNativeAPI getAPI()

Gets underlying particle API generated by a plugin.

Returns:

a ParticleNativeAPI instance.

Throws:

com.github.fierioziy.particlenativeapi.api.utils.ParticleException - if error occurred during class generation.

isValid

public static boolean isValid()

Checks if an API has been properly generated and is ready for use.

Returns:

true if API has been successfully created, false otherwise.