com.github.fierioziy.api.types

Class ParticleType

java.lang.Object

com.github.fierioziy.api.types.ParticleType

Direct Known Subclasses:

ParticleTypeColorable, ParticleTypeMotion, ParticleTypeNote, ParticleTypeRedstone

public class ParticleType
extends java.lang.Object

Class used to represent particle type with no additional features.

It provides a non-reflective packet method overloads to construct particle packet with desired parameters.

All packet methods does not validate parameters in any way.

Constructor Summary

Constructors

Constructor and Description
ParticleType()

Method Summary

Modifier and Type	Method and Description
boolean	isValid() Checks if this particle is supported by this Spigot version.
java.lang.Object	packet(boolean far, double x, double y, double z) Construct particle packet that will spawn 1 particle at specified position.
java.lang.Object	packet(boolean far, double x, double y, double z, double offsetX, double offsetY, double offsetZ, double speed, int count) Construct particle packet that will spawn count particles at specified position using provided offset parameters and speed parameter.
java.lang.Object	packet(boolean far, double x, double y, double z, double offsetX, double offsetY, double offsetZ, int count) Construct particle packet that will spawn count particles at specified position using provided offset parameters.
java.lang.Object	packet(boolean far, double x, double y, double z, double speed, int count) Construct particle packet that will spawn count particles at specified position using speed parameter.
java.lang.Object	packet(boolean far, double x, double y, double z, int count) Construct particle packet that will spawn count particles at specified position.
java.lang.Object	packet(boolean far, float x, float y, float z, float offsetX, float offsetY, float offsetZ, float speed, int count) Deprecated. will be removed in a future, use version with doubles instead (it will be faster after removal)
java.lang.Object	packet(boolean far, org.bukkit.Location loc) Construct particle packet that will spawn 1 particle at specified position.
java.lang.Object	packet(boolean far, org.bukkit.Location loc, double offsetX, double offsetY, double offsetZ, double speed, int count) Construct particle packet that will spawn count particles at specified position using provided offset parameters and speed parameter.
java.lang.Object	packet(boolean far, org.bukkit.Location loc, double offsetX, double offsetY, double offsetZ, int count) Construct particle packet that will spawn count particles at specified position using provided offset parameters.
java.lang.Object	packet(boolean far, org.bukkit.Location loc, double speed, int count) Construct particle packet that will spawn count particles at specified position using speed parameter.
java.lang.Object	packet(boolean far, org.bukkit.Location loc, int count) Construct particle packet that will spawn count particles at specified position.
java.lang.Object	packet(boolean far, org.bukkit.util.Vector loc) Construct particle packet that will spawn 1 particle at specified position.
java.lang.Object	packet(boolean far, org.bukkit.util.Vector loc, double offsetX, double offsetY, double offsetZ, double speed, int count) Construct particle packet that will spawn count particles at specified position using provided offset parameters and speed parameter.
java.lang.Object	packet(boolean far, org.bukkit.util.Vector loc, double offsetX, double offsetY, double offsetZ, int count) Construct particle packet that will spawn count particles at specified position using provided offset parameters.
java.lang.Object	packet(boolean far, org.bukkit.util.Vector loc, double speed, int count) Construct particle packet that will spawn count particles at specified position using speed parameter.
java.lang.Object	packet(boolean far, org.bukkit.util.Vector loc, int count) Construct particle packet that will spawn count particles at specified position.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParticleType

public ParticleType()

Method Detail

packet

public java.lang.Object packet(boolean far,
                               org.bukkit.Location loc)

Construct particle packet that will spawn 1 particle at specified position.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

loc - a Location containing position.

Returns:

a valid NMS Packet object.

Throws:

java.lang.IllegalStateException - when requested particle type is not supported by this server version.

packet

public java.lang.Object packet(boolean far,
                               org.bukkit.util.Vector loc)

Construct particle packet that will spawn 1 particle at specified position.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

loc - a Vector containing position.

Returns:

a valid NMS Packet object.

Throws:

java.lang.IllegalStateException - when requested particle type is not supported by this server version.

packet

public java.lang.Object packet(boolean far,
                               double x,
                               double y,
                               double z)

Construct particle packet that will spawn 1 particle at specified position.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

x - component of a position.

y - component of a position.

z - component of a position.

Returns:

a valid NMS Packet object.

Throws:

java.lang.IllegalStateException - when requested particle type is not supported by this server version.

packet

public java.lang.Object packet(boolean far,
                               org.bukkit.Location loc,
                               int count)

Construct particle packet that will spawn count particles at specified position.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

loc - a Location containing position.

count - amount of particles to spawn.

Returns:

a valid NMS Packet object.

Throws:

java.lang.IllegalStateException - when requested particle type is not supported by this server version.

packet

public java.lang.Object packet(boolean far,
                               org.bukkit.util.Vector loc,
                               int count)

Construct particle packet that will spawn count particles at specified position.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

loc - a Vector containing position.

count - amount of particles to spawn.

Returns:

a valid NMS Packet object.

Throws:

java.lang.IllegalStateException - when requested particle type is not supported by this server version.

packet

public java.lang.Object packet(boolean far,
                               double x,
                               double y,
                               double z,
                               int count)

Construct particle packet that will spawn count particles at specified position.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

x - component of a position.

y - component of a position.

z - component of a position.

count - amount of particles to spawn.

Returns:

a valid NMS Packet object.

Throws:

java.lang.IllegalStateException - when requested particle type is not supported by this server version.

packet

public java.lang.Object packet(boolean far,
                               org.bukkit.Location loc,
                               double speed,
                               int count)

Construct particle packet that will spawn count particles at specified position using speed parameter.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

loc - a Location containing position.

speed - parameter used in various contexts.

count - amount of particles to spawn.

Returns:

a valid NMS Packet object.

Throws:

java.lang.IllegalStateException - when requested particle type is not supported by this server version.

packet

public java.lang.Object packet(boolean far,
                               org.bukkit.util.Vector loc,
                               double speed,
                               int count)

Construct particle packet that will spawn count particles at specified position using speed parameter.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

loc - a Vector containing position.

speed - parameter used in various contexts.

count - amount of particles to spawn.

Returns:

a valid NMS Packet object.

Throws:

java.lang.IllegalStateException - when requested particle type is not supported by this server version.

packet

public java.lang.Object packet(boolean far,
                               double x,
                               double y,
                               double z,
                               double speed,
                               int count)

Construct particle packet that will spawn count particles at specified position using speed parameter.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

x - component of a position.

y - component of a position.

z - component of a position.

speed - parameter used in various contexts.

count - amount of particles to spawn.

Returns:

a valid NMS Packet object.

Throws:

java.lang.IllegalStateException - when requested particle type is not supported by this server version.

packet

public java.lang.Object packet(boolean far,
                               org.bukkit.Location loc,
                               double offsetX,
                               double offsetY,
                               double offsetZ,
                               int count)

Construct particle packet that will spawn count particles at specified position using provided offset parameters.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

loc - a Location containing position.

offsetX - parameter used in various contexts.

offsetY - parameter used in various contexts.

offsetZ - parameter used in various contexts.

count - amount of particles to spawn.

Returns:

a valid NMS Packet object.

Throws:

java.lang.IllegalStateException - when requested particle type is not supported by this server version.

packet

public java.lang.Object packet(boolean far,
                               org.bukkit.util.Vector loc,
                               double offsetX,
                               double offsetY,
                               double offsetZ,
                               int count)

Construct particle packet that will spawn count particles at specified position using provided offset parameters.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

loc - a Vector containing position.

offsetX - parameter used in various contexts.

offsetY - parameter used in various contexts.

offsetZ - parameter used in various contexts.

count - amount of particles to spawn.

Returns:

a valid NMS Packet object.

Throws:

java.lang.IllegalStateException - when requested particle type is not supported by this server version.

packet

public java.lang.Object packet(boolean far,
                               double x,
                               double y,
                               double z,
                               double offsetX,
                               double offsetY,
                               double offsetZ,
                               int count)

Construct particle packet that will spawn count particles at specified position using provided offset parameters.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

x - component of a position.

y - component of a position.

z - component of a position.

offsetX - parameter used in various contexts.

offsetY - parameter used in various contexts.

offsetZ - parameter used in various contexts.

count - amount of particles to spawn.

Returns:

a valid NMS Packet object.

Throws:

java.lang.IllegalStateException - when requested particle type is not supported by this server version.

packet

public java.lang.Object packet(boolean far,
                               org.bukkit.Location loc,
                               double offsetX,
                               double offsetY,
                               double offsetZ,
                               double speed,
                               int count)

Construct particle packet that will spawn count particles at specified position using provided offset parameters and speed parameter.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

loc - a Location containing position.

offsetX - parameter used in various contexts.

offsetY - parameter used in various contexts.

offsetZ - parameter used in various contexts.

speed - parameter used in various contexts.

count - amount of particles to spawn.

Returns:

a valid NMS Packet object.

Throws:

java.lang.IllegalStateException - when requested particle type is not supported by this server version.

packet

public java.lang.Object packet(boolean far,
                               org.bukkit.util.Vector loc,
                               double offsetX,
                               double offsetY,
                               double offsetZ,
                               double speed,
                               int count)

Construct particle packet that will spawn count particles at specified position using provided offset parameters and speed parameter.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

loc - a Vector containing position.

offsetX - parameter used in various contexts.

offsetY - parameter used in various contexts.

offsetZ - parameter used in various contexts.

speed - parameter used in various contexts.

count - amount of particles to spawn.

Returns:

a valid NMS Packet object.

Throws:

java.lang.IllegalStateException - when requested particle type is not supported by this server version.

packet

public java.lang.Object packet(boolean far,
                               double x,
                               double y,
                               double z,
                               double offsetX,
                               double offsetY,
                               double offsetZ,
                               double speed,
                               int count)

Construct particle packet that will spawn count particles at specified position using provided offset parameters and speed parameter.

Parameters are not validated in any way.

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

x - component of a position.

y - component of a position.

z - component of a position.

offsetX - parameter used in various contexts.

offsetY - parameter used in various contexts.

offsetZ - parameter used in various contexts.

speed - parameter used in various contexts.

count - amount of particles to spawn.

Returns:

a valid NMS Packet object.

Throws:

java.lang.IllegalStateException - when requested particle type is not supported by this server version.

packet

@Deprecated
public java.lang.Object packet(boolean far,
                                            float x,
                                            float y,
                                            float z,
                                            float offsetX,
                                            float offsetY,
                                            float offsetZ,
                                            float speed,
                                            int count)

Deprecated. will be removed in a future, use version with doubles instead (it will be faster after removal)

Construct particle packet that will spawn count particles at specified position using provided offset parameters and speed parameter.

Parameters are not validated in any way.

This method is overridden by dynamically generated subclasses and depending on implementation this method will look roughly like this:

 public Object packet(boolean far, float x, float y, float z,
                      float offsetX, float offsetY, float offsetZ,
                      float speed, int count) {
     return new PacketPlayOutWorldParticles(parameters...);
 }
 

It is wise to check, if particle is supported by current Spigot version using isValid method.

Parameters:

far - if true, packets will be rendered much further than 16 blocks (flag is ignored prior to MC 1.8 versions).

x - component of a position.

y - component of a position.

z - component of a position.

offsetX - parameter used in various contexts.

offsetY - parameter used in various contexts.

offsetZ - parameter used in various contexts.

speed - parameter used in various contexts.

count - amount of particles to spawn.

Returns:

a valid NMS Packet object.

Throws:

java.lang.IllegalStateException - when requested particle type is not supported by this server version.

isValid

public boolean isValid()

Checks if this particle is supported by this Spigot version.

This method is overridden by dynamically generated subclasses.

Returns:

true if this particle is supported by this Spigot version, false otherwise.