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.NoteColor
Represents the color for the
NOTE effect |
static class |
ParticleEffect.OrdinaryColor
|
static class |
ParticleEffect.ParticleColor
|
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
|
static class |
ParticleEffect.ParticleProperty
Represents the property of a particle effect
|
| 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(float offsetX,
float offsetY,
float offsetZ,
float speed,
int amount,
org.bukkit.Location center,
org.bukkit.entity.Player... players)
Displays a particle effect which is only visible for the specified players
|
void |
display(ParticleEffect.ParticleColor color,
org.bukkit.Location center,
double range)
Displays a single particle which is colored and only visible for all players within a certain range in the world of @param center
|
void |
display(ParticleEffect.ParticleColor color,
org.bukkit.Location center,
java.util.List<org.bukkit.entity.Player> players)
Displays a single particle which is colored and only visible for the specified players
|
void |
display(ParticleEffect.ParticleColor color,
org.bukkit.Location center,
org.bukkit.entity.Player... players)
Displays a single particle which is colored and only visible for the specified players
|
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,
float offsetX,
float offsetY,
float offsetZ,
float speed,
int amount,
org.bukkit.Location center,
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(ParticleEffect.ParticleData data,
org.bukkit.util.Vector direction,
float speed,
org.bukkit.Location center,
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
|
void |
display(org.bukkit.util.Vector direction,
float speed,
org.bukkit.Location center,
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 |
hasProperty(ParticleEffect.ParticleProperty property)
Determine if this particle effect has a specific property
|
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 EXPLOSION_LARGE
public static final ParticleEffect EXPLOSION_HUGE
public static final ParticleEffect FIREWORKS_SPARK
public static final ParticleEffect WATER_BUBBLE
public static final ParticleEffect WATER_SPLASH
public static final ParticleEffect WATER_WAKE
public static final ParticleEffect SUSPENDED
public static final ParticleEffect SUSPENDED_DEPTH
public static final ParticleEffect CRIT
public static final ParticleEffect CRIT_MAGIC
public static final ParticleEffect SMOKE_NORMAL
public static final ParticleEffect SMOKE_LARGE
public static final ParticleEffect SPELL
public static final ParticleEffect SPELL_INSTANT
public static final ParticleEffect SPELL_MOB
public static final ParticleEffect SPELL_MOB_AMBIENT
public static final ParticleEffect SPELL_WITCH
public static final ParticleEffect DRIP_WATER
public static final ParticleEffect DRIP_LAVA
public static final ParticleEffect VILLAGER_ANGRY
public static final ParticleEffect VILLAGER_HAPPY
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 SNOWBALL
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 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 hasProperty(ParticleEffect.ParticleProperty property)
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.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionException,
com.HamiStudios.ArchonCrates.API.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.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionExceptioncom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleDataExceptionParticleEffect.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.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionException,
com.HamiStudios.ArchonCrates.API.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.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionExceptioncom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleDataExceptionParticleEffect.ParticlePacket,
ParticleEffect.ParticlePacket.sendTo(Location, List)public void display(float offsetX,
float offsetY,
float offsetZ,
float speed,
int amount,
org.bukkit.Location center,
org.bukkit.entity.Player... players)
throws com.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionException,
com.HamiStudios.ArchonCrates.API.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.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionExceptioncom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleDataExceptiondisplay(float, float, float, float, int, Location, List)public void display(org.bukkit.util.Vector direction,
float speed,
org.bukkit.Location center,
double range)
throws com.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionException,
com.HamiStudios.ArchonCrates.API.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 is not directional or if it requires water and none is at the center locationcom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionExceptioncom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleDataExceptionParticlePacket#ParticlePacket(ParticleEffect, Vector, float, boolean, ParticleData),
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.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionException,
com.HamiStudios.ArchonCrates.API.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 is not directional or if it requires water and none is at the center locationcom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionExceptioncom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleDataExceptionParticlePacket#ParticlePacket(ParticleEffect, Vector, float, boolean, ParticleData),
ParticleEffect.ParticlePacket.sendTo(Location, List)public void display(org.bukkit.util.Vector direction,
float speed,
org.bukkit.Location center,
org.bukkit.entity.Player... players)
throws com.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionException,
com.HamiStudios.ArchonCrates.API.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 is not directional or if it requires water and none is at the center locationcom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionExceptioncom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleDataExceptiondisplay(Vector, float, Location, List)public void display(ParticleEffect.ParticleColor color, org.bukkit.Location center, double range) throws com.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionException, com.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleColorException
color - Color of the particlecenter - Center location of the effectrange - Range of the visibilityParticleVersionException - If the particle effect is not supported by the server versionParticleColorException - If the particle effect is not colorable or the color type is incorrectcom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionExceptioncom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleColorExceptionParticlePacket#ParticlePacket(ParticleEffect, ParticleColor, boolean),
ParticleEffect.ParticlePacket.sendTo(Location, double)public void display(ParticleEffect.ParticleColor color, org.bukkit.Location center, java.util.List<org.bukkit.entity.Player> players) throws com.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionException, com.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleColorException
color - Color of the particlecenter - Center location of the effectplayers - Receivers of the effectParticleVersionException - If the particle effect is not supported by the server versionParticleColorException - If the particle effect is not colorable or the color type is incorrectcom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionExceptioncom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleColorExceptionParticlePacket#ParticlePacket(ParticleEffect, ParticleColor, boolean),
ParticleEffect.ParticlePacket.sendTo(Location, List)public void display(ParticleEffect.ParticleColor color, org.bukkit.Location center, org.bukkit.entity.Player... players) throws com.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionException, com.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleColorException
color - Color of the particlecenter - Center location of the effectplayers - Receivers of the effectParticleVersionException - If the particle effect is not supported by the server versionParticleColorException - If the particle effect is not colorable or the color type is incorrectcom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionExceptioncom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleColorExceptiondisplay(ParticleColor, 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.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionException, com.HamiStudios.ArchonCrates.API.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 data or if the data type is incorrectcom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionExceptioncom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleDataExceptionParticleEffect.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.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionException, com.HamiStudios.ArchonCrates.API.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 data or if the data type is incorrectcom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionExceptioncom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleDataExceptionParticleEffect.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, org.bukkit.entity.Player... players) throws com.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionException, com.HamiStudios.ArchonCrates.API.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 data or if the data type is incorrectcom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionExceptioncom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleDataExceptiondisplay(ParticleData, float, float, float, float, int, Location, List)public void display(ParticleEffect.ParticleData data, org.bukkit.util.Vector direction, float speed, org.bukkit.Location center, double range) throws com.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionException, com.HamiStudios.ArchonCrates.API.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 data or if the data type is incorrectcom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionExceptioncom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleDataExceptionParticleEffect.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.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionException, com.HamiStudios.ArchonCrates.API.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 data or if the data type is incorrectcom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionExceptioncom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleDataExceptionParticleEffect.ParticlePacket,
ParticleEffect.ParticlePacket.sendTo(Location, List)public void display(ParticleEffect.ParticleData data, org.bukkit.util.Vector direction, float speed, org.bukkit.Location center, org.bukkit.entity.Player... players) throws com.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionException, com.HamiStudios.ArchonCrates.API.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 data or if the data type is incorrectcom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleVersionExceptioncom.HamiStudios.ArchonCrates.API.ParticleEffect.ParticleDataExceptiondisplay(ParticleData, Vector, float, Location, List)