com.quartercode.quarterbukkit.api.particle
Enum ParticleShape

java.lang.Object
  java.lang.Enum<ParticleShape>
      com.quartercode.quarterbukkit.api.particle.ParticleShape

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ParticleShape>

public enum ParticleShape
extends java.lang.Enum<ParticleShape>

A enumeration of all avaiable particle shapes.

Enum Constant Summary

BALL_LARGE
A large default-like ball.

BALL_SMALL
A small default-like ball.

BURST
A bursty shape.

CREEPER
A creeper face.

STAR
A 3D star.

Method Summary

org.bukkit.FireworkEffect.Type	getFireworkType() Returns the firework FireworkEffect.Type represented by the particle shape.
static ParticleShape	getShape(org.bukkit.FireworkEffect.Type fireworkType) Returns a particle shape from a firework FireworkEffect.Type.
static ParticleShape	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ParticleShape[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BALL_SMALL

public static final ParticleShape BALL_SMALL

A small default-like ball.

BALL_LARGE

public static final ParticleShape BALL_LARGE

A large default-like ball.

STAR

public static final ParticleShape STAR

A 3D star.

BURST

public static final ParticleShape BURST

A bursty shape.

CREEPER

public static final ParticleShape CREEPER

A creeper face.

Method Detail

values

public static ParticleShape[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ParticleShape c : ParticleShape.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ParticleShape valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getShape

public static ParticleShape getShape(org.bukkit.FireworkEffect.Type fireworkType)

Returns a particle shape from a firework FireworkEffect.Type.

Parameters:

fireworkType - The firework FireworkEffect.Type.

Returns:

The particle shape.

getFireworkType

public org.bukkit.FireworkEffect.Type getFireworkType()

Returns the firework FireworkEffect.Type represented by the particle shape.

Returns:

The firework FireworkEffect.Type represented by the particle shape.