Package xyz.xenondevs.particle

Enum Class ParticleEffect

java.lang.Object
java.lang.Enum<ParticleEffect>
xyz.xenondevs.particle.ParticleEffect
All Implemented Interfaces:
Serializable, Comparable<ParticleEffect>, java.lang.constant.Constable
public enum ParticleEffect extends Enum<ParticleEffect>
Enum to reflect particle packets with their respective data.

List of all currently supported effects:

Since:
28.05.2019
Author:
ByteZ

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ASH
    In vanilla, this particle is randomly displayed in the basalt deltas nether biome.
    BARRIER
    REPLACED BY BLOCK_MARKER SINCE 1.18
    BLOCK_CRACK
    In vanilla, this particle is displayed when a player breaks a block or sprints.
    BLOCK_DUST
    In vanilla, this particle is displayed when an entity hits the ground after falling.
    BLOCK_MARKER
    In vanilla, this particle is displayed by barrier blocks when a player holds a barrier item in the main or off hand or by the light block.
    BUBBLE_COLUMN_UP
    In vanilla, this particle is randomly displayed by magma blocks and soulsand underwater.
    BUBBLE_POP
    In vanilla, this particle is displayed at the top of bubble columns.
    CAMPFIRE_COSY_SMOKE
    In vanilla, this particle is displayed by campfires.
    CAMPFIRE_SIGNAL_SMOKE
    In vanilla, this particle is displayed by campfires with a hay bale placed under them.
    CLOUD
    In vanilla, this particle is displayed when an entity dies.
    COMPOSTER
    In vanilla, this particle is displayed when a composter is used by a player.
    CRIMSON_SPORE
    In vanilla, this particle is displayed in the crimson forest nether biome.
    CRIT
    In vanilla, 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 vanilla, this particle is displayed when a player hits an entity with a sharpness sword.
    CURRENT_DOWN
    In vanilla, this particle is displayed by magma blocks underwater.
    DAMAGE_INDICATOR
    In vanilla, this particle is displayed when a Player hits an Entity by melee attack.
    DOLPHIN
    In vanilla, this particle is displayed as a trail of dolphins.
    DRAGON_BREATH
    In vanilla, this particle is displayed by the ender dragons breath and ender fireballs.
    DRIP_LAVA
    In vanilla, this particle is displayed randomly when a lava block is above a block.
    DRIP_WATER
    In vanilla, this particle is displayed randomly when a water block is above a block.
    DRIPPING_DRIPSTONE_LAVA
    In vanilla, this particle is shown dripping from the tip of pointed dripstones.
    DRIPPING_DRIPSTONE_WATER
    In vanilla, this particle is shown dripping from the tip of pointed dripstones.
    DRIPPING_HONEY
    In vanilla, this particle is displayed by beehives filled with honey.
    DRIPPING_OBSIDIAN_TEAR
    In vanilla, this particle is displayed by crying obsidian.
    DUST_COLOR_TRANSITION
    In vanilla, this particle is displayed when a sculk sensor is triggered.
    ELECTRIC_SPARK
    In vanilla, this particle appears when a lightning bolt hits copper blocks.
    ENCHANTMENT_TABLE
    In vanilla, this particle is displayed by bookshelves near an enchanting table.
    END_ROD
    In vanilla, this particle is displayed by end rods and shulker bullets.
    EXPLOSION_HUGE
    In vanilla, this particle is displayed when tnt or creeper explodes.
    EXPLOSION_LARGE
    In vanilla, this particle is displayed when a fireball explodes or a wither skull hits a block/entity.
    EXPLOSION_NORMAL
    In vanilla, this particle is displayed when either a creeper or a tnt explodes.
    FALLING_DRIPSTONE_LAVA
    In vanilla, this particle is displayed after DRIPPING_DRIPSTONE_LAVA starts falling from pointed dripstones.
    FALLING_DRIPSTONE_WATER
    In vanilla, this particle is displayed after DRIPPING_DRIPSTONE_WATER starts falling from pointed dripstones.
    FALLING_DUST
    In vanilla, this particle is displayed randomly by floating sand and gravel.
    FALLING_HONEY
    In vanilla, this particle is displayed below beehives filled with honey.
    FALLING_NECTAR
    In vanilla, this particle is displayed by bees that have pollen and are on their way to the beehive.
    FALLING_OBSIDIAN_TEAR
    In vanilla, this particle is displayed below crying obsidian blocks.
    FALLING_SPORE_BLOSSOM
    In vanilla, this particle is displayed below spore blossoms.
    FIREWORKS_SPARK
    In vanilla, this particle is displayed when a firework is launched.
    FLAME
    In vanilla, this particle is randomly displayed by torches, active furnaces,spawners and magma cubes.
    FLASH
    In vanilla, this particle is displayed by exploding fireworks
    FOOTSTEP
    This particle is unused and is removed in the version 1.13.
    GLOW
    In vanilla, this particle is displayed by a glow squid.
    GLOW_SQUID_INK
    In vanilla, this particle is displayed by a glow squid when it gets hurt.
    HEART
    In vanilla, this particle is displayed when taming or breeding animals.
    ITEM_CRACK
    In vanilla, this particle is displayed when a tool is broken, an egg or a splash potion hits an entity or a block, It is also displayed when a player eats or an eye of ender breaks.
    LANDING_HONEY
    In vanilla, this particle is displayed after a falling or dripping Honey particle reaches a block.
    LANDING_OBSIDIAN_TEAR
    In vanilla, this particle is displayed after a falling or dripping obsidian tear reaches a block.
    LAVA
    In vanilla, this particle is randomly displayed by lava.
    LIGHT
    REPLACED BY BLOCK_MARKER SINCE 1.18
    MOB_APPEARANCE
    In vanilla, this particle is displayed by elder guardians.
    NAUTILUS
    In vanilla, this particle is displayed by active conduits.
    NOTE
    In vanilla, this particle is displayed when rightclicking or activating a note block.
    PORTAL
    In vanilla, this particle is randomly displayed by nether portal, endermen, ender chests, dragon eggs, endermites and end gateway portals.
    REDSTONE
    In vanilla, this particle is randomly displayed by active redstone ore, active redstone, active redstone repeater and active redstone torches.
    REVERSE_PORTAL
    Currently Unused in vanilla.
    SCRAPE
    In vanilla, this particle is displayed when oxidation is scraped off a copper block.
    SCULK_CHARGE
    Information: Appearance: Blue dust turning into a circle. Speed value: Influences the velocity at which the particle flies off. Extra: You can use the SculkChargeData class to change the roll of this particle. Extra: The velocity of this particle can be set.
    SCULK_CHARGE_POP
    Information: Appearance: A blue circle popping. Speed value: Influences the velocity at which the particle flies off. Extra: The velocity of this particle can be set.
    SCULK_SOUL
    Information: Appearance: A blue soul. Speed value: Influences the velocity at which the particle flies off. Extra: The velocity of this particle can be set.
    SHRIEK
    Information: Appearance: A blue circle flying up. Speed value: Doesn't influence the particle. Extra: You can set the delay before the particle appears using the ShriekData class.
    SLIME
    In vanilla, this particle is displayed by jumping slimes.
    SMALL_FLAME
    Information: Appearance: A small flame. Speed value: Influences the velocity at which the particle flies off. Extra: The velocity of this particle can be set.
    SMOKE_LARGE
    In vanilla, this particle is randomly displayed by fire, furnace minecarts and blazes.
    SMOKE_NORMAL
    In vanilla, 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 vanilla, this particle is displayed by sneezing baby pandas.
    SNOW_SHOVEL
    This particle is unused and is merged into "poof" in 1.13.
    SNOWBALL
    In vanilla, this particle is displayed when a snowball hits an entity or a block.
    SNOWFLAKE
    In vanilla, this particle is displayed when a player sinks in powder snow.
    SONIC_BOOM
    Information: Appearance: A blue explosion. Speed value: Doesn't influence the particle.
    SOUL
    In vanilla, this particle is displayed when a player walks on soulsand with the soul speed enchantment.
    SOUL_FIRE_FLAME
    In vanilla, this particle is displayed by soul torches
    SPELL
    In vanilla, this particle is displayed when a splash potion or an experience bottle hits a block or an entity.
    SPELL_INSTANT
    In vanilla, this particle is displayed when an instant splash potion (e.g.
    SPELL_MOB
    In vanilla, this particle is displayed when an entity has an active potion effect with the "ShowParticles" tag set to 1.
    SPELL_MOB_AMBIENT
    In vanilla, this particle is displayed when an entity has an active potion effect from a nearby beacon.
    SPELL_WITCH
    In vanilla, this particle is displayed randomly by witches.
    SPIT
    In vanilla, this particle is displayed by llamas while attacking an entity.
    SPORE_BLOSSOM_AIR
    In vanilla, this particle is emitted around spore blossoms.
    SQUID_INK
    In vanilla, this particle is displayed when a squid gets damaged.
    SUSPENDED
    In vanilla, this particle is displayed randomly in water.
    SUSPENDED_DEPTH
    In vanilla, this particle is displayed when a player is close to bedrock or the void.
    SWEEP_ATTACK
    In vanilla, this particle is displayed when a Player hits multiple entities at once with a sword.
    TOTEM
    In vanilla, this particle is displayed when a totem of undying is used.
    TOWN_AURA
    In vanilla, this particle is randomly displayed by mycelium blocks.
    VIBRATION
    In vanilla, this particle is displayed when a sculk sensor is triggered.
    VILLAGER_ANGRY
    In vanilla, this particle is displayed when attacking a village.
    VILLAGER_HAPPY
    In vanilla, this particle is displayed when trading with a villager, using bone meal on crops, feeding baby animals or walking on turtle eggs.
    WARPED_SPORE
    In vanilla, this particle is displayed in the warped forest nether biome.
    WATER_BUBBLE
    In vanilla, this particle is displayed when an Entity is swimming in water, a projectile flies into the water or a fish bites onto the bait.
    WATER_DROP
    In vanilla, this particle is displayed when rain hits the ground.
    WATER_SPLASH
    In vanilla, this particle is displayed when an Entity is swimming in water, wolves shaking off after swimming or boats.
    WATER_WAKE
    In vanilla, this particle is displayed when a fish bites onto the bait of a fishing rod.
    WAX_OFF
    In vanilla, this particle is displayed when wax is removed from a copper block.
    WAX_ON
    In vanilla, this particle is displayed when wax is applied to a copper block.
    WHITE_ASH
    In vanilla, this particle is randomly displayed in the basalt deltas nether biome.

  • Field Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    display(org.bukkit.Location location)
    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, Predicate<org.bukkit.entity.Player> filter)
    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, 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, Predicate filter)
    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, Collection<? extends org.bukkit.entity.Player> players)
    Displays the current ParticleEffect.
    void
    display(org.bukkit.Location location, 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, 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, Predicate filter)
    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, 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, Predicate filter)
    Displays the current ParticleEffect.
    void
    display(org.bukkit.Location location, ParticleColor color, org.bukkit.entity.Player... players)
    Displays the current ParticleEffect.
    static Set<ParticleEffect>
    getAvailableEffects()
    Returns a set of all effects that are available in the current version.
    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 class with the specified name.
    static ParticleEffect[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ASH

      public static final ParticleEffect ASH
      In vanilla, this particle is randomly displayed in the basalt deltas nether biome.

      The movement of this particle is handled completely clientside and can therefore not be influenced.

      Information

      • Appearance: Gray/White square
      • Speed value: Doesn't influence the particle.
      • Extra: This Particle gets a random velocity while falling down.

    • BARRIER

      public static final ParticleEffect BARRIER
      REPLACED BY BLOCK_MARKER SINCE 1.18

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

      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 vanilla, this particle is displayed when a player breaks a block or sprints. It's also displayed by iron golems while walking.

      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 vanilla, this particle is displayed when an entity hits the ground after falling. It's also displayed when an armorstand is broken.

      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 vanilla, this particle is randomly displayed by magma blocks and soulsand underwater.

      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.

    • BLOCK_MARKER

      public static final ParticleEffect BLOCK_MARKER
      In vanilla, this particle is displayed by barrier blocks when a player holds a barrier item in the main or off hand or by the light block.

      Information:

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

    • BUBBLE_POP

      public static final ParticleEffect BUBBLE_POP
      In vanilla, this particle is displayed at the top of bubble columns.

      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 vanilla, this particle is displayed by campfires.

      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 vanilla, this particle is displayed by campfires with a hay bale placed under them.

      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 vanilla, this particle is displayed when an entity dies.

      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 vanilla, this particle is displayed when a composter is used by a player.

      Information:

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

    • CRIMSON_SPORE

      public static final ParticleEffect CRIMSON_SPORE
      In vanilla, this particle is displayed in the crimson forest nether biome.

      Information:

      • Appearance: Pink square.
      • Speed value: Influences the velocity at which the particle flies off.
      • Extra: This Particle gets a random velocity up.

    • CRIT

      public static final ParticleEffect CRIT
      In vanilla, this particle is displayed when a player lands a critical hit on an entity or an arrow is launched with full power.

      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 vanilla, this particle is displayed when a player hits an entity with a sharpness sword.

      Information:

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

    • CURRENT_DOWN

      public static final ParticleEffect CURRENT_DOWN
      In vanilla, this particle is displayed by magma blocks underwater.

      Information:

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

    • DAMAGE_INDICATOR

      public static final ParticleEffect DAMAGE_INDICATOR
      In vanilla, this particle is displayed when a Player hits an Entity by melee attack.

      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 vanilla, this particle is displayed as a trail of dolphins.

      Information:

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

    • DRAGON_BREATH

      public static final ParticleEffect DRAGON_BREATH
      In vanilla, this particle is displayed by the ender dragons breath and ender fireballs.

      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 vanilla, this particle is displayed randomly when a lava block is above a block. Information:
      • Appearance: Orange drop.
      • Speed value: Doesn't influence the particle.

    • DRIP_WATER

      public static final ParticleEffect DRIP_WATER
      In vanilla, this particle is displayed randomly when a water block is above a block.

      Information:

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

    • DRIPPING_DRIPSTONE_LAVA

      public static final ParticleEffect DRIPPING_DRIPSTONE_LAVA
      In vanilla, this particle is shown dripping from the tip of pointed dripstones.

      Information:

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

    • DRIPPING_DRIPSTONE_WATER

      public static final ParticleEffect DRIPPING_DRIPSTONE_WATER
      In vanilla, this particle is shown dripping from the tip of pointed dripstones.

      Information:

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

    • DRIPPING_HONEY

      public static final ParticleEffect DRIPPING_HONEY
      In vanilla, 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.

      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
      In vanilla, this particle is displayed by crying obsidian.

      Information:

      • Appearance: A rectangular obsidian tear.
      • Speed value: Doesn't influence the particle.
      • Extra: Spawns a LANDING_OBSIDIAN_TEAR particle after landing on a block.

    • DUST_COLOR_TRANSITION

      public static final ParticleEffect DUST_COLOR_TRANSITION
      In vanilla, this particle is displayed when a sculk sensor is triggered.

      Information:

      • Appearance: Tiny colored cloud that changes color.
      • Speed value: Doesn't influence the particle.
      • Extra: This particle supports 2 colors. It will display a fade animation between the two colors. It also supports a custom size. More information can be found here: PropertyType.DUST, DustColorTransitionData

    • ELECTRIC_SPARK

      public static final ParticleEffect ELECTRIC_SPARK
      In vanilla, this particle appears when a lightning bolt hits copper blocks.

      Information:

      • Appearance: A small spark.
      • Speed value: Influences the velocity at which the particle flies off.
      • Extra: The velocity of this particle can be set.

    • ENCHANTMENT_TABLE

      public static final ParticleEffect ENCHANTMENT_TABLE
      In vanilla, this particle is displayed by bookshelves near an enchanting table.

      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 vanilla, this particle is displayed by end rods and shulker bullets.

      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 vanilla, this particle is displayed when tnt or creeper explodes.

      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 vanilla, this particle is displayed when a fireball explodes or a wither skull hits a block/entity.

      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 vanilla, this particle is displayed when either a creeper or a tnt explodes.

      Information:

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

    • FALLING_DRIPSTONE_LAVA

      public static final ParticleEffect FALLING_DRIPSTONE_LAVA
      In vanilla, this particle is displayed after DRIPPING_DRIPSTONE_LAVA starts falling from pointed dripstones.

      Information:

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

    • FALLING_DRIPSTONE_WATER

      public static final ParticleEffect FALLING_DRIPSTONE_WATER
      In vanilla, this particle is displayed after DRIPPING_DRIPSTONE_WATER starts falling from pointed dripstones.

      Information:

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

    • FALLING_DUST

      public static final ParticleEffect FALLING_DUST
      In vanilla, this particle is displayed randomly by floating sand and gravel.

      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 vanilla, this particle is displayed below beehives filled with honey. As opposed to the DRIPPING_HONEY particles, this particle falls instantly.

      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 vanilla, this particle is displayed by bees that have pollen and are on their way to the beehive.

      Information:

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

    • FALLING_OBSIDIAN_TEAR

      public static final ParticleEffect FALLING_OBSIDIAN_TEAR
      In vanilla, this particle is displayed below crying obsidian blocks.

      Information:

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

    • FALLING_SPORE_BLOSSOM

      public static final ParticleEffect FALLING_SPORE_BLOSSOM
      In vanilla, this particle is displayed below spore blossoms.

      Information:

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

    • FIREWORKS_SPARK

      public static final ParticleEffect FIREWORKS_SPARK
      In vanilla, this particle is displayed when a firework is launched.

      Information:

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

    • FLAME

      public static final ParticleEffect FLAME
      In vanilla, this particle is randomly displayed by torches, active furnaces,spawners and magma cubes.

      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.

    • FLASH

      public static final ParticleEffect FLASH
      In vanilla, this particle is displayed by exploding fireworks

      Information:

      • Appearance: A white glow.
      • Speed value: Doesn't influence the particle.
      • Extra: The color of this flash can't be set since it's only set clientside.

    • FOOTSTEP

      public static final ParticleEffect FOOTSTEP
      This particle is unused and is removed in the version 1.13.

      Information:

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

    • GLOW

      public static final ParticleEffect GLOW
      In vanilla, this particle is displayed by a glow squid.

      Information:

      • Appearance: Cyan star.
      • Speed value: Doesn't seem to influence the particle.
      • Extra: The velocity of this particle can be set. The amount has to be 0. Please note that this particle is barely moveable.

    • GLOW_SQUID_INK

      public static final ParticleEffect GLOW_SQUID_INK
      In vanilla, this particle is displayed by a glow squid when it gets hurt.

      Information:

      • Appearance: Cyan 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.

    • HEART

      public static final ParticleEffect HEART
      In vanilla, this particle is displayed when taming or breeding animals.

      Information:

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

    • ITEM_CRACK

      public static final ParticleEffect ITEM_CRACK
      In vanilla, this particle is displayed when a tool is broken, an egg or a splash potion hits an entity or a block, It is also displayed when a player eats or an eye of ender breaks.

      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 vanilla, this particle is displayed after a falling or dripping Honey particle reaches a block.

      Information:

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

    • LANDING_OBSIDIAN_TEAR

      public static final ParticleEffect LANDING_OBSIDIAN_TEAR
      In vanilla, this particle is displayed after a falling or dripping obsidian tear reaches a block.

      Information:

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

    • LAVA

      public static final ParticleEffect LAVA
      In vanilla, this particle is randomly displayed by lava.

      Information:

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

    • LIGHT

      public static final ParticleEffect LIGHT
      REPLACED BY BLOCK_MARKER SINCE 1.18

      In vanilla, this particle is displayed by the light block.

      Information:

      • Appearance: 1.17: four yellow stars. Since 1.18: A lightbulb
      • Speed value: Doesn't influence the particle.

    • MOB_APPEARANCE

      public static final ParticleEffect MOB_APPEARANCE
      In vanilla, this particle is displayed by elder guardians.

      Information:

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

    • NAUTILUS

      public static final ParticleEffect NAUTILUS
      In vanilla, this particle is displayed by active conduits.

      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 vanilla, this particle is displayed when rightclicking or activating a note block.

      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 vanilla, this particle is randomly displayed by nether portal, endermen, ender chests, dragon eggs, endermites and end gateway portals. It is also displayed when an ender pearl hits a block or an entity, when an eye of ender beaks or when the player eats a chorus fruit.

      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 vanilla, 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

      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
      Currently Unused in vanilla. It's pretty much the same as the normal portal particle but instead of flying to the original location it flies away at the specified velocity.

      Information:

      • Appearance: 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.

    • SCRAPE

      public static final ParticleEffect SCRAPE
      In vanilla, this particle is displayed when oxidation is scraped off a copper block.

      Information:

      • Appearance: Cyan star.
      • 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.

    • SCULK_CHARGE

      public static final ParticleEffect SCULK_CHARGE

      Information:

      • Appearance: Blue dust turning into a circle.
      • Speed value: Influences the velocity at which the particle flies off.
      • Extra: You can use the SculkChargeData class to change the roll of this particle.
      • Extra: The velocity of this particle can be set. The amount has to be 0.

    • SCULK_CHARGE_POP

      public static final ParticleEffect SCULK_CHARGE_POP

      Information:

      • Appearance: A blue circle popping.
      • 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.

    • SCULK_SOUL

      public static final ParticleEffect SCULK_SOUL

      Information:

      • Appearance: A blue soul.
      • 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.

    • SHRIEK

      public static final ParticleEffect SHRIEK

      Information:

      • Appearance: A blue circle flying up.
      • Speed value: Doesn't influence the particle.
      • Extra: You can set the delay before the particle appears using the ShriekData class.

    • SLIME

      public static final ParticleEffect SLIME
      In vanilla, 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.

    • SMALL_FLAME

      public static final ParticleEffect SMALL_FLAME

      Information:

      • Appearance: A small 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.

    • SMOKE_LARGE

      public static final ParticleEffect SMOKE_LARGE
      In vanilla, 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 vanilla, 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.

      Information:

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

    • SNEEZE

      public static final ParticleEffect SNEEZE
      In vanilla, this particle is displayed by sneezing baby pandas.

      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 vanilla, this particle is displayed when a snowball hits an entity or a block.

      Information:

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

    • SNOWFLAKE

      public static final ParticleEffect SNOWFLAKE
      In vanilla, this particle is displayed when a player sinks in powder snow.

      Information:

      • Appearance: A small white snowflake.
      • 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.

    • SNOW_SHOVEL

      public static final ParticleEffect SNOW_SHOVEL
      This particle is unused and is merged into "poof" in 1.13.

      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.

    • SONIC_BOOM

      public static final ParticleEffect SONIC_BOOM

      Information:

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

    • SOUL

      public static final ParticleEffect SOUL
      In vanilla, this particle is displayed when a player walks on soulsand with the soul speed enchantment.

      Information:

      • Appearance: A soul.
      • 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.

    • SOUL_FIRE_FLAME

      public static final ParticleEffect SOUL_FIRE_FLAME
      In vanilla, this particle is displayed by soul torches

      Information:

      • Appearance: Blue 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.

    • SPELL

      public static final ParticleEffect SPELL
      In vanilla, this particle is displayed when a splash potion or an experience bottle hits a block or an entity. It's also displayed by evokers.

      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 vanilla, this particle is displayed when an instant splash potion (e.g. instant health) hits a block or an entity.

      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 vanilla, this particle is displayed when an entity has an active potion effect with the "ShowParticles" tag set to 1.

      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 vanilla, this particle is displayed when an entity has an active potion effect from a nearby beacon.

      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 vanilla, this particle is displayed randomly by witches.

      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 vanilla, this particle is displayed by llamas while attacking an entity.

      Information:

      • Appearance: 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.

    • SPORE_BLOSSOM_AIR

      public static final ParticleEffect SPORE_BLOSSOM_AIR
      In vanilla, this particle is emitted around spore blossoms.

      Information:

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

    • SQUID_INK

      public static final ParticleEffect SQUID_INK
      In vanilla, this particle is displayed when a squid gets damaged.

      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 vanilla, this particle is displayed randomly in water.

      Information:

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

    • SUSPENDED_DEPTH

      public static final ParticleEffect SUSPENDED_DEPTH
      In vanilla, this particle is displayed when a player is close to bedrock or the void.

      Information:

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

    • SWEEP_ATTACK

      public static final ParticleEffect SWEEP_ATTACK
      In vanilla, this particle is displayed when a Player hits multiple entities at once with a sword.

      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 vanilla, this particle is displayed when a totem of undying is used.

      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 vanilla, this particle is randomly displayed by mycelium blocks.

      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.

    • VIBRATION

      public static final ParticleEffect VIBRATION
      In vanilla, this particle is displayed when a sculk sensor is triggered.

      The vibration particle needs a lot of data in order to be displayed. Please have a look at the VibrationData documentation for more information.

      Information:

      • Appearance: cyan wave.
      • Speed value: Doesn't influence the particle.
      • Extra: Takes a start and destination location. (More information: VibrationData)

    • VILLAGER_ANGRY

      public static final ParticleEffect VILLAGER_ANGRY
      In vanilla, this particle is displayed when attacking a village.

      Information:

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

    • VILLAGER_HAPPY

      public static final ParticleEffect VILLAGER_HAPPY
      In vanilla, this particle is displayed when trading with a villager, using bone meal on crops, feeding baby animals or walking on turtle eggs.

      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
      In vanilla, this particle is displayed in the warped forest nether biome.

      Information:

      • Appearance: Blue square.
      • Speed value: Influences the velocity at which the particle flies off.
      • Extra: This Particle gets a random velocity up.

    • WATER_BUBBLE

      public static final ParticleEffect WATER_BUBBLE
      In vanilla, this particle is displayed when an Entity is swimming in water, a projectile flies into the water or a fish bites onto the bait.

      Information:

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

    • WATER_DROP

      public static final ParticleEffect WATER_DROP
      In vanilla, this particle is displayed when rain hits the ground.

      Information:

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

    • WATER_SPLASH

      public static final ParticleEffect WATER_SPLASH
      In vanilla, this particle is displayed when an Entity is swimming in water, wolves shaking off after swimming or boats.

      Information:

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

    • WATER_WAKE

      public static final ParticleEffect WATER_WAKE
      In vanilla, this particle is displayed when a fish bites onto the bait of a fishing rod.

      Information:

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

    • WAX_OFF

      public static final ParticleEffect WAX_OFF
      In vanilla, this particle is displayed when wax is removed from a copper block.

      Information:

      • Appearance: White star.
      • 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.

    • WAX_ON

      public static final ParticleEffect WAX_ON
      In vanilla, this particle is displayed when wax is applied to a copper block.

      Information:

      • Appearance: Orange star.
      • 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.

    • WHITE_ASH

      public static final ParticleEffect WHITE_ASH
      In vanilla, this particle is randomly displayed in the basalt deltas nether biome.

      The movement of this particle is handled completely clientside and can therefore not be influenced.

      Information

      • Appearance: White square
      • Speed value: Doesn't influence the particle.
      • Extra: This Particle gets a random velocity in the -x and -z directiont while falling down.

  • Field Details

  • Method Details

    • values

      public static ParticleEffect[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ParticleEffect valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getAvailableEffects

      public static Set<ParticleEffect> getAvailableEffects()
      Returns a set of all effects that are available in the current version.
      Returns:
      all available effects.

    • 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 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, 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, 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, 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, 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, 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.