org.bukkit

Enum Particle

java.lang.Object

java.lang.Enum<Particle>

org.bukkit.Particle

All Implemented Interfaces:

Serializable, Comparable<Particle>

public enum Particle
extends Enum<Particle>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Particle.DustOptions Options which can be applied to redstone dust particles - a particle color and size.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BARRIER
BLOCK_CRACK
BLOCK_DUST
BUBBLE_COLUMN_UP
BUBBLE_POP
CAMPFIRE_COSY_SMOKE
CAMPFIRE_SIGNAL_SMOKE
CLOUD
COMPOSTER
CRIT
CRIT_MAGIC
CURRENT_DOWN
DAMAGE_INDICATOR
DOLPHIN
DRAGON_BREATH
DRIP_LAVA
DRIP_WATER
ENCHANTMENT_TABLE
END_ROD
EXPLOSION_HUGE
EXPLOSION_LARGE
EXPLOSION_NORMAL
FALLING_DUST
FALLING_LAVA
FALLING_WATER
FIREWORKS_SPARK
FLAME
FLASH
HEART
ITEM_CRACK
LANDING_LAVA
LAVA
LEGACY_BLOCK_CRACK
LEGACY_BLOCK_DUST
LEGACY_FALLING_DUST
MOB_APPEARANCE
NAUTILUS
NOTE
PORTAL
REDSTONE
SLIME
SMOKE_LARGE
SMOKE_NORMAL
SNEEZE
SNOW_SHOVEL
SNOWBALL
SPELL
SPELL_INSTANT
SPELL_MOB
SPELL_MOB_AMBIENT
SPELL_WITCH
SPIT
SQUID_INK
SUSPENDED
SUSPENDED_DEPTH
SWEEP_ATTACK
TOTEM
TOWN_AURA
VILLAGER_ANGRY
VILLAGER_HAPPY
WATER_BUBBLE
WATER_DROP
WATER_SPLASH
WATER_WAKE

Method Summary

Modifier and Type	Method and Description
ParticleBuilder	builder() Creates a ParticleBuilder
Class<?>	getDataType() Returns the required data type for the particle
static Particle	valueOf(String name) Returns the enum constant of this type with the specified name.
static Particle[]	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

EXPLOSION_NORMAL

public static final Particle EXPLOSION_NORMAL

EXPLOSION_LARGE

public static final Particle EXPLOSION_LARGE

EXPLOSION_HUGE

public static final Particle EXPLOSION_HUGE

FIREWORKS_SPARK

public static final Particle FIREWORKS_SPARK

WATER_BUBBLE

public static final Particle WATER_BUBBLE

WATER_SPLASH

public static final Particle WATER_SPLASH

WATER_WAKE

public static final Particle WATER_WAKE

SUSPENDED

public static final Particle SUSPENDED

SUSPENDED_DEPTH

public static final Particle SUSPENDED_DEPTH

CRIT

public static final Particle CRIT

CRIT_MAGIC

public static final Particle CRIT_MAGIC

SMOKE_NORMAL

public static final Particle SMOKE_NORMAL

SMOKE_LARGE

public static final Particle SMOKE_LARGE

SPELL

public static final Particle SPELL

SPELL_INSTANT

public static final Particle SPELL_INSTANT

SPELL_MOB

public static final Particle SPELL_MOB

SPELL_MOB_AMBIENT

public static final Particle SPELL_MOB_AMBIENT

SPELL_WITCH

public static final Particle SPELL_WITCH

DRIP_WATER

public static final Particle DRIP_WATER

DRIP_LAVA

public static final Particle DRIP_LAVA

VILLAGER_ANGRY

public static final Particle VILLAGER_ANGRY

VILLAGER_HAPPY

public static final Particle VILLAGER_HAPPY

TOWN_AURA

public static final Particle TOWN_AURA

NOTE

public static final Particle NOTE

PORTAL

public static final Particle PORTAL

ENCHANTMENT_TABLE

public static final Particle ENCHANTMENT_TABLE

FLAME

public static final Particle FLAME

LAVA

public static final Particle LAVA

CLOUD

public static final Particle CLOUD

REDSTONE

public static final Particle REDSTONE

SNOWBALL

public static final Particle SNOWBALL

SNOW_SHOVEL

public static final Particle SNOW_SHOVEL

SLIME

public static final Particle SLIME

HEART

public static final Particle HEART

BARRIER

public static final Particle BARRIER

ITEM_CRACK

public static final Particle ITEM_CRACK

BLOCK_CRACK

public static final Particle BLOCK_CRACK

BLOCK_DUST

public static final Particle BLOCK_DUST

WATER_DROP

public static final Particle WATER_DROP

MOB_APPEARANCE

public static final Particle MOB_APPEARANCE

DRAGON_BREATH

public static final Particle DRAGON_BREATH

END_ROD

public static final Particle END_ROD

DAMAGE_INDICATOR

public static final Particle DAMAGE_INDICATOR

SWEEP_ATTACK

public static final Particle SWEEP_ATTACK

FALLING_DUST

public static final Particle FALLING_DUST

TOTEM

public static final Particle TOTEM

SPIT

public static final Particle SPIT

SQUID_INK

public static final Particle SQUID_INK

BUBBLE_POP

public static final Particle BUBBLE_POP

CURRENT_DOWN

public static final Particle CURRENT_DOWN

BUBBLE_COLUMN_UP

public static final Particle BUBBLE_COLUMN_UP

NAUTILUS

public static final Particle NAUTILUS

DOLPHIN

public static final Particle DOLPHIN

SNEEZE

public static final Particle SNEEZE

CAMPFIRE_COSY_SMOKE

public static final Particle CAMPFIRE_COSY_SMOKE

CAMPFIRE_SIGNAL_SMOKE

public static final Particle CAMPFIRE_SIGNAL_SMOKE

COMPOSTER

public static final Particle COMPOSTER

FLASH

public static final Particle FLASH

FALLING_LAVA

public static final Particle FALLING_LAVA

LANDING_LAVA

public static final Particle LANDING_LAVA

FALLING_WATER

public static final Particle FALLING_WATER

LEGACY_BLOCK_CRACK

public static final Particle LEGACY_BLOCK_CRACK

LEGACY_BLOCK_DUST

public static final Particle LEGACY_BLOCK_DUST

LEGACY_FALLING_DUST

public static final Particle LEGACY_FALLING_DUST

Method Detail

values

public static Particle[] 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 (Particle c : Particle.values())
    System.out.println(c);

Returns:

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

valueOf

public static Particle valueOf(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:

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

NullPointerException - if the argument is null

getDataType

@NotNull
public Class<?> getDataType()

Returns the required data type for the particle

Returns:

the required data type

builder

@NotNull
public ParticleBuilder builder()

Creates a ParticleBuilder

Returns:

a ParticleBuilder for the particle