lib

Enum ParticleEffect

java.lang.Object

java.lang.Enum<ParticleEffect>

lib.ParticleEffect

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParticleEffect.BlockData
static class	ParticleEffect.ItemData
static class	ParticleEffect.NoteColor
static class	ParticleEffect.OrdinaryColor
static class	ParticleEffect.ParticleColor
static class	ParticleEffect.ParticleData
static class	ParticleEffect.ParticlePacket
static class	ParticleEffect.ParticleProperty

Enum Constant Summary

Enum Constants

Enum Constant and Description
BARRIER
BLOCK_CRACK REQUIRES_DATA
BLOCK_DUST DIRECTIONAL, REQUIRES_DATA
CLOUD DIRECTIONAL
CRIT DIRECTIONAL
CRIT_MAGIC DIRECTIONAL
DRIP_LAVA
DRIP_WATER
ENCHANTMENT_TABLE DIRECTIONAL
EXPLOSION_HUGE
EXPLOSION_LARGE
EXPLOSION_NORMAL DIRECTIONAL
FIREWORKS_SPARK DIRECTIONAL
FLAME DIRECTIONAL
FOOTSTEP
HEART
ITEM_CRACK DIRECTIONAL, REQUIRES_DATA
ITEM_TAKE
LAVA
MOB_APPEARANCE
NOTE COLORABLE
PORTAL DIRECTIONAL
REDSTONE COLORABLE
SLIME
SMOKE_LARGE DIRECTIONAL
SMOKE_NORMAL DIRECTIONAL
SNOW_SHOVEL DIRECTIONAL
SNOWBALL
SPELL
SPELL_INSTANT
SPELL_MOB COLORABLE
SPELL_MOB_AMBIENT COLORABLE
SPELL_WITCH
SUSPENDED REQUIRES_WATER
SUSPENDED_DEPTH DIRECTIONAL
TOWN_AURA DIRECTIONAL
VILLAGER_ANGRY
VILLAGER_HAPPY DIRECTIONAL
WATER_BUBBLE DIRECTIONAL, REQUIRES_WATER
WATER_DROP
WATER_SPLASH DIRECTIONAL
WATER_WAKE DIRECTIONAL

Method Summary

Methods

Modifier and Type	Method and Description
void	display(float offsetX, float offsetY, float offsetZ, float speed, int amount, org.bukkit.Location center, double range)
void	display(float offsetX, float offsetY, float offsetZ, float speed, int amount, org.bukkit.Location center, java.util.List<org.bukkit.entity.Player> players)
void	display(float offsetX, float offsetY, float offsetZ, float speed, int amount, org.bukkit.Location center, org.bukkit.entity.Player... players)
void	display(ParticleEffect.ParticleColor color, org.bukkit.Location center, double range)
void	display(ParticleEffect.ParticleColor color, org.bukkit.Location center, java.util.List<org.bukkit.entity.Player> players)
void	display(ParticleEffect.ParticleColor color, org.bukkit.Location center, org.bukkit.entity.Player... players)
void	display(ParticleEffect.ParticleData data, float offsetX, float offsetY, float offsetZ, float speed, int amount, org.bukkit.Location center, double range)
void	display(ParticleEffect.ParticleData data, float offsetX, float offsetY, float offsetZ, float speed, int amount, org.bukkit.Location center, java.util.List<org.bukkit.entity.Player> players)
void	display(ParticleEffect.ParticleData data, float offsetX, float offsetY, float offsetZ, float speed, int amount, org.bukkit.Location center, org.bukkit.entity.Player... players)
void	display(ParticleEffect.ParticleData data, org.bukkit.util.Vector direction, float speed, org.bukkit.Location center, double range)
void	display(ParticleEffect.ParticleData data, org.bukkit.util.Vector direction, float speed, org.bukkit.Location center, java.util.List<org.bukkit.entity.Player> players)
void	display(ParticleEffect.ParticleData data, org.bukkit.util.Vector direction, float speed, org.bukkit.Location center, org.bukkit.entity.Player... players)
void	display(org.bukkit.util.Vector direction, float speed, org.bukkit.Location center, double range)
void	display(org.bukkit.util.Vector direction, float speed, org.bukkit.Location center, java.util.List<org.bukkit.entity.Player> players)
void	display(org.bukkit.util.Vector direction, float speed, org.bukkit.Location center, org.bukkit.entity.Player... players)
static ParticleEffect	fromId(int id)
static ParticleEffect	fromName(java.lang.String name)
int	getId()
java.lang.String	getName()
int	getRequiredVersion()
boolean	hasProperty(ParticleEffect.ParticleProperty property)
boolean	isSupported()
static ParticleEffect	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ParticleEffect[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, 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 ParticleEffect EXPLOSION_NORMAL

DIRECTIONAL

EXPLOSION_LARGE

public static final ParticleEffect EXPLOSION_LARGE

EXPLOSION_HUGE

public static final ParticleEffect EXPLOSION_HUGE

FIREWORKS_SPARK

public static final ParticleEffect FIREWORKS_SPARK

DIRECTIONAL

WATER_BUBBLE

public static final ParticleEffect WATER_BUBBLE

DIRECTIONAL, REQUIRES_WATER

WATER_SPLASH

public static final ParticleEffect WATER_SPLASH

DIRECTIONAL

WATER_WAKE

public static final ParticleEffect WATER_WAKE

DIRECTIONAL

SUSPENDED

public static final ParticleEffect SUSPENDED

REQUIRES_WATER

SUSPENDED_DEPTH

public static final ParticleEffect SUSPENDED_DEPTH

DIRECTIONAL

CRIT

public static final ParticleEffect CRIT

DIRECTIONAL

CRIT_MAGIC

public static final ParticleEffect CRIT_MAGIC

DIRECTIONAL

SMOKE_NORMAL

public static final ParticleEffect SMOKE_NORMAL

DIRECTIONAL

SMOKE_LARGE

public static final ParticleEffect SMOKE_LARGE

DIRECTIONAL

SPELL

public static final ParticleEffect SPELL

SPELL_INSTANT

public static final ParticleEffect SPELL_INSTANT

SPELL_MOB

public static final ParticleEffect SPELL_MOB

COLORABLE

SPELL_MOB_AMBIENT

public static final ParticleEffect SPELL_MOB_AMBIENT

COLORABLE

SPELL_WITCH

public static final ParticleEffect SPELL_WITCH

DRIP_WATER

public static final ParticleEffect DRIP_WATER

DRIP_LAVA

public static final ParticleEffect DRIP_LAVA

VILLAGER_ANGRY

public static final ParticleEffect VILLAGER_ANGRY

VILLAGER_HAPPY

public static final ParticleEffect VILLAGER_HAPPY

DIRECTIONAL

TOWN_AURA

public static final ParticleEffect TOWN_AURA

DIRECTIONAL

NOTE

public static final ParticleEffect NOTE

COLORABLE

PORTAL

public static final ParticleEffect PORTAL

DIRECTIONAL

ENCHANTMENT_TABLE

public static final ParticleEffect ENCHANTMENT_TABLE

DIRECTIONAL

FLAME

public static final ParticleEffect FLAME

DIRECTIONAL

LAVA

public static final ParticleEffect LAVA

FOOTSTEP

public static final ParticleEffect FOOTSTEP

CLOUD

public static final ParticleEffect CLOUD

DIRECTIONAL

REDSTONE

public static final ParticleEffect REDSTONE

COLORABLE

SNOWBALL

public static final ParticleEffect SNOWBALL

SNOW_SHOVEL

public static final ParticleEffect SNOW_SHOVEL

DIRECTIONAL

SLIME

public static final ParticleEffect SLIME

HEART

public static final ParticleEffect HEART

BARRIER

public static final ParticleEffect BARRIER

ITEM_CRACK

public static final ParticleEffect ITEM_CRACK

DIRECTIONAL, REQUIRES_DATA

BLOCK_CRACK

public static final ParticleEffect BLOCK_CRACK

REQUIRES_DATA

BLOCK_DUST

public static final ParticleEffect BLOCK_DUST

DIRECTIONAL, REQUIRES_DATA

WATER_DROP

public static final ParticleEffect WATER_DROP

ITEM_TAKE

public static final ParticleEffect ITEM_TAKE

MOB_APPEARANCE

public static final ParticleEffect MOB_APPEARANCE

Method Detail

values

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

Returns:

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

valueOf

public static ParticleEffect 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

getName

public java.lang.String getName()

getId

public int getId()

getRequiredVersion

public int getRequiredVersion()

hasProperty

public boolean hasProperty(ParticleEffect.ParticleProperty property)

isSupported

public boolean isSupported()

fromName

public static ParticleEffect fromName(java.lang.String name)

fromId

public static ParticleEffect fromId(int id)

display

public void display(float offsetX,
           float offsetY,
           float offsetZ,
           float speed,
           int amount,
           org.bukkit.Location center,
           double range)
             throws lib.ParticleEffect.ParticleVersionException,
                    lib.ParticleEffect.ParticleDataException,
                    java.lang.IllegalArgumentException

Throws:

lib.ParticleEffect.ParticleVersionException

lib.ParticleEffect.ParticleDataException

java.lang.IllegalArgumentException

display

public void display(float offsetX,
           float offsetY,
           float offsetZ,
           float speed,
           int amount,
           org.bukkit.Location center,
           java.util.List<org.bukkit.entity.Player> players)
             throws lib.ParticleEffect.ParticleVersionException,
                    lib.ParticleEffect.ParticleDataException,
                    java.lang.IllegalArgumentException

Throws:

lib.ParticleEffect.ParticleVersionException

lib.ParticleEffect.ParticleDataException

java.lang.IllegalArgumentException

display

public void display(float offsetX,
           float offsetY,
           float offsetZ,
           float speed,
           int amount,
           org.bukkit.Location center,
           org.bukkit.entity.Player... players)
             throws lib.ParticleEffect.ParticleVersionException,
                    lib.ParticleEffect.ParticleDataException,
                    java.lang.IllegalArgumentException

Throws:

lib.ParticleEffect.ParticleVersionException

lib.ParticleEffect.ParticleDataException

java.lang.IllegalArgumentException

display

public void display(org.bukkit.util.Vector direction,
           float speed,
           org.bukkit.Location center,
           double range)
             throws lib.ParticleEffect.ParticleVersionException,
                    lib.ParticleEffect.ParticleDataException,
                    java.lang.IllegalArgumentException

Throws:

lib.ParticleEffect.ParticleVersionException

lib.ParticleEffect.ParticleDataException

java.lang.IllegalArgumentException

display

public void display(org.bukkit.util.Vector direction,
           float speed,
           org.bukkit.Location center,
           java.util.List<org.bukkit.entity.Player> players)
             throws lib.ParticleEffect.ParticleVersionException,
                    lib.ParticleEffect.ParticleDataException,
                    java.lang.IllegalArgumentException

Throws:

lib.ParticleEffect.ParticleVersionException

lib.ParticleEffect.ParticleDataException

java.lang.IllegalArgumentException

display

public void display(org.bukkit.util.Vector direction,
           float speed,
           org.bukkit.Location center,
           org.bukkit.entity.Player... players)
             throws lib.ParticleEffect.ParticleVersionException,
                    lib.ParticleEffect.ParticleDataException,
                    java.lang.IllegalArgumentException

Throws:

lib.ParticleEffect.ParticleVersionException

lib.ParticleEffect.ParticleDataException

java.lang.IllegalArgumentException

display

public void display(ParticleEffect.ParticleColor color,
           org.bukkit.Location center,
           double range)
             throws lib.ParticleEffect.ParticleVersionException,
                    lib.ParticleEffect.ParticleColorException

Throws:

lib.ParticleEffect.ParticleVersionException

lib.ParticleEffect.ParticleColorException

display

public void display(ParticleEffect.ParticleColor color,
           org.bukkit.Location center,
           java.util.List<org.bukkit.entity.Player> players)
             throws lib.ParticleEffect.ParticleVersionException,
                    lib.ParticleEffect.ParticleColorException

Throws:

lib.ParticleEffect.ParticleVersionException

lib.ParticleEffect.ParticleColorException

display

public void display(ParticleEffect.ParticleColor color,
           org.bukkit.Location center,
           org.bukkit.entity.Player... players)
             throws lib.ParticleEffect.ParticleVersionException,
                    lib.ParticleEffect.ParticleColorException

Throws:

lib.ParticleEffect.ParticleVersionException

lib.ParticleEffect.ParticleColorException

display

public void display(ParticleEffect.ParticleData data,
           float offsetX,
           float offsetY,
           float offsetZ,
           float speed,
           int amount,
           org.bukkit.Location center,
           double range)
             throws lib.ParticleEffect.ParticleVersionException,
                    lib.ParticleEffect.ParticleDataException

Throws:

lib.ParticleEffect.ParticleVersionException

lib.ParticleEffect.ParticleDataException

display

public void display(ParticleEffect.ParticleData data,
           float offsetX,
           float offsetY,
           float offsetZ,
           float speed,
           int amount,
           org.bukkit.Location center,
           java.util.List<org.bukkit.entity.Player> players)
             throws lib.ParticleEffect.ParticleVersionException,
                    lib.ParticleEffect.ParticleDataException

Throws:

lib.ParticleEffect.ParticleVersionException

lib.ParticleEffect.ParticleDataException

display

public void display(ParticleEffect.ParticleData data,
           float offsetX,
           float offsetY,
           float offsetZ,
           float speed,
           int amount,
           org.bukkit.Location center,
           org.bukkit.entity.Player... players)
             throws lib.ParticleEffect.ParticleVersionException,
                    lib.ParticleEffect.ParticleDataException

Throws:

lib.ParticleEffect.ParticleVersionException

lib.ParticleEffect.ParticleDataException

display

public void display(ParticleEffect.ParticleData data,
           org.bukkit.util.Vector direction,
           float speed,
           org.bukkit.Location center,
           double range)
             throws lib.ParticleEffect.ParticleVersionException,
                    lib.ParticleEffect.ParticleDataException

Throws:

lib.ParticleEffect.ParticleVersionException

lib.ParticleEffect.ParticleDataException

display

public void display(ParticleEffect.ParticleData data,
           org.bukkit.util.Vector direction,
           float speed,
           org.bukkit.Location center,
           java.util.List<org.bukkit.entity.Player> players)
             throws lib.ParticleEffect.ParticleVersionException,
                    lib.ParticleEffect.ParticleDataException

Throws:

lib.ParticleEffect.ParticleVersionException

lib.ParticleEffect.ParticleDataException

display

public void display(ParticleEffect.ParticleData data,
           org.bukkit.util.Vector direction,
           float speed,
           org.bukkit.Location center,
           org.bukkit.entity.Player... players)
             throws lib.ParticleEffect.ParticleVersionException,
                    lib.ParticleEffect.ParticleDataException

Throws:

lib.ParticleEffect.ParticleVersionException

lib.ParticleEffect.ParticleDataException