fr.unreal852.UnrealAPI.ParticleEffects

Enum ParticleEffect

java.lang.Object

java.lang.Enum<ParticleEffect>

fr.unreal852.UnrealAPI.ParticleEffects.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.ParticleEffectPacket Represents a particle effect packet with all attributes which is used for sending packets to the players This class is part of the ParticleEffect Library and follows the same usage conditions

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANGRY_VILLAGER
BUBBLE
CLOUD
CRIT
DEPTH_SUSPEND
DRIP_LAVA
DRIP_WATER
ENCHANTMENT_TABLE
EXPLODE
FIREWORKS_SPARK
FLAME
FOOTSTEP
HAPPY_VILLAGER
HEART
HUGE_EXPLOSION
INSTANT_SPELL
LARGE_EXPLODE
LARGE_SMOKE
LAVA
MAGIC_CRIT
MOB_SPELL
MOB_SPELL_AMBIENT
NOTE
PORTAL
RED_DUST
SLIME
SMOKE
SNOW_SHOVEL
SNOWBALL_POOF
SPELL
SPLASH
SUSPEND
TOWN_AURA
WAKE
WITCH_MAGIC

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) Displays a particle effect which is only visible for all players within a certain range in the world of @param center
void	display(float offsetX, float offsetY, float offsetZ, float speed, int amount, org.bukkit.Location center, java.util.List<org.bukkit.entity.Player> players) Displays a particle effect which is only visible for the specified players
static void	displayBlockCrack(int id, byte data, float offsetX, float offsetY, float offsetZ, int amount, org.bukkit.Location center, double range) Displays a block crack (block break) particle effect which is only visible for all players within a certain range in the world of @param center
static void	displayBlockCrack(int id, byte data, float offsetX, float offsetY, float offsetZ, int amount, org.bukkit.Location center, java.util.List<org.bukkit.entity.Player> players) Displays a block crack (block break) particle effect which is only visible for the specified players
static void	displayBlockDust(int id, byte data, float offsetX, float offsetY, float offsetZ, float speed, int amount, org.bukkit.Location center, double range) Displays a block dust particle effect which is only visible for all players within a certain range in the world of @param center
static void	displayBlockDust(int id, byte data, float offsetX, float offsetY, float offsetZ, float speed, int amount, org.bukkit.Location center, java.util.List<org.bukkit.entity.Player> players) Displays a block dust particle effect which is only visible for the specified players
static void	displayIconCrack(int id, byte data, float offsetX, float offsetY, float offsetZ, float speed, int amount, org.bukkit.Location center, double range) Displays an icon crack (item break) particle effect which is only visible for all players within a certain range in the world of @param center
static void	displayIconCrack(int id, byte data, float offsetX, float offsetY, float offsetZ, float speed, int amount, org.bukkit.Location center, java.util.List<org.bukkit.entity.Player> players) Displays an icon crack (item break) particle effect which is only visible for the specified players
static ParticleEffect	fromName(java.lang.String name) Returns the particle effect with the given name
java.lang.String	getName() Returns the name of this particle effect
boolean	getRequiresWater() Determine if water is required for this particle effect to display properly
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

HUGE_EXPLOSION

public static final ParticleEffect HUGE_EXPLOSION

LARGE_EXPLODE

public static final ParticleEffect LARGE_EXPLODE

FIREWORKS_SPARK

public static final ParticleEffect FIREWORKS_SPARK

BUBBLE

public static final ParticleEffect BUBBLE

SUSPEND

public static final ParticleEffect SUSPEND

DEPTH_SUSPEND

public static final ParticleEffect DEPTH_SUSPEND

TOWN_AURA

public static final ParticleEffect TOWN_AURA

CRIT

public static final ParticleEffect CRIT

MAGIC_CRIT

public static final ParticleEffect MAGIC_CRIT

SMOKE

public static final ParticleEffect SMOKE

MOB_SPELL

public static final ParticleEffect MOB_SPELL

MOB_SPELL_AMBIENT

public static final ParticleEffect MOB_SPELL_AMBIENT

SPELL

public static final ParticleEffect SPELL

INSTANT_SPELL

public static final ParticleEffect INSTANT_SPELL

WITCH_MAGIC

public static final ParticleEffect WITCH_MAGIC

NOTE

public static final ParticleEffect NOTE

PORTAL

public static final ParticleEffect PORTAL

ENCHANTMENT_TABLE

public static final ParticleEffect ENCHANTMENT_TABLE

EXPLODE

public static final ParticleEffect EXPLODE

FLAME

public static final ParticleEffect FLAME

LAVA

public static final ParticleEffect LAVA

FOOTSTEP

public static final ParticleEffect FOOTSTEP

SPLASH

public static final ParticleEffect SPLASH

WAKE

public static final ParticleEffect WAKE

LARGE_SMOKE

public static final ParticleEffect LARGE_SMOKE

CLOUD

public static final ParticleEffect CLOUD

RED_DUST

public static final ParticleEffect RED_DUST

SNOWBALL_POOF

public static final ParticleEffect SNOWBALL_POOF

DRIP_WATER

public static final ParticleEffect DRIP_WATER

DRIP_LAVA

public static final ParticleEffect DRIP_LAVA

SNOW_SHOVEL

public static final ParticleEffect SNOW_SHOVEL

SLIME

public static final ParticleEffect SLIME

HEART

public static final ParticleEffect HEART

ANGRY_VILLAGER

public static final ParticleEffect ANGRY_VILLAGER

HAPPY_VILLAGER

public static final ParticleEffect HAPPY_VILLAGER

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()

Returns the name of this particle effect

Returns:

The name

getRequiresWater

public boolean getRequiresWater()

Determine if water is required for this particle effect to display properly

Returns:

Whether water is required or not

fromName

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

Returns the particle effect with the given name

Parameters:

name - Name of the particle effect

Returns:

The particle effect

display

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

Displays a particle effect which is only visible for all players within a certain range in the world of @param center

Parameters:

offsetX - Maximum distance particles can fly away from the center on the x-axis

offsetY - Maximum distance particles can fly away from the center on the y-axis

offsetZ - Maximum distance particles can fly away from the center on the z-axis

speed - Display speed of the particles

amount - Amount of particles

center - Center location of the effect

range - Range of the visibility (Maximum range for particles is usually 16, but it can differ for some types)

Throws:

java.lang.IllegalArgumentException - If the particle effect requires water and none is at the center location

See Also:

ParticleEffect.ParticleEffectPacket, ParticleEffect.ParticleEffectPacket.sendTo(Location, double)

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 java.lang.IllegalArgumentException

Displays a particle effect which is only visible for the specified players

Parameters:

offsetX - Maximum distance particles can fly away from the center on the x-axis

offsetY - Maximum distance particles can fly away from the center on the y-axis

offsetZ - Maximum distance particles can fly away from the center on the z-axis

speed - Display speed of the particles

amount - Amount of particles

center - Center location of the effect

players - Receivers of the effect

Throws:

java.lang.IllegalArgumentException - If the particle effect requires water and none is at the center location

See Also:

ParticleEffect.ParticleEffectPacket, ParticleEffect.ParticleEffectPacket.sendTo(Location, List)

displayIconCrack

public static void displayIconCrack(int id,
                    byte data,
                    float offsetX,
                    float offsetY,
                    float offsetZ,
                    float speed,
                    int amount,
                    org.bukkit.Location center,
                    double range)

Displays an icon crack (item break) particle effect which is only visible for all players within a certain range in the world of @param center

Parameters:

id - Id of the icon

data - Data value

offsetX - Maximum distance particles can fly away from the center on the x-axis

offsetY - Maximum distance particles can fly away from the center on the y-axis

offsetZ - Maximum distance particles can fly away from the center on the z-axis

speed - Display speed of the particles

amount - Amount of particles

center - Center location of the effect

range - Range of the visibility (Maximum range for particles is usually 16, but it can differ for some types)

See Also:

ParticleEffect.ParticleEffectPacket, ParticleEffect.ParticleEffectPacket.sendTo(Location, double)

displayIconCrack

public static void displayIconCrack(int id,
                    byte data,
                    float offsetX,
                    float offsetY,
                    float offsetZ,
                    float speed,
                    int amount,
                    org.bukkit.Location center,
                    java.util.List<org.bukkit.entity.Player> players)

Displays an icon crack (item break) particle effect which is only visible for the specified players

Parameters:

id - Id of the icon

data - Data value

offsetX - Maximum distance particles can fly away from the center on the x-axis

offsetY - Maximum distance particles can fly away from the center on the y-axis

offsetZ - Maximum distance particles can fly away from the center on the z-axis

speed - Display speed of the particles

amount - Amount of particles

center - Center location of the effect

players - Receivers of the effect

See Also:

ParticleEffect.ParticleEffectPacket, ParticleEffect.ParticleEffectPacket.sendTo(Location, List)

displayBlockCrack

public static void displayBlockCrack(int id,
                     byte data,
                     float offsetX,
                     float offsetY,
                     float offsetZ,
                     int amount,
                     org.bukkit.Location center,
                     double range)
                              throws java.lang.IllegalArgumentException

Displays a block crack (block break) particle effect which is only visible for all players within a certain range in the world of @param center

Parameters:

id - Id of the block

data - Data value

offsetX - Maximum distance particles can fly away from the center on the x-axis

offsetY - Maximum distance particles can fly away from the center on the y-axis

offsetZ - Maximum distance particles can fly away from the center on the z-axis

amount - Amount of particles

center - Center location of the effect

range - Range of the visibility (Maximum range for particles is usually 16, but it can differ for some types)

Throws:

java.lang.IllegalArgumentException - If the specified id is not a block id

See Also:

ParticleEffect.ParticleEffectPacket, ParticleEffect.ParticleEffectPacket.sendTo(Location, double)

displayBlockCrack

public static void displayBlockCrack(int id,
                     byte data,
                     float offsetX,
                     float offsetY,
                     float offsetZ,
                     int amount,
                     org.bukkit.Location center,
                     java.util.List<org.bukkit.entity.Player> players)
                              throws java.lang.IllegalArgumentException

Displays a block crack (block break) particle effect which is only visible for the specified players

Parameters:

id - Id of the block

data - Data value

offsetX - Maximum distance particles can fly away from the center on the x-axis

offsetY - Maximum distance particles can fly away from the center on the y-axis

offsetZ - Maximum distance particles can fly away from the center on the z-axis

amount - Amount of particles

center - Center location of the effect

players - Receivers of the effect

Throws:

java.lang.IllegalArgumentException - If the specified id is not a block id

See Also:

ParticleEffect.ParticleEffectPacket, ParticleEffect.ParticleEffectPacket.sendTo(Location, List)

displayBlockDust

public static void displayBlockDust(int id,
                    byte data,
                    float offsetX,
                    float offsetY,
                    float offsetZ,
                    float speed,
                    int amount,
                    org.bukkit.Location center,
                    double range)
                             throws java.lang.IllegalArgumentException

Displays a block dust particle effect which is only visible for all players within a certain range in the world of @param center

Parameters:

id - Id of the block

data - Data value

offsetX - Maximum distance particles can fly away from the center on the x-axis

offsetY - Maximum distance particles can fly away from the center on the y-axis

offsetZ - Maximum distance particles can fly away from the center on the z-axis

speed - Display speed of the particles

amount - Amount of particles

center - Center location of the effect

range - Range of the visibility (Maximum range for particles is usually 16, but it can differ for some types)

Throws:

java.lang.IllegalArgumentException - If the specified id is not a block id

See Also:

ParticleEffect.ParticleEffectPacket, ParticleEffect.ParticleEffectPacket.sendTo(Location, double)

displayBlockDust

public static void displayBlockDust(int id,
                    byte data,
                    float offsetX,
                    float offsetY,
                    float offsetZ,
                    float speed,
                    int amount,
                    org.bukkit.Location center,
                    java.util.List<org.bukkit.entity.Player> players)
                             throws java.lang.IllegalArgumentException

Displays a block dust particle effect which is only visible for the specified players

Parameters:

id - Id of the block

data - Data value

offsetX - Maximum distance particles can fly away from the center on the x-axis

offsetY - Maximum distance particles can fly away from the center on the y-axis

offsetZ - Maximum distance particles can fly away from the center on the z-axis

speed - Display speed of the particles

amount - Amount of particles

center - Center location of the effect

players - Receivers of the effect

Throws:

java.lang.IllegalArgumentException - If the specified id is not a block id

See Also:

ParticleEffect.ParticleEffectPacket, ParticleEffect.ParticleEffectPacket.sendTo(Location, List)