com.github.fierioziy.api.types

Class ParticleTypeColorable

java.lang.Object

com.github.fierioziy.api.types.ParticleType

com.github.fierioziy.api.types.ParticleTypeColorable

public class ParticleTypeColorable
extends ParticleType

Class used to represent particle type that can construct colored particle packet.

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

All packetColored and packet methods does not validate parameters in any way.

See Also:

ParticleType

Constructor Summary

Constructors

Constructor and Description
ParticleTypeColorable()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	packetColored(boolean far, double x, double y, double z, org.bukkit.Color color) Construct particle packet that will spawn 1 colored particle at specified position.
java.lang.Object	packetColored(boolean far, double x, double y, double z, int r, int g, int b) Construct particle packet that will spawn 1 colored particle at specified position.
java.lang.Object	packetColored(boolean far, org.bukkit.Location loc, org.bukkit.Color color) Construct particle packet that will spawn 1 colored particle at specified position.
java.lang.Object	packetColored(boolean far, org.bukkit.Location loc, int r, int g, int b) Construct particle packet that will spawn 1 colored particle at specified position.
java.lang.Object	packetColored(boolean far, org.bukkit.util.Vector loc, org.bukkit.Color color) Construct particle packet that will spawn 1 colored particle at specified position.
java.lang.Object	packetColored(boolean far, org.bukkit.util.Vector loc, int r, int g, int b) Construct particle packet that will spawn 1 colored particle at specified position.

Methods inherited from class com.github.fierioziy.api.types.ParticleType

isValid, packet, packet, packet, packet, packet, packet, packet, packet, packet, packet, packet, packet, packet, packet, packet, packet

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticleTypeColorable

public ParticleTypeColorable()

Method Detail

packetColored

public java.lang.Object packetColored(boolean far,
                                      org.bukkit.Location loc,
                                      org.bukkit.Color color)

Construct particle packet that will spawn 1 colored 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.

color - a Color object with color parameters.

Returns:

a valid NMS Packet object.

Throws:

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

packetColored

public java.lang.Object packetColored(boolean far,
                                      org.bukkit.util.Vector loc,
                                      org.bukkit.Color color)

Construct particle packet that will spawn 1 colored 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.

color - a Color object with color parameters.

Returns:

a valid NMS Packet object.

Throws:

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

packetColored

public java.lang.Object packetColored(boolean far,
                                      double x,
                                      double y,
                                      double z,
                                      org.bukkit.Color color)

Construct particle packet that will spawn 1 colored 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.

color - a Color object with color parameters.

Returns:

a valid NMS Packet object.

Throws:

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

packetColored

public java.lang.Object packetColored(boolean far,
                                      org.bukkit.Location loc,
                                      int r,
                                      int g,
                                      int b)

Construct particle packet that will spawn 1 colored 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.

r - red color value that should be between 0 and 255.

g - green color value that should be between 0 and 255.

b - blue color value that should be between 0 and 255.

Returns:

a valid NMS Packet object.

Throws:

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

packetColored

public java.lang.Object packetColored(boolean far,
                                      org.bukkit.util.Vector loc,
                                      int r,
                                      int g,
                                      int b)

Construct particle packet that will spawn 1 colored 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.

r - red color value that should be between 0 and 255.

g - green color value that should be between 0 and 255.

b - blue color value that should be between 0 and 255.

Returns:

a valid NMS Packet object.

Throws:

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

packetColored

public java.lang.Object packetColored(boolean far,
                                      double x,
                                      double y,
                                      double z,
                                      int r,
                                      int g,
                                      int b)

Construct particle packet that will spawn 1 colored 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.

r - red color value that should be between 0 and 255.

g - green color value that should be between 0 and 255.

b - blue color value that should be between 0 and 255.

Returns:

a valid NMS Packet object.

Throws:

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