xyz.xenondevs.particle

Enum ParticleEffect

java.lang.Object

java.lang.Enum<ParticleEffect>

xyz.xenondevs.particle.ParticleEffect

All Implemented Interfaces:

Serializable, Comparable<ParticleEffect>

public enum ParticleEffect
extends Enum<ParticleEffect>

Enum to reflect particle packets with their respective data.

List of all currently supported effects:

• 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
• DRIPPING_HONEY
• ENCHANTMENT_TABLE
• END_ROD
• EXPLOSION_HUGE
• EXPLOSION_LARGE
• EXPLOSION_NORMAL
• FALLING_DUST
• FALLING_HONEY
• FALLING_NECTAR
• FIREWORKS_SPARK
• FLAME
• FOOTSTEP
• HEART
• ITEM_CRACK
• LANDING_HONEY
• LAVA
• MOB_APPEARANCE
• NAUTILUS
• NOTE
• PORTAL
• REDSTONE
• SLIME
• SMOKE_LARGE
• SMOKE_NORMAL
• SNEEZE
• SNOWBALL
• SNOW_SHOVEL
• 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

Since:

28.05.2019

Author:

ByteZ

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASH 1.16 Placeholder
BARRIER In the base game this particle is displayed by barrier blocks when a player holds a barrier item in the main or off hand.
BLOCK_CRACK In the base game this particle is displayed when a player breaks a block or sprints.
BLOCK_DUST In the base game this particle is displayed when an entity hits the ground after falling.
BUBBLE_COLUMN_UP In the base game this particle is randomly displayed by magma blocks and soulsand underwater.
BUBBLE_POP In the base game this particle is displayed at the top of bubble columns.
CAMPFIRE_COSY_SMOKE In the base game this particle is displayed by campfires.
CAMPFIRE_SIGNAL_SMOKE In the base game this particle is displayed by campfires with a hay bale placed under them.
CLOUD In the base game this particle is displayed when an entity dies.
COMPOSTER In the base game this particle is displayed when a composter is used by a player.
CRIMSON_SPORE 1.16 Placeholder
CRIT In the base game this particle is displayed when a player lands a critical hit on an entity or an arrow is launched with full power.
CRIT_MAGIC In the base game this particle is displayed when a player hits an entity with a sharpness sword.
CURRENT_DOWN In the base game this particle is displayed by magma blocks under water.
DAMAGE_INDICATOR In the base game this particle is displayed when a Player hits an Entity by melee attack.
DOLPHIN In the base game this particle is displayed as a trail of dolphins.
DRAGON_BREATH In the base game this particle is displayed by the ender dragons breath and ender fireballs.
DRIP_LAVA In the base game this particle is displayed randomly when a lava block is above a block.
DRIP_WATER In the base game this particle is displayed randomly when a water block is above a block.
DRIPPING_HONEY In the base game this particle is displayed by beehives filled with honey.
DRIPPING_OBSIDIAN_TEAR 1.16 Placeholder
ENCHANTMENT_TABLE In the base game this particle is displayed by bookshelves near an enchanting table.
END_ROD In the base game this particle is displayed by end rods and shulker bullets.
EXPLOSION_HUGE In the base game this particle is displayed when tnt or creeper explodes.
EXPLOSION_LARGE In the base game this particle is displayed when a fireball explodes or a wither skull hits a block/entity.
EXPLOSION_NORMAL In the base game this particle is displayed when either a creeper or a tnt explodes.
FALLING_DUST In the base game this particle is displayed randomly by floating sand and gravel.
FALLING_HONEY In the base game this particle is displayed below beehives filled with honey.
FALLING_NECTAR In the base game this particle is displayed by bees that have pollen and are on their way to the beehive.
FIREWORKS_SPARK In the base game this particle is displayed when a firework is launched.
FLAME In the base game this particle is randomly displayed by torches, active furnaces,spawners and magma cubes.
FOOTSTEP This particle is unused and is removed in the version 1.13.
HEART In the base game this particle is displayed when taming or breeding animals.
ITEM_CRACK In the base game this particle is displayed when a tool is broken, a egg or a splash potion hits an entity or a block, It is also displayed when a player eats or a eye of ender breaks.
LANDING_HONEY In the base game this particle is displayed after a Falling or Dripping Honey particle reaches a block.
LANDING_OBSIDIAN_TEAR 1.16 Placeholder
LAVA In the base game this particle is randomly displayed by lava.
MOB_APPEARANCE In the base game this particle is displayed by elder guardians.
NAUTILUS In the base game this particle is displayed by active conduits.
NOTE In the base game this particle is displayed when rightclicking or activating a note block.
PORTAL In the base game this particle is randomly displayed by nether portal, endermen, ender chests, dragon eggs, endermites and end gateway portals.
REDSTONE In the base game this particle is randomly displayed by active redstone ore, active redstone, active redstone repeater and active redstone torches.
REVERSE_PORTAL 1.16 Placeholder
SLIME In the base game this particle is displayed by jumping slimes.
SMOKE_LARGE In the base game this particle is randomly displayed by fire, furnace minecarts and blazes.
SMOKE_NORMAL In the base game this particle is randomly displayed by primed tnt, torches, end portals, active brewing stands, monster spawners or when either a dropper or dispenser gets triggered.
SNEEZE In the base game this particle is displayed by sneezing baby pandas.
SNOW_SHOVEL This particle is unused and is merged into "poof" in 1.13.
SNOWBALL In the base game this particle is displayed when a snowball hits an entity or a block.
SPELL In the base game this particle is displayed when a splash potion or a experience bottle hits a block or an entity.
SPELL_INSTANT In the base game this particle is displayed when a instant splash potion (e.g.
SPELL_MOB In the base game this particle is displayed when a entity has a active potion effect with the "ShowParticles" tag set to 1.
SPELL_MOB_AMBIENT In the base game this particle is displayed when a entity has a active potion effect from a nearby beacon.
SPELL_WITCH In the base game this particle is displayed randomly by witches.
SPIT In the base game this particle is displayed by llamas while attacking an entity.
SQUID_INK In the base game this particle is displayed when a squid gets damaged.
SUSPENDED In the base game this particle is displayed randomly in water.
SUSPENDED_DEPTH In the base game this particle is displayed when a player is close to bedrock or the void.
SWEEP_ATTACK In the base game this particle is displayed when a Player hits multiple entities at once with a sword.
TOTEM In the base game this particle is displayed when a totem of undying is used.
TOWN_AURA In the base game this particle is randomly displayed by mycelium blocks.
VILLAGER_ANGRY In the base game this particle is displayed when attacking a village.
VILLAGER_HAPPY In the base game this particle is displayed when trading with a villager, using bone meal on crops, feeding baby animals or walking on turtle eggs.
WARPED_SPORE 1.16 Placeholder
WATER_BUBBLE In the base game this particle is displayed when a Entity is swimming in water, a projectile flies into the water or a fish bites onto the bait.
WATER_DROP In the base game this particle is displayed when rain hits the ground.
WATER_SPLASH In the base game this particle is displayed when a Entity is swimming in water, wolves shaking off after swimming or boats.
WATER_WAKE In the base game this particle is displayed when a fish bites onto the bait of a fishing rod.
WHITE_ASH 1.16 Placeholder

Field Summary

Fields

Modifier and Type	Field and Description
static Map<ParticleEffect,Object>	NMS_EFFECTS A HashMap to store the nms instances of all currently supported ParticleEffects.
static ParticleEffect[]	VALUES A array with all ParticleEffects.

Method Summary

Modifier and Type	Method and Description
void	display(org.bukkit.Location location) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, Collection<? extends org.bukkit.entity.Player> players) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, Color color) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, Color color, Collection<? extends org.bukkit.entity.Player> players) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, Color color, org.bukkit.entity.Player... players) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, Color color, java.util.function.Predicate filter) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, float offsetX, float offsetY, float offsetZ, float speed, int amount, ParticleData data) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, float offsetX, float offsetY, float offsetZ, float speed, int amount, ParticleData data, Collection<? extends org.bukkit.entity.Player> players) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, float offsetX, float offsetY, float offsetZ, float speed, int amount, ParticleData data, org.bukkit.entity.Player... players) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, float offsetX, float offsetY, float offsetZ, float speed, int amount, ParticleData data, java.util.function.Predicate<org.bukkit.entity.Player> filter) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, ParticleColor color) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, ParticleColor color, Collection<? extends org.bukkit.entity.Player> players) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, ParticleColor color, org.bukkit.entity.Player... players) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, ParticleColor color, java.util.function.Predicate filter) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, org.bukkit.entity.Player... players) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, java.util.function.Predicate filter) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, org.bukkit.util.Vector vector, float speed, int amount, ParticleData data) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, org.bukkit.util.Vector vector, float speed, int amount, ParticleData data, Collection<? extends org.bukkit.entity.Player> players) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, org.bukkit.util.Vector vector, float speed, int amount, ParticleData data, org.bukkit.entity.Player... players) Displays the current ParticleEffect.
void	display(org.bukkit.Location location, org.bukkit.util.Vector vector, float speed, int amount, ParticleData data, java.util.function.Predicate filter) Displays the current ParticleEffect.
String	getFieldName() Applies the IntFunction defined in the constructor to get the respective name of the particle.
Object	getNMSObject() Gets the nms instance of the current ParticleEffect instance.
boolean	hasProperty(PropertyType propertyType) Checks if the current ParticleEffect instance has a specific PropertyType.
boolean	isCorrectColor(ParticleColor color) Checks if the current ParticleEffect instance needs the given ParticleColor.
boolean	isCorrectData(ParticleData data) Checks if the current ParticleEffect instance supports the given ParticleData.
static ParticleEffect	valueOf(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

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

ASH

public static final ParticleEffect ASH

1.16 Placeholder

BARRIER

public static final ParticleEffect BARRIER

In the base game this particle is displayed by barrier blocks when a player holds a barrier item in the main or off hand.

The original use of this particle is clientside. However when the server writes the data of a WorldParticles into a ByteBuf and the particle field is null the barrier particle is used.

Information:

• Appearance: Red box with a slash through it.
• Speed value: Doesn't influence the particle.

BLOCK_CRACK

public static final ParticleEffect BLOCK_CRACK

In the base game this particle is displayed when a player breaks a block or sprints. It's also displayed by iron golems while walking.

The particle originates from the nms Entity and EntityIronGolem classes.

Information:

• Appearance: Little piece of a texture.
• Speed value: Doesn't influence the particle.
• Extra: This particle needs a block texture in order to work.

BLOCK_DUST

public static final ParticleEffect BLOCK_DUST

In the base game this particle is displayed when an entity hits the ground after falling. It's also displayed when a armorstand is broken.

The particle originates from the nms EntityArmorStand, EntityRabbit and EntityLiving classes.

Information:

• Appearance: Little piece of a texture.
• Extra:
  • The velocity of this particle can be set. The amount has to be 0
  • This particle needs a block texture in order to work.

BUBBLE_COLUMN_UP

public static final ParticleEffect BUBBLE_COLUMN_UP

In the base game this particle is randomly displayed by magma blocks and soulsand underwater.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: Bubble with blue outline.
• Speed value: Influences the velocity at which the particle flies off.
• Extra: The velocity of this particle can be set. The amount has to be 0.

BUBBLE_POP

public static final ParticleEffect BUBBLE_POP

In the base game this particle is displayed at the top of bubble columns.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: Blue circle.
• Speed value: Influences the velocity at which the particle flies off.
• Extra: The velocity of this particle can be set. The amount has to be 0.

CAMPFIRE_COSY_SMOKE

public static final ParticleEffect CAMPFIRE_COSY_SMOKE

In the base game this particle is displayed by campfires.

The particle originates from the nms BlockCampfire class.

Information:

• Appearance: Smoke cloud.
• Speed value: Influences the velocity at which the particle flies off.
• Extra: The velocity of this particle can be set. The amount has to be 0.

CAMPFIRE_SIGNAL_SMOKE

public static final ParticleEffect CAMPFIRE_SIGNAL_SMOKE

In the base game this particle is displayed by campfires with a hay bale placed under them.

The particle originates from the nms BlockCampfire class.

Information:

• Appearance: Smoke cloud.
• Speed value: Influences the velocity at which the particle flies off.
• Extra: The velocity of this particle can be set. The amount has to be 0.

CLOUD

public static final ParticleEffect CLOUD

In the base game this particle is displayed when an entity dies.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: Large white cloud.
• Speed value: Influences the velocity at which the particle flies off.
• Extra: The velocity of this particle can be set. The amount has to be 0.

COMPOSTER

public static final ParticleEffect COMPOSTER

In the base game this particle is displayed when a composter is used by a player.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: Green start
• Speed value: Doesn't influence the particle.

CRIMSON_SPORE

public static final ParticleEffect CRIMSON_SPORE

1.16 Placeholder

CRIT

public static final ParticleEffect CRIT

In the base game this particle is displayed when a player lands a critical hit on an entity or an arrow is launched with full power.

The normal critical particle is displayed clientside which is why it is only used in the nms EntityArrow class.

Information:

• Appearance: Light brown cross.
• Speed value: Influences the velocity at which the particle flies off.

CRIT_MAGIC

public static final ParticleEffect CRIT_MAGIC

In the base game this particle is displayed when a player hits an entity with a sharpness sword.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: Cyan star.
• Speed value: Influences the velocity at which the particle flies off.

CURRENT_DOWN

public static final ParticleEffect CURRENT_DOWN

In the base game this particle is displayed by magma blocks under water.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: Cyan star.
• Speed value: Doesn't influence the particle.

DAMAGE_INDICATOR

public static final ParticleEffect DAMAGE_INDICATOR

In the base game this particle is displayed when a Player hits an Entity by melee attack.

The particle originates from the nms EntityHuman class.

Information:

• Appearance: A dark red heart.
• Speed value: Influences the velocity at which the particle flies off.
• Extra: The velocity of this particle can be set. The amount has to be 0.

DOLPHIN

public static final ParticleEffect DOLPHIN

In the base game this particle is displayed as a trail of dolphins.

The particle originates from the nms EntityDolphin class.

Information:

• Appearance: A blue square.
• Speed value: Doesn't influence the particle.

DRAGON_BREATH

public static final ParticleEffect DRAGON_BREATH

In the base game this particle is displayed by the ender dragons breath and ender fireballs.

The particle originates from the nms DragonControllerLandedFlame, DragonControllerLanding and EntityDragonFireball classes.

Information:

• Appearance: A purple cloud.
• Speed value: Influences the velocity at which the particle flies off.
• Extra: The velocity of this particle can be set. The amount has to be 0.

DRIP_LAVA

public static final ParticleEffect DRIP_LAVA

In the base game this particle is displayed randomly when a lava block is above a block.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: Orange drop.
• Speed value: Doesn't influence the particle.

DRIP_WATER

public static final ParticleEffect DRIP_WATER

In the base game this particle is displayed randomly when a water block is above a block.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: Blue drop.
• Speed value: Doesn't influence the particle.

DRIPPING_HONEY

public static final ParticleEffect DRIPPING_HONEY

In the base game this particle is displayed by beehives filled with honey. As opposed to the FALLING_HONEY particles, this particle floats in the air before falling to the ground.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: A rectangular honey drop.
• Speed value: Doesn't influence the particle.
• Extra: Spawns a LANDING_HONEY particle after landing on a block.

DRIPPING_OBSIDIAN_TEAR

public static final ParticleEffect DRIPPING_OBSIDIAN_TEAR

1.16 Placeholder

ENCHANTMENT_TABLE

public static final ParticleEffect ENCHANTMENT_TABLE

In the base game this particle is displayed by bookshelves near an enchanting table.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: A random letter from the galactic alphabet.
• Speed value: Influences the spread of this particle effect.
• Extra: The velocity of this particle can be set. The amount has to be 0.

END_ROD

public static final ParticleEffect END_ROD

In the base game this particle is displayed by end rods and shulker bullets.

Even though the original purpose of this particle is handled clientside the nms EntityShulkerBullet class still uses this particle.

Information:

• Appearance: White circle.
• Speed value: Influences the velocity at which the particle flies off.
• Extra: The velocity of this particle can be set. The amount has to be 0.

EXPLOSION_HUGE

public static final ParticleEffect EXPLOSION_HUGE

In the base game this particle is displayed when tnt or creeper explodes.

The particle originates from the nms EntityEnderDragon and Explosion classes and will only be shown when the size field is greater than 2.

Information:

• Appearance: Gray ball which fades away after a few seconds.
• Speed value: Doesn't influence the particle.

EXPLOSION_LARGE

public static final ParticleEffect EXPLOSION_LARGE

In the base game this particle is displayed when a fireball explodes or a wither skull hits a block/entity.

The particle originates from the nms Explosion class and will only be shown when the size field is smaller than 2.

Information:

• Appearance: Gray ball which fades away after a few seconds.
• Speed value: Doesn't influence the particle.

EXPLOSION_NORMAL

public static final ParticleEffect EXPLOSION_NORMAL

In the base game this particle is displayed when either a creeper or a tnt explodes.

The particle originates from the nms Explosion class.

Information:

• Appearance: White smoke.
• Speed value: Influences the velocity at which the particle flies off.

FALLING_DUST

public static final ParticleEffect FALLING_DUST

In the base game this particle is displayed randomly by floating sand and gravel.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: a circle part of a texture.
• Speed value: Doesn't influence the particle.
• Extra: This particle needs a block texture in order to work.

FALLING_HONEY

public static final ParticleEffect FALLING_HONEY

In the base game this particle is displayed below beehives filled with honey. As opposed to the DRIPPING_HONEY particles, this particle falls instantly.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: A rectangular honey drop.
• Speed value: Doesn't influence the particle.
• Extra: Spawns a LANDING_HONEY after landing on a block.

FALLING_NECTAR

public static final ParticleEffect FALLING_NECTAR

In the base game this particle is displayed by bees that have pollen and are on their way to the beehive.

The particle originates from the nms EntityBee class.

Information:

• Appearance: White square.
• Speed value: Doesn't influence the particle.

FIREWORKS_SPARK

public static final ParticleEffect FIREWORKS_SPARK

In the base game this particle is displayed when a firework is launched.

The particle originates from the nms EntityFireworks class.

Information:

• Appearance: Sparkling white star.
• Speed value: Influences the velocity at which the particle flies off.

FLAME

public static final ParticleEffect FLAME

In the base game this particle is randomly displayed by torches, active furnaces,spawners and magma cubes.

The particle originates from the nms MobSpawnerAbstract and EntityMagmaCube class.

Information:

• Appearance: Tiny flame.
• Speed value: Influences the velocity at which the particle flies off.
• Extra: The velocity of this particle can be set. The amount has to be 0.

FOOTSTEP

public static final ParticleEffect FOOTSTEP

This particle is unused and is removed in the version 1.13.

Since this particle is unused it isn't used in any nms classes.

Information:

• Appearance: Low opacity gray square.
• Speed value: Doesn't influence the particle.

HEART

public static final ParticleEffect HEART

In the base game this particle is displayed when taming or breeding animals.

The particle originates from the nms EntityAnimal, EntityTameableAnimal and PathfinderGoalBreed classes.

Information:

• Appearance: Red heart.
• Speed value: Doesn't influence the particle.

ITEM_CRACK

public static final ParticleEffect ITEM_CRACK

In the base game this particle is displayed when a tool is broken, a egg or a splash potion hits an entity or a block, It is also displayed when a player eats or a eye of ender breaks.

The particle originates from the nms EntityEgg, EntityHuman and EntityLiving classes.

Information:

• Appearance: Little piece of a texture.
• Extra:
  • The velocity of this particle can be set. The amount has to be 0.
  • This particle needs a item texture in order to work.

LANDING_HONEY

public static final ParticleEffect LANDING_HONEY

In the base game this particle is displayed after a Falling or Dripping Honey particle reaches a block.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: Honey colored lines.
• Speed value: Doesn't influence the particle.
• Extra: This Particles stays on the ground and doesn't instantly despawn.

LANDING_OBSIDIAN_TEAR

public static final ParticleEffect LANDING_OBSIDIAN_TEAR

1.16 Placeholder

LAVA

public static final ParticleEffect LAVA

In the base game this particle is randomly displayed by lava.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: Orange lava ball.
• Speed value: Doesn't influence the particle.

MOB_APPEARANCE

public static final ParticleEffect MOB_APPEARANCE

In the base game this particle is displayed by elder guardians.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: A elder guardian.
• Speed value: Doesn't influence the particle.

NAUTILUS

public static final ParticleEffect NAUTILUS

In the base game this particle is displayed by active conduits.

The particle originates from the nmsTileEntityConduit class.

Information:

• Appearance: Blue circle with a brown core.
• Speed value: Influences the velocity at which the particle flies off.
• Extra: The velocity of this particle can be set. The amount has to be 0.

NOTE

public static final ParticleEffect NOTE

In the base game this particle is displayed when rightclicking or activating a note block.

The particle originates from the nms BlockNote class.

Information:

• Appearance: Colored Note.
• Speed value: Causes the particle to be green when set to 0.
• Extra: the offsetX parameter represents which note should be displayed. The amount has to be 0 or the color won't work.

PORTAL

public static final ParticleEffect PORTAL

In the base game this particle is randomly displayed by nether portal, endermen, ender chests, dragon eggs, endermites and end gateway portals. It is also displayed when a ender pearl hits a block or an entity, when a eye of ender beaks or when the player eats a chorus fruit.

The particle originates from the following nms classes:
BlockDragonEgg, EntityEnderman, EntityEndermite, EntityEnderPearl and EntityEnderSignal

Information:

• Appearance: Purple cloud.
• Speed value: Influences the spread of this particle effect.
• Extra: The velocity of this particle can be set. The amount has to be 0.

REDSTONE

public static final ParticleEffect REDSTONE

In the base game this particle is randomly displayed by active redstone ore, active redstone, active redstone repeater and active redstone torches. Since 1.13 it is also displayed when pressing a button, activating a lever or stepping onto a pressure plate

The particle is mainly displayed clientside. However it is used in the BlockRedstoneOre nms class

Information:

• Appearance: Tiny colored cloud.
• Speed value: Influences the velocity at which the particle flies off.
• Extra: offsetX, offsetY and offsetZ represent the rgb values of the particle. The amount has to be 0 or the color won't work.

REVERSE_PORTAL

public static final ParticleEffect REVERSE_PORTAL

1.16 Placeholder

SLIME

public static final ParticleEffect SLIME

In the base game this particle is displayed by jumping slimes.

The particle originates from the nms EntitySlime class.

Information:

• Appearance: Tiny part of the slimeball icon.
• Speed value: Doesn't influence the particle.

SMOKE_LARGE

public static final ParticleEffect SMOKE_LARGE

In the base game this particle is randomly displayed by fire, furnace minecarts and blazes. It's also displayed when trying to place water in the nether.

The particle originates from the nms ItemBucket, EntityBlaze BlockFluids and EntityMinecart classes.

Information:

• Appearance: Large gray cloud.
• Speed value: Influences the velocity at which the particle flies off.

SMOKE_NORMAL

public static final ParticleEffect SMOKE_NORMAL

In the base game this particle is randomly displayed by primed tnt, torches, end portals, active brewing stands, monster spawners or when either a dropper or dispenser gets triggered. It's also displayed when taming a wild animal or an explosion occurs.

Most of the particles are displayed by the client however the explosion particles, the taming particles and a lot more are displayed by the server.

Information:

• Appearance: Little gray cloud.
• Speed value: Influences the velocity at which the particle flies off.

SNEEZE

public static final ParticleEffect SNEEZE

In the base game this particle is displayed by sneezing baby pandas.

The particle originates from the nms EntityPanda class.

Information:

• Appearance: Green cloud.
• Speed value: Influences the velocity at which the particle flies off.
• Extra: The velocity of this particle can be set. The amount has to be 0.

SNOWBALL

public static final ParticleEffect SNOWBALL

In the base game this particle is displayed when a snowball hits an entity or a block.

The particle originates from the nms EntitySnowball class.

Information:

• Appearance: Little peace of the snowball texture.
• Speed value: Doesn't influence the particle.

SNOW_SHOVEL

public static final ParticleEffect SNOW_SHOVEL

This particle is unused and is merged into "poof" in 1.13.

Since this particle is unused it isn't used in any nms classes.

Information:

• Appearance: Tiny white cloud.
• Speed value: Influences the velocity at which the particle flies off.
• Extra: The velocity of this particle can be set. The amount has to be 0.

SPELL

public static final ParticleEffect SPELL

In the base game this particle is displayed when a splash potion or a experience bottle hits a block or an entity. It's also displayed by evokers.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: White swirl.
• Speed value: Causes the particle to only fly up when set to 0.
• Extra: Only the motion on the y-axis can be controlled, the motion on the x- and z-axis are multiplied by 0.1 when setting the values to 0

SPELL_INSTANT

public static final ParticleEffect SPELL_INSTANT

In the base game this particle is displayed when a instant splash potion (e.g. instant health) hits a block or an entity.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: White swirl.
• Speed value: Causes the particle to only fly up when set to 0.
• Extra: Only the motion on the y-axis can be controlled, the motion on the x- and z-axis are multiplied by 0.1 when setting the values to 0

SPELL_MOB

public static final ParticleEffect SPELL_MOB

In the base game this particle is displayed when a entity has a active potion effect with the "ShowParticles" tag set to 1.

The particle originates from the nms EntityLiving and EntityWither classes.

Information:

• Appearance: colored swirl.
• Speed value: Represents the lightness of the color.
• Extra: offsetX, offsetY and offsetZ represent the rgb values of the particle. The amount has to be 0 or the color won't work.

SPELL_MOB_AMBIENT

public static final ParticleEffect SPELL_MOB_AMBIENT

In the base game this particle is displayed when a entity has a active potion effect from a nearby beacon.

The particle originates from the nms EntityLiving class.

Information:

• Appearance: colored swirl.
• Speed value: Represents the lightness of the color.
• Extra: offsetX, offsetY and offsetZ represent the rgb values of the particle. The amount has to be 0 or the color won't work.

SPELL_WITCH

public static final ParticleEffect SPELL_WITCH

In the base game this particle is displayed randomly by witches.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: Purple cross.
• Speed value: Causes the particle to only fly up when set to 0.
• Extra: Only the motion on the y-axis can be controlled, the motion on the x- and z-axis are multiplied by 0.1 when setting the values to 0

SPIT

public static final ParticleEffect SPIT

In the base game this particle is displayed by llamas while attacking an entity.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: A white cloud.
• Speed value:Influences the velocity at which the particle flies off.
• Extra: The velocity of this particle can be set. The amount has to be 0.

SQUID_INK

public static final ParticleEffect SQUID_INK

In the base game this particle is displayed when a squid gets damaged.

The particle originates from the nmsEntitySquid class.

Information:

• Appearance: Black ink.
• Speed value:Influences the velocity at which the particle flies off.
• Extra: The velocity of this particle can be set. The amount has to be 0.

SUSPENDED

public static final ParticleEffect SUSPENDED

In the base game this particle is displayed randomly in water.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: Tiny blue square.
• Speed value: Doesn't influence the particle.

SUSPENDED_DEPTH

public static final ParticleEffect SUSPENDED_DEPTH

In the base game this particle is displayed when a player is close to bedrock or the void.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: Tiny gray square.
• Speed value: Doesn't influence the particle.

SWEEP_ATTACK

public static final ParticleEffect SWEEP_ATTACK

In the base game this particle is displayed when a Player hits multiple entities at once with a sword.

The particle originates from the nms EntityHuman class,

Information:

• Appearance: A white curve.
• Speed value: Doesn't influence the particle.
• Extra: The size of this particle can be set in the offsetX parameter. The amount has to be 0 and the speed has to be 1.

TOTEM

public static final ParticleEffect TOTEM

In the base game this particle is displayed when a totem of undying is used.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: A green/yellow circle.
• Speed value: Influences the velocity at which the particle flies off.
• Extra: The velocity of this particle can be set. The amount has to be 0.

TOWN_AURA

public static final ParticleEffect TOWN_AURA

In the base game this particle is randomly displayed by mycelium blocks.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: Tiny gray square.
• Speed value: Doesn't influence the particle.
• Extra: The velocity of this particle can be set. The amount has to be 0.

VILLAGER_ANGRY

public static final ParticleEffect VILLAGER_ANGRY

In the base game this particle is displayed when attacking a village.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: Gray cloud with a lightning.
• Speed value: Doesn't influence the particle.

VILLAGER_HAPPY

public static final ParticleEffect VILLAGER_HAPPY

In the base game this particle is displayed when trading with a villager, using bone meal on crops, feeding baby animals or walking on turtle eggs.

The particle originates from the nms EntityAgeable class.

Information:

• Appearance: Green star.
• Speed value: Doesn't influence the particle.
• Extra: The velocity of this particle can be set. The amount has to be 0.

WARPED_SPORE

public static final ParticleEffect WARPED_SPORE

1.16 Placeholder

WATER_BUBBLE

public static final ParticleEffect WATER_BUBBLE

In the base game this particle is displayed when a Entity is swimming in water, a projectile flies into the water or a fish bites onto the bait.

The particle originates from the nms EntityLiving, EntityProjectile and EntityFishingHook classes.

Information:

• Appearance: Bubble with blue outline.
• Speed value: Doesn't influence the particle.

WATER_DROP

public static final ParticleEffect WATER_DROP

In the base game this particle is displayed when rain hits the ground.

The particle is displayed clientside so it's not used in any nms classes.

Information:

• Appearance: Blue droplet.
• Speed value: Doesn't influence the particle.

WATER_SPLASH

public static final ParticleEffect WATER_SPLASH

In the base game this particle is displayed when a Entity is swimming in water, wolves shaking off after swimming or boats.

The particle originates from the nms EntityWolf, EntityLiving and EntityBoat classes.

Information:

• Appearance: Blue droplet.
• Speed value: Influences the velocity at which the particle flies off.

WATER_WAKE

public static final ParticleEffect WATER_WAKE

In the base game this particle is displayed when a fish bites onto the bait of a fishing rod.

The particle originates from the nms EntityFishingHook class.

Information:

• Appearance: Tiny blue square.
• Speed value: Doesn't influence the particle.

WHITE_ASH

public static final ParticleEffect WHITE_ASH

1.16 Placeholder

Field Detail

VALUES

public static final ParticleEffect[] VALUES

A array with all ParticleEffects.

NMS_EFFECTS

public static final Map<ParticleEffect,Object> NMS_EFFECTS

A HashMap to store the nms instances of all currently supported ParticleEffects.

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

getFieldName

public String getFieldName()

Applies the IntFunction defined in the constructor to get the respective name of the particle.

Returns:

the String name of the particle.

hasProperty

public boolean hasProperty(PropertyType propertyType)

Checks if the current ParticleEffect instance has a specific PropertyType.

Parameters:

propertyType - the PropertyType that should be searched.

Returns:

true if the current ParticleEffect instance supports the given PropertyType.

isCorrectData

public boolean isCorrectData(ParticleData data)

Checks if the current ParticleEffect instance supports the given ParticleData.

Parameters:

data - the ParticleData that should that should be checked.

Returns:

true if the current instance supports the given ParticleData.

isCorrectColor

public boolean isCorrectColor(ParticleColor color)

Checks if the current ParticleEffect instance needs the given ParticleColor.

Note: Use NoteColor for the color of notes.

Parameters:

color - the ParticleColor data that should be checked.

Returns:

true if the current instance supports the given ParticleColor.

getNMSObject

public Object getNMSObject()

Gets the nms instance of the current ParticleEffect instance.

Returns:

The NMS instance or null if the particle isn't supported in the current minecraft version.

display

public void display(org.bukkit.Location location,
                    ParticleColor color,
                    org.bukkit.entity.Player... players)

Displays the current ParticleEffect.

Parameters:

location - the Location at which the particle should be displayed.

color - the ParticleColor the particle should have.

players - a list of players that should receive the particle packet.

display

public void display(org.bukkit.Location location,
                    Color color,
                    org.bukkit.entity.Player... players)

Displays the current ParticleEffect.

Parameters:

location - the Location at which the particle should be displayed.

color - the Color the particle should have.

players - a list of players that should receive the particle packet.

display

public void display(org.bukkit.Location location,
                    ParticleColor color,
                    java.util.function.Predicate filter)

Displays the current ParticleEffect.

Parameters:

location - the Location at which the particle should be displayed.

color - the ParticleColor the particle should have.

filter - a Predicate to filter out specific Players.

display

public void display(org.bukkit.Location location,
                    Color color,
                    java.util.function.Predicate filter)

Displays the current ParticleEffect.

Parameters:

location - the Location at which the particle should be displayed.

color - the Color the particle should have.

filter - a Predicate to filter out specific Players.

display

public void display(org.bukkit.Location location,
                    ParticleColor color,
                    Collection<? extends org.bukkit.entity.Player> players)

Displays the current ParticleEffect.

Parameters:

location - the Location at which the particle should be displayed.

color - the ParticleColor the particle should have.

players - a Collection of players that should receive the particle packet.

display

public void display(org.bukkit.Location location,
                    Color color,
                    Collection<? extends org.bukkit.entity.Player> players)

Displays the current ParticleEffect.

Parameters:

location - the Location at which the particle should be displayed.

color - the Color the particle should have.

players - a Collection of players that should receive the particle packet.

display

public void display(org.bukkit.Location location,
                    ParticleColor color)

Displays the current ParticleEffect.

Parameters:

location - the Location at which the particle should be displayed.

color - the ParticleColor the particle should have.

display

public void display(org.bukkit.Location location,
                    Color color)

Displays the current ParticleEffect.

Parameters:

location - the Location at which the particle should be displayed.

color - the Color the particle should have.

display

public void display(org.bukkit.Location location,
                    org.bukkit.entity.Player... players)

Displays the current ParticleEffect.

Parameters:

location - the Location at which the particle should be displayed.

players - a list of players that should receive the particle packet.

display

public void display(org.bukkit.Location location,
                    java.util.function.Predicate filter)

Displays the current ParticleEffect.

Parameters:

location - the Location at which the particle should be displayed.

filter - a Predicate to filter out specific Players.

display

public void display(org.bukkit.Location location,
                    Collection<? extends org.bukkit.entity.Player> players)

Displays the current ParticleEffect.

Parameters:

location - the Location at which the particle should be displayed.

players - a Collection of players that should receive the particle packet.

display

public void display(org.bukkit.Location location)

Displays the current ParticleEffect.

Parameters:

location - the Location at which the particle should be displayed.

display

public void display(org.bukkit.Location location,
                    org.bukkit.util.Vector vector,
                    float speed,
                    int amount,
                    ParticleData data,
                    org.bukkit.entity.Player... players)

Displays the current ParticleEffect.

Parameters:

location - the Location at which

vector - the velocity at which the particle should fly off. the multiplier of the particle velocity.

speed - the multiplier of the particle velocity.

amount - the amount of particles that should be displayed.

data - the ParticleData the particle should have.

players - a list of players that should receive the particle packet.

display

public void display(org.bukkit.Location location,
                    org.bukkit.util.Vector vector,
                    float speed,
                    int amount,
                    ParticleData data,
                    java.util.function.Predicate filter)

Displays the current ParticleEffect.

Parameters:

location - the Location at which

vector - the velocity at which the particle should fly off. the multiplier of the particle velocity.

speed - the multiplier of the particle velocity.

amount - the amount of particles that should be displayed.

data - the ParticleData the particle should have.

filter - a Predicate to filter out specific Players.

display

public void display(org.bukkit.Location location,
                    org.bukkit.util.Vector vector,
                    float speed,
                    int amount,
                    ParticleData data,
                    Collection<? extends org.bukkit.entity.Player> players)

Displays the current ParticleEffect.

Parameters:

location - the Location at which

vector - the velocity at which the particle should fly off. the multiplier of the particle velocity.

speed - the multiplier of the particle velocity.

amount - the amount of particles that should be displayed.

data - the ParticleData the particle should have.

players - a Collection of players that should receive the particle packet.

display

public void display(org.bukkit.Location location,
                    org.bukkit.util.Vector vector,
                    float speed,
                    int amount,
                    ParticleData data)

Displays the current ParticleEffect.

Parameters:

location - the Location at which

vector - the velocity at which the particle should fly off. the multiplier of the particle velocity.

speed - the multiplier of the particle velocity.

amount - the amount of particles that should be displayed.

data - the ParticleData the particle should have.

display

public void display(org.bukkit.Location location,
                    float offsetX,
                    float offsetY,
                    float offsetZ,
                    float speed,
                    int amount,
                    ParticleData data,
                    org.bukkit.entity.Player... players)

Displays the current ParticleEffect.

Parameters:

location - the Location at which the particle should be displayed.

offsetX - the offsetX data of the particle.

offsetY - the offsetY data of the particle.

offsetZ - the offsetZ data of the particle.

speed - the multiplier of the particle velocity.

amount - the amount of particles that should be displayed.

data - the ParticleData the particle should have.

players - a list of players that should receive the particle packet.

display

public void display(org.bukkit.Location location,
                    float offsetX,
                    float offsetY,
                    float offsetZ,
                    float speed,
                    int amount,
                    ParticleData data,
                    java.util.function.Predicate<org.bukkit.entity.Player> filter)

Displays the current ParticleEffect.

Parameters:

location - the Location at which the particle should be displayed.

offsetX - the offsetX data of the particle.

offsetY - the offsetY data of the particle.

offsetZ - the offsetZ data of the particle.

speed - the multiplier of the particle velocity.

amount - the amount of particles that should be displayed.

data - the ParticleData the particle should have.

filter - a Predicate to filter out specific Players.

display

public void display(org.bukkit.Location location,
                    float offsetX,
                    float offsetY,
                    float offsetZ,
                    float speed,
                    int amount,
                    ParticleData data)

Displays the current ParticleEffect.

Parameters:

location - the Location at which the particle should be displayed.

offsetX - the offsetX data of the particle.

offsetY - the offsetY data of the particle.

offsetZ - the offsetZ data of the particle.

speed - the multiplier of the particle velocity.

amount - the amount of particles that should be displayed.

data - the ParticleData the particle should have.

display

public void display(org.bukkit.Location location,
                    float offsetX,
                    float offsetY,
                    float offsetZ,
                    float speed,
                    int amount,
                    ParticleData data,
                    Collection<? extends org.bukkit.entity.Player> players)

Displays the current ParticleEffect.

Parameters:

location - the Location at which the particle should be displayed.

offsetX - the offsetX data of the particle.

offsetY - the offsetY data of the particle.

offsetZ - the offsetZ data of the particle.

speed - the multiplier of the particle velocity.

amount - the amount of particles that should be displayed.

data - the ParticleData the particle should have.

players - a Collection of players that should receive the particle packet.