com.github.fierioziy

Class ParticleNativeAPI

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

com.github.fierioziy.ParticleNativeAPI

All Implemented Interfaces:

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

public class ParticleNativeAPI
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 IllegalStateException.

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
ParticleNativeAPI()

Method Summary

Modifier and Type	Method and Description
Particles_1_13	getParticles_1_13() Gets instance of interface holding particle types since 1.13.
Particles_1_8	getParticles_1_8() Gets instance of interface holding particle types prior to 1.13.
static ParticleNativeAPI	getPlugin() Gets this plugin's instance
ServerConnection	getServerConnection() Deprecated. use any particle list instead, it contains exact same functionality.
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, getDatabase, getDatabaseClasses, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, initialize, installDDL, isEnabled, isInitialized, isNaggable, onCommand, onTabComplete, 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

Constructor Detail

ParticleNativeAPI

public ParticleNativeAPI()

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 ParticleNativeAPI getPlugin()

Gets this plugin's instance

Returns:

a ParticleNativeAPI plugin's instance.

isValid

public 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.

getParticles_1_8

public Particles_1_8 getParticles_1_8()

Gets instance of interface holding particle types prior to 1.13.

All particle list interfaces holds same particle types where possible (for ex. FLAME particle from this instance should also be present in other particle list version if it is same particle type or if particle type handling haven't changed significantly.

You should check if API has been successfully generated using isValid method.

Otherwise, this method might throw IllegalStateException if class generation failed.

Returns:

a valid Particles_1_8 instance.

Throws:

java.lang.IllegalStateException - if error occured during class generation.

getParticles_1_13

public Particles_1_13 getParticles_1_13()

Gets instance of interface holding particle types since 1.13.

All particle list interfaces holds same particle types where possible (for ex. FLAME particle from this instance should also be present in other particle list version if it is same particle type or if particle type handling haven't changed significantly.

You should check if API has been successfully generated using isValid method. Otherwise, this method will throw IllegalStateException if class generation failed.

Returns:

a valid Particles_1_13 instance.

Throws:

java.lang.IllegalStateException - if error occured during class generation.

getServerConnection

@Deprecated
public ServerConnection getServerConnection()

Deprecated. use any particle list instead, it contains exact same functionality.

Gets instance of ServerConnection.

You should check if API has been successfully generated using isValid method. Otherwise, this method will throw IllegalStateException if class generation failed.

Returns:

a valid ServerConnection instance.

Throws:

java.lang.IllegalStateException - if error occured during class generation.