com.github.fierioziy.api.types

Class ParticleTypeDust

java.lang.Object

com.github.fierioziy.api.types.ParticleTypeDust

public class ParticleTypeDust
extends java.lang.Object

Class used to represent dust particle type that needs a color and size.

It provides a non-reflective color method overloads to construct ParticleType with selected color and size.

All color methods does not validate parameters in any way.

See Also:

ParticleType

Constructor Summary

Constructors

Constructor and Description
ParticleTypeDust()

Method Summary

Modifier and Type	Method and Description
ParticleType	color(org.bukkit.Color color, double size) Selects a color this particle should get.
ParticleType	color(org.bukkit.Color color, float size) Selects a color this particle should get.
ParticleType	color(float r, float g, float b, float size) Selects a color this particle should get.
ParticleType	color(int r, int g, int b, double size) Selects a color this particle should get.
ParticleType	color(int r, int g, int b, float size) Selects a color this particle should get.
boolean	isValid() Checks if this particle is supported by this Spigot version.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticleTypeDust

public ParticleTypeDust()

Method Detail

color

public ParticleType color(org.bukkit.Color color,
                          double size)

Selects a color this particle should get.

Parameters are not validated in any way.

Parameters:

color - a Color object representing desired particle color.

size - size of a particle.

Returns:

a valid ParticleType object with selected color and size.

color

public ParticleType color(org.bukkit.Color color,
                          float size)

Selects a color this particle should get.

Parameters are not validated in any way.

Parameters:

color - a Color object representing desired particle color.

size - size of a particle.

Returns:

a valid ParticleType object with selected color and size.

color

public ParticleType color(int r,
                          int g,
                          int b,
                          double size)

Selects a color this particle should get.

Parameters are not validated in any way.

Parameters:

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.

size - size of a particle.

Returns:

a valid ParticleType object with selected color and size.

color

public ParticleType color(int r,
                          int g,
                          int b,
                          float size)

Selects a color this particle should get.

Parameters are not validated in any way.

Parameters:

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.

size - size of a particle.

Returns:

a valid ParticleType object with selected color and size.

color

public ParticleType color(float r,
                          float g,
                          float b,
                          float size)

Selects a color this particle should get.

Parameters are not validated in any way.

This method is overridden by dynamically generated subclasses.

Parameters:

r - red color value that should be between 0.0 and 1.0.

g - green color value that should be between 0.0 and 1.0.

b - blue color value that should be between 0.0 and 1.0.

size - size of a particle.

Returns:

a valid ParticleType object with selected color and size.

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.