com.github.fierioziy.particlenativeapi.api

Interface ParticleNativeAPI

public interface 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.
ServerConnection	getServerConnection() Deprecated. use any particle list instead, it contains exact same functionality.

Method Detail

getParticles_1_8

Particles_1_8 getParticles_1_8()
                        throws ParticleException

Gets instance of interface holding particle types prior to 1.13.

All particle lists attempt to provide same particle types between renames or merges. They also attempt to provide cross-version compatibility (for ex. usage of ENCHANTED_HIT effect name from Particles_1_13 should work on MC 1.8), however this is not always possible.

Use isValid method on particle type to handle such cases.

Before accessing any particle type, you should check if it exists on server by an isValid defined by all particle types in this interface.

This method might throw ParticleException if class generation failed (by a plugin).

Returns:

a valid Particles_1_8 instance.

Throws:

ParticleException - if error occurred during class generation (by a plugin).

getParticles_1_13

Particles_1_13 getParticles_1_13()
                          throws ParticleException

Gets instance of interface holding particle types since 1.13.

All particle lists attempt to provide same particle types between renames or merges. They also attempt to provide cross-version compatibility (for ex. usage of ENCHANTED_HIT effect name from Particles_1_13 should work on MC 1.8), however this is not always possible.

Use isValid method on particle type to handle such cases.

Before accessing any particle type, you should check if it exists on server by an isValid defined by all particle types in this interface.

This method might throw ParticleException if class generation failed (by a plugin).

Returns:

a valid Particles_1_13 instance.

Throws:

ParticleException - if error occurred during class generation (by a plugin).

getServerConnection

@Deprecated
ServerConnection getServerConnection()
                                           throws ParticleException

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

Gets instance of ServerConnection.

This method will throw ParticleException if class generation failed (by a plugin).

Returns:

a valid ServerConnection instance.

Throws:

ParticleException - if error occurred during class generation (by a plugin).