public enum ParticleEffect extends java.lang.Enum<ParticleEffect>
This library was created by @DarkBlade12 and allows you to display all Minecraft particle effects on a Bukkit server
You are welcome to use it, modify it and redistribute it under the following conditions:
Special thanks:
It would be nice if you provide credit to me if you use this class in a published project
Modifier and Type | Class and Description |
---|---|
static class |
ParticleEffect.BlockData
Represents the block data for the
BLOCK_CRACK and
BLOCK_DUST effects |
static class |
ParticleEffect.ItemData
Represents the item data for the
ITEM_CRACK effect |
static class |
ParticleEffect.ParticleData
|
static class |
ParticleEffect.ParticlePacket
Represents a particle effect packet with all attributes which is used for
sending packets to the players
|
Enum Constant and Description |
---|
ANGRY_VILLAGER |
BARRIER
A particle effect which is displayed by barriers:
It looks like a red box with a slash through it
The speed value has no influence on this particle effect
|
BLOCK_CRACK
A particle effect which is displayed when breaking blocks or sprinting:
It looks like a little piece with a block texture
The speed value has no influence on this particle effect
|
BLOCK_DUST
A particle effect which is displayed when falling:
It looks like a little piece with a block texture
|
BUBBLE |
CLOUD
A particle effect which is displayed when a mob dies:
It looks like a large white cloud
The speed value influences the velocity at which the particle flies
off
|
CRIT
A particle effect which is displayed when landing a critical hit and by
arrows:
It looks like a light brown cross
The speed value influences the velocity at which the particle flies
off
|
CRIT_MAGIC
A particle effect which is displayed when landing a hit with an enchanted
weapon:
It looks like a cyan star
The speed value influences the velocity at which the particle flies
off
|
DAMAGE_INDICATOR
A particle effect which is displayed when mobs are damaged:
Looks like a black heart
|
DEPTH_SUSPEND |
DRAGON_BREATH
A particle effect created by the Ender Dragon when it breathes acid:
Looks similar to portal particles but bigger
A purple varaint of the cloud effect
|
DRIP_LAVA
A particle effect which is displayed by blocks beneath a lava source:
It looks like an orange drip
The speed value has no influence on this particle effect
|
DRIP_WATER
A particle effect which is displayed by blocks beneath a water source:
It looks like a blue drip
The speed value has no influence on this particle effect
|
ENCHANTMENT_TABLE
A particle effect which is displayed by enchantment tables which are
nearby bookshelves:
It looks like a cryptic white letter
The speed value influences the spread of this particle effect
|
END_ROD
A particle effect displayed by end rods and shelker bullets:
Looks like a white twinkly star that rises
|
EXPLODE |
EXPLOSION_HUGE
A particle effect which is displayed by exploding tnt and creepers:
It looks like a crowd of gray balls which are fading away
The speed value has no influence on this particle effect
|
EXPLOSION_LARGE
A particle effect which is displayed by exploding ghast fireballs and
wither skulls:
It looks like a gray ball which is fading away
The speed value slightly influences the size of this particle effect
|
EXPLOSION_NORMAL
A particle effect which is displayed by exploding tnt and creepers:
It looks like a white cloud
The speed value influences the velocity at which the particle flies
off
|
FALLING_DUST
A particle effect displayed by floating sand and gravel blocks
Looks like a yellow/cream colored reddust
Has a downwards motion by default
|
FIREWORKS_SPARK
A particle effect which is displayed by launching fireworks:
It looks like a white star which is sparkling
The speed value influences the velocity at which the particle flies
off
|
FLAME
A particle effect which is displayed by torches, active furnaces, magma
cubes and monster spawners:
It looks like a tiny flame
The speed value influences the velocity at which the particle flies
off
|
FOOTSTEP
A particle effect which is currently unused:
It looks like a transparent gray square
The speed value has no influence on this particle effect
|
HAPPY_VILLAGER |
HEART
A particle effect which is displayed when breeding and taming animals:
It looks like a red heart
The speed value has no influence on this particle effect
|
HUGE_EXPLOSION |
INSTANT_SPELL |
ITEM_CRACK
A particle effect which is displayed when breaking a tool or eggs hit a
block:
It looks like a little piece with an item texture
|
ITEM_TAKE
A particle effect which is currently unused:
It has no visual effect
|
LARGE_EXPLODE |
LARGE_SMOKE |
LAVA
A particle effect which is displayed by lava:
It looks like a spark
The speed value has no influence on this particle effect
|
MAGIC_CRIT |
MOB_APPEARANCE
A particle effect (use unknown)
|
MOB_SPELL |
MOB_SPELL_AMBIENT |
NOTE
A particle effect which is displayed by note blocks:
It looks like a colored note
The speed value causes the particle to be colored green when set to 0
|
PORTAL
A particle effect which is displayed by nether portals, endermen, ender
pearls, eyes of ender, ender chests and dragon eggs:
It looks like a purple cloud
The speed value influences the spread of this particle effect
|
RED_DUST |
REDSTONE
A particle effect which is displayed by redstone ore, powered redstone,
redstone torches and redstone repeaters:
It looks like a tiny colored cloud
The speed value causes the particle to be colored red when set to 0
|
SLIME
A particle effect which is displayed by slimes:
It looks like a tiny part of the slimeball icon
The speed value has no influence on this particle effect
|
SMOKE |
SMOKE_LARGE
A particle effect which is displayed by fire, minecarts with furnace and
blazes:
It looks like a large gray cloud
The speed value influences the velocity at which the particle flies
off
|
SMOKE_NORMAL
A particle effect which is displayed by primed tnt, torches, droppers,
dispensers, end portals, brewing stands and monster spawners:
It looks like a little gray cloud
The speed value influences the velocity at which the particle flies
off
|
SNOW_SHOVEL
A particle effect which is currently unused:
It looks like a tiny white cloud
The speed value influences the velocity at which the particle flies
off
|
SNOWBALL
A particle effect which is displayed when snowballs hit a block:
It looks like a little piece with the snowball texture
The speed value has no influence on this particle effect
|
SNOWBALL_POOF |
SPELL
A particle effect which is displayed when splash potions or bottles o'
enchanting hit something:
It looks like a white swirl
The speed value causes the particle to only move upwards when set to
0
|
SPELL_INSTANT
A particle effect which is displayed when instant splash potions hit
something:
It looks like a white cross
The speed value causes the particle to only move upwards when set to
0
|
SPELL_MOB
A particle effect which is displayed by entities with active potion
effects:
It looks like a colored swirl
The speed value causes the particle to be colored black when set to 0
The particle color gets lighter when increasing the speed and darker
when decreasing the speed
|
SPELL_MOB_AMBIENT
A particle effect which is displayed by entities with active potion
effects applied through a beacon:
It looks like a transparent colored swirl
The speed value causes the particle to be always colored black when
set to 0
The particle color gets lighter when increasing the speed and darker
when decreasing the speed
|
SPELL_WITCH
A particle effect which is displayed by witches:
It looks like a purple cross
The speed value causes the particle to only move upwards when set to
0
|
SPLASH |
SUSPEND |
SUSPENDED
A particle effect which is displayed by water:
It looks like a tiny blue square
The speed value has no influence on this particle effect
|
SUSPENDED_DEPTH
A particle effect which is displayed by air when close to bedrock and the
in the void:
It looks like a tiny gray square
The speed value has no influence on this particle effect
|
SWEEP
A particle effect displayed when mobs are attacked with a sword:
Looks like a sweep of air
|
TOWN_AURA
A particle effect which is displayed by mycelium:
It looks like a tiny gray square
The speed value has no influence on this particle effect
|
VILLAGER_ANGRY
A particle effect which is displayed when attacking a villager in a
village:
It looks like a cracked gray heart
The speed value has no influence on this particle effect
|
VILLAGER_HAPPY
A particle effect which is displayed when using bone meal and trading
with a villager in a village:
It looks like a green star
The speed value has no influence on this particle effect
|
WAKE |
WATER_BUBBLE
A particle effect which is displayed by swimming entities and arrows in
water:
It looks like a bubble
The speed value influences the velocity at which the particle flies
off
|
WATER_DROP
A particle effect which is displayed when rain hits the ground:
It looks like a blue droplet
The speed value has no influence on this particle effect
|
WATER_SPLASH
A particle effect which is displayed by swimming entities and shaking
wolves:
It looks like a blue drop
The speed value has no influence on this particle effect
|
WATER_WAKE
A particle effect which is displayed on water when fishing:
It looks like a blue droplet
The speed value influences the velocity at which the particle flies
off
|
WITCH_MAGIC |
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
|
void |
display(org.bukkit.Location center,
float offsetX,
float offsetY,
float offsetZ,
float speed,
int amount)
Displays a particle effect which is only visible for all players within a
certain range in the world of @param center
|
void |
display(ParticleEffect.ParticleData data,
float offsetX,
float offsetY,
float offsetZ,
float speed,
int amount,
org.bukkit.Location center,
double range)
Displays a particle effect which requires additional data and is only
visible for all players within a certain range in the world of @param
center
|
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)
Displays a particle effect which requires additional data and is only
visible for the specified players
|
void |
display(ParticleEffect.ParticleData data,
org.bukkit.util.Vector direction,
float speed,
org.bukkit.Location center,
double range)
Displays a single particle which requires additional data that flies into
a determined direction and is only visible for all players within a
certain range in the world of @param center
|
void |
display(ParticleEffect.ParticleData data,
org.bukkit.util.Vector direction,
float speed,
org.bukkit.Location center,
java.util.List<org.bukkit.entity.Player> players)
Displays a single particle which requires additional data that flies into
a determined direction and is only visible for the specified players
|
void |
display(org.bukkit.util.Vector direction,
float speed,
org.bukkit.Location center,
double range)
Displays a single particle which flies into a determined direction and is
only visible for all players within a certain range in the world of @param
center
|
void |
display(org.bukkit.util.Vector direction,
float speed,
org.bukkit.Location center,
java.util.List<org.bukkit.entity.Player> players)
Displays a single particle which flies into a determined direction and is
only visible for the specified players
|
static ParticleEffect |
fromId(int id)
Returns the particle effect with the given id
|
static ParticleEffect |
fromName(java.lang.String name)
Returns the particle effect with the given name
|
int |
getId()
Returns the id of this particle effect
|
java.lang.String |
getName()
Returns the name of this particle effect
|
int |
getRequiredVersion()
Returns the required version for this particle effect (1.x)
|
boolean |
getRequiresData()
Determine if additional data is required for this particle effect
|
boolean |
getRequiresWater()
Determine if water is required for this particle effect to display
properly
|
boolean |
isSupported()
Determine if this particle effect is supported by your current server
version
|
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.
|
public static final ParticleEffect EXPLOSION_NORMAL
public static final ParticleEffect EXPLODE
public static final ParticleEffect EXPLOSION_LARGE
public static final ParticleEffect LARGE_EXPLODE
public static final ParticleEffect EXPLOSION_HUGE
public static final ParticleEffect HUGE_EXPLOSION
public static final ParticleEffect FIREWORKS_SPARK
public static final ParticleEffect WATER_BUBBLE
public static final ParticleEffect BUBBLE
public static final ParticleEffect WATER_SPLASH
public static final ParticleEffect SPLASH
public static final ParticleEffect WATER_WAKE
public static final ParticleEffect WAKE
public static final ParticleEffect SUSPENDED
public static final ParticleEffect SUSPEND
public static final ParticleEffect SUSPENDED_DEPTH
public static final ParticleEffect DEPTH_SUSPEND
public static final ParticleEffect CRIT
public static final ParticleEffect CRIT_MAGIC
public static final ParticleEffect MAGIC_CRIT
public static final ParticleEffect SMOKE_NORMAL
public static final ParticleEffect SMOKE
public static final ParticleEffect SMOKE_LARGE
public static final ParticleEffect LARGE_SMOKE
public static final ParticleEffect SPELL
public static final ParticleEffect SPELL_INSTANT
public static final ParticleEffect INSTANT_SPELL
public static final ParticleEffect SPELL_MOB
public static final ParticleEffect MOB_SPELL
public static final ParticleEffect SPELL_MOB_AMBIENT
public static final ParticleEffect MOB_SPELL_AMBIENT
public static final ParticleEffect SPELL_WITCH
public static final ParticleEffect WITCH_MAGIC
public static final ParticleEffect DRIP_WATER
public static final ParticleEffect DRIP_LAVA
public static final ParticleEffect VILLAGER_ANGRY
public static final ParticleEffect ANGRY_VILLAGER
public static final ParticleEffect VILLAGER_HAPPY
public static final ParticleEffect HAPPY_VILLAGER
public static final ParticleEffect TOWN_AURA
public static final ParticleEffect NOTE
public static final ParticleEffect PORTAL
public static final ParticleEffect ENCHANTMENT_TABLE
public static final ParticleEffect FLAME
public static final ParticleEffect LAVA
public static final ParticleEffect FOOTSTEP
public static final ParticleEffect CLOUD
public static final ParticleEffect REDSTONE
public static final ParticleEffect RED_DUST
public static final ParticleEffect SNOWBALL
public static final ParticleEffect SNOWBALL_POOF
public static final ParticleEffect SNOW_SHOVEL
public static final ParticleEffect SLIME
public static final ParticleEffect HEART
public static final ParticleEffect BARRIER
public static final ParticleEffect ITEM_CRACK
public static final ParticleEffect BLOCK_CRACK
public static final ParticleEffect BLOCK_DUST
public static final ParticleEffect WATER_DROP
public static final ParticleEffect ITEM_TAKE
public static final ParticleEffect MOB_APPEARANCE
public static final ParticleEffect END_ROD
public static final ParticleEffect DRAGON_BREATH
public static final ParticleEffect DAMAGE_INDICATOR
public static final ParticleEffect SWEEP
public static final ParticleEffect FALLING_DUST
public static ParticleEffect[] values()
for (ParticleEffect c : ParticleEffect.values()) System.out.println(c);
public static ParticleEffect valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic java.lang.String getName()
public int getId()
public int getRequiredVersion()
public boolean getRequiresData()
public boolean getRequiresWater()
public boolean isSupported()
public static ParticleEffect fromName(java.lang.String name)
name
- Name of the particle effectpublic static ParticleEffect fromId(int id)
id
- Id of the particle effectpublic void display(float offsetX, float offsetY, float offsetZ, float speed, int amount, org.bukkit.Location center, double range) throws com.projectkorra.projectkorra.util.ParticleEffect.ParticleVersionException, com.projectkorra.projectkorra.util.ParticleEffect.ParticleDataException, java.lang.IllegalArgumentException
offsetX
- Maximum distance particles can fly away from the center on the
x-axisoffsetY
- Maximum distance particles can fly away from the center on the
y-axisoffsetZ
- Maximum distance particles can fly away from the center on the
z-axisspeed
- Display speed of the particlesamount
- Amount of particlescenter
- Center location of the effectrange
- Range of the visibilityParticleVersionException
- If the particle effect is not supported by the server versionParticleDataException
- If the particle effect requires additional datajava.lang.IllegalArgumentException
- If the particle effect requires water and none is at the
center locationcom.projectkorra.projectkorra.util.ParticleEffect.ParticleVersionException
com.projectkorra.projectkorra.util.ParticleEffect.ParticleDataException
ParticleEffect.ParticlePacket
,
ParticleEffect.ParticlePacket.sendTo(Location, double)
public void display(org.bukkit.Location center, float offsetX, float offsetY, float offsetZ, float speed, int amount)
offsetX
- Maximum distance particles can fly away from the center on the
x-axisoffsetY
- Maximum distance particles can fly away from the center on the
y-axisoffsetZ
- Maximum distance particles can fly away from the center on the
z-axisspeed
- Display speed of the particlesamount
- Amount of particlescenter
- Center location of the effectParticleVersionException
- If the particle effect is not supported by the server versionParticleDataException
- If the particle effect requires additional datajava.lang.IllegalArgumentException
- If the particle effect requires water and none is at the
center locationParticleEffect.ParticlePacket
,
ParticleEffect.ParticlePacket.sendTo(Location, double)
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 com.projectkorra.projectkorra.util.ParticleEffect.ParticleVersionException, com.projectkorra.projectkorra.util.ParticleEffect.ParticleDataException, java.lang.IllegalArgumentException
offsetX
- Maximum distance particles can fly away from the center on the
x-axisoffsetY
- Maximum distance particles can fly away from the center on the
y-axisoffsetZ
- Maximum distance particles can fly away from the center on the
z-axisspeed
- Display speed of the particlesamount
- Amount of particlescenter
- Center location of the effectplayers
- Receivers of the effectParticleVersionException
- If the particle effect is not supported by the server versionParticleDataException
- If the particle effect requires additional datajava.lang.IllegalArgumentException
- If the particle effect requires water and none is at the
center locationcom.projectkorra.projectkorra.util.ParticleEffect.ParticleVersionException
com.projectkorra.projectkorra.util.ParticleEffect.ParticleDataException
ParticleEffect.ParticlePacket
,
ParticleEffect.ParticlePacket.sendTo(Location, List)
public void display(org.bukkit.util.Vector direction, float speed, org.bukkit.Location center, double range) throws com.projectkorra.projectkorra.util.ParticleEffect.ParticleVersionException, com.projectkorra.projectkorra.util.ParticleEffect.ParticleDataException, java.lang.IllegalArgumentException
direction
- Direction of the particlespeed
- Display speed of the particlecenter
- Center location of the effectrange
- Range of the visibilityParticleVersionException
- If the particle effect is not supported by the server versionParticleDataException
- If the particle effect requires additional datajava.lang.IllegalArgumentException
- If the particle effect requires water and none is at the
center locationcom.projectkorra.projectkorra.util.ParticleEffect.ParticleVersionException
com.projectkorra.projectkorra.util.ParticleEffect.ParticleDataException
ParticleEffect.ParticlePacket
,
ParticleEffect.ParticlePacket.sendTo(Location, double)
public void display(org.bukkit.util.Vector direction, float speed, org.bukkit.Location center, java.util.List<org.bukkit.entity.Player> players) throws com.projectkorra.projectkorra.util.ParticleEffect.ParticleVersionException, com.projectkorra.projectkorra.util.ParticleEffect.ParticleDataException, java.lang.IllegalArgumentException
direction
- Direction of the particlespeed
- Display speed of the particlecenter
- Center location of the effectplayers
- Receivers of the effectParticleVersionException
- If the particle effect is not supported by the server versionParticleDataException
- If the particle effect requires additional datajava.lang.IllegalArgumentException
- If the particle effect requires water and none is at the
center locationcom.projectkorra.projectkorra.util.ParticleEffect.ParticleVersionException
com.projectkorra.projectkorra.util.ParticleEffect.ParticleDataException
ParticleEffect.ParticlePacket
,
ParticleEffect.ParticlePacket.sendTo(Location, List)
public void display(ParticleEffect.ParticleData data, float offsetX, float offsetY, float offsetZ, float speed, int amount, org.bukkit.Location center, double range) throws com.projectkorra.projectkorra.util.ParticleEffect.ParticleVersionException, com.projectkorra.projectkorra.util.ParticleEffect.ParticleDataException
data
- Data of the effectoffsetX
- Maximum distance particles can fly away from the center on the
x-axisoffsetY
- Maximum distance particles can fly away from the center on the
y-axisoffsetZ
- Maximum distance particles can fly away from the center on the
z-axisspeed
- Display speed of the particlesamount
- Amount of particlescenter
- Center location of the effectrange
- Range of the visibilityParticleVersionException
- If the particle effect is not supported by the server versionParticleDataException
- If the particle effect does not require additional datacom.projectkorra.projectkorra.util.ParticleEffect.ParticleVersionException
com.projectkorra.projectkorra.util.ParticleEffect.ParticleDataException
ParticleEffect.ParticlePacket
,
ParticleEffect.ParticlePacket.sendTo(Location, double)
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 com.projectkorra.projectkorra.util.ParticleEffect.ParticleVersionException, com.projectkorra.projectkorra.util.ParticleEffect.ParticleDataException
data
- Data of the effectoffsetX
- Maximum distance particles can fly away from the center on the
x-axisoffsetY
- Maximum distance particles can fly away from the center on the
y-axisoffsetZ
- Maximum distance particles can fly away from the center on the
z-axisspeed
- Display speed of the particlesamount
- Amount of particlescenter
- Center location of the effectplayers
- Receivers of the effectParticleVersionException
- If the particle effect is not supported by the server versionParticleDataException
- If the particle effect does not require additional datacom.projectkorra.projectkorra.util.ParticleEffect.ParticleVersionException
com.projectkorra.projectkorra.util.ParticleEffect.ParticleDataException
ParticleEffect.ParticlePacket
,
ParticleEffect.ParticlePacket.sendTo(Location, List)
public void display(ParticleEffect.ParticleData data, org.bukkit.util.Vector direction, float speed, org.bukkit.Location center, double range) throws com.projectkorra.projectkorra.util.ParticleEffect.ParticleVersionException, com.projectkorra.projectkorra.util.ParticleEffect.ParticleDataException
data
- Data of the effectdirection
- Direction of the particlespeed
- Display speed of the particlescenter
- Center location of the effectrange
- Range of the visibilityParticleVersionException
- If the particle effect is not supported by the server versionParticleDataException
- If the particle effect does not require additional datacom.projectkorra.projectkorra.util.ParticleEffect.ParticleVersionException
com.projectkorra.projectkorra.util.ParticleEffect.ParticleDataException
ParticleEffect.ParticlePacket
,
ParticleEffect.ParticlePacket.sendTo(Location, double)
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 com.projectkorra.projectkorra.util.ParticleEffect.ParticleVersionException, com.projectkorra.projectkorra.util.ParticleEffect.ParticleDataException
data
- Data of the effectdirection
- Direction of the particlespeed
- Display speed of the particlescenter
- Center location of the effectplayers
- Receivers of the effectParticleVersionException
- If the particle effect is not supported by the server versionParticleDataException
- If the particle effect does not require additional datacom.projectkorra.projectkorra.util.ParticleEffect.ParticleVersionException
com.projectkorra.projectkorra.util.ParticleEffect.ParticleDataException
ParticleEffect.ParticlePacket
,
ParticleEffect.ParticlePacket.sendTo(Location, List)