Enum Class Particle

java.lang.Object

java.lang.Enum<Particle>

org.bukkit.Particle

All Implemented Interfaces:

Serializable, Comparable<Particle>, Constable, net.kyori.adventure.key.Keyed, Keyed

public enum Particle
extends Enum<Particle>
implements Keyed

Since:

1.9.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Particle.DustOptions	Options which can be applied to dust particles - a particle color and size.
static class	Particle.DustTransition	Options which can be applied to a color transitioning dust particles.
static class	Particle.Geyser	Options which can be applied to geyser particles.
static class	Particle.GeyserBase	Options which can be applied to geyser base particles.
static enum	Particle.RandomizationType	The randomization type for the particle, which controls how offset and speed are randomized.
static class	Particle.Spell	Options which can be applied to effect particles.
static class	Particle.Trail	Options which can be applied to trail particles - a location, color and duration.

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANGRY_VILLAGER
ASH
BLOCK	Uses BlockData as DataType
BLOCK_CRUMBLE	Uses BlockData as DataType
BLOCK_MARKER	Uses BlockData as DataType
BUBBLE
BUBBLE_COLUMN_UP
BUBBLE_POP
CAMPFIRE_COSY_SMOKE
CAMPFIRE_SIGNAL_SMOKE
CHERRY_LEAVES
CLOUD
COMPOSTER
COPPER_FIRE_FLAME
CRIMSON_SPORE
CRIT
CURRENT_DOWN
DAMAGE_INDICATOR
DOLPHIN
DRAGON_BREATH	Uses Float as DataType, for the power of the breath
DRIPPING_DRIPSTONE_LAVA
DRIPPING_DRIPSTONE_WATER
DRIPPING_HONEY
DRIPPING_LAVA
DRIPPING_OBSIDIAN_TEAR
DRIPPING_WATER
DUST	Uses Particle.DustOptions as DataType
DUST_COLOR_TRANSITION	Uses Particle.DustTransition as DataType
DUST_PILLAR	Uses BlockData as DataType
DUST_PLUME
EFFECT	Uses Particle.Spell as DataType
EGG_CRACK
ELDER_GUARDIAN
ELECTRIC_SPARK
ENCHANT
ENCHANTED_HIT
END_ROD
ENTITY_EFFECT	Uses Color as DataType (with alpha support)
EXPLOSION
EXPLOSION_EMITTER
FALLING_DRIPSTONE_LAVA
FALLING_DRIPSTONE_WATER
FALLING_DUST	Uses BlockData as DataType
FALLING_HONEY
FALLING_LAVA
FALLING_NECTAR
FALLING_OBSIDIAN_TEAR
FALLING_SPORE_BLOSSOM
FALLING_WATER
FIREFLY
FIREWORK
FISHING
FLAME
FLASH	Uses Color as DataType
GEYSER	Uses Particle.Geyser as DataType
GEYSER_BASE	Uses Particle.GeyserBase as DataType
GEYSER_PLUME	Uses Particle.Geyser as DataType
GEYSER_POOF	Uses Particle.GeyserBase as DataType
GLOW
GLOW_SQUID_INK
GUST
GUST_EMITTER_LARGE
GUST_EMITTER_SMALL
HAPPY_VILLAGER
HEART
INFESTED
INSTANT_EFFECT	Uses Particle.Spell as DataType
ITEM	Uses ItemStack as DataType
ITEM_COBWEB
ITEM_SLIME
ITEM_SNOWBALL
LANDING_HONEY
LANDING_LAVA
LANDING_OBSIDIAN_TEAR
LARGE_SMOKE
LAVA
MYCELIUM
NAUTILUS
NOTE
NOXIOUS_GAS
NOXIOUS_GAS_CLOUD
OMINOUS_SPAWNING
ORANGE_POPLAR_LEAVES
PALE_OAK_LEAVES
PAUSE_MOB_GROWTH
POOF
PORTAL
RAID_OMEN
RAIN
RED_POPLAR_LEAVES
RESET_MOB_GROWTH
REVERSE_PORTAL
SCRAPE
SCULK_CHARGE	Uses Float as DataType, the angle in radians
SCULK_CHARGE_POP
SCULK_SOUL
SHRIEK	Uses Integer as DataType
SMALL_FLAME
SMALL_GUST
SMOKE
SNEEZE
SNOWFLAKE
SONIC_BOOM
SOUL
SOUL_FIRE_FLAME
SPIT
SPLASH
SPORE_BLOSSOM_AIR
SQUID_INK
SULFUR_BUBBLES
SULFUR_CUBE_GOO
SWEEP_ATTACK
TINTED_LEAVES	Uses Color as DataType
TOTEM_OF_UNDYING
TRAIL	Uses Particle.Trail as DataType
TRIAL_OMEN
TRIAL_SPAWNER_DETECTION
TRIAL_SPAWNER_DETECTION_OMINOUS
UNDERWATER
VAULT_CONNECTION
VIBRATION	Uses Vibration as DataType
WARPED_SPORE
WAX_OFF
WAX_ON
WHITE_ASH
WHITE_SMOKE
WITCH
YELLOW_POPLAR_LEAVES

Method Summary

Modifier and Type	Method	Description
ParticleBuilder	builder()	Creates a ParticleBuilder
@NotNull Class<?>	getDataType()	Returns the required data type for the particle
@NotNull NamespacedKey	getKey()	Return the namespaced identifier for this object.
static Particle	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Particle[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Keyed

key

Enum Constant Details

POOF

public static final Particle POOF

Since:

1.20.6

EXPLOSION

public static final Particle EXPLOSION

Since:

1.20.6

EXPLOSION_EMITTER

public static final Particle EXPLOSION_EMITTER

Since:

1.20.6

FIREWORK

public static final Particle FIREWORK

Since:

1.20.6

BUBBLE

public static final Particle BUBBLE

Since:

1.20.6

SPLASH

public static final Particle SPLASH

Since:

1.20.6

FISHING

public static final Particle FISHING

Since:

1.20.6

UNDERWATER

public static final Particle UNDERWATER

Since:

1.20.6

CRIT

public static final Particle CRIT

Since:

1.9.4

ENCHANTED_HIT

public static final Particle ENCHANTED_HIT

Since:

1.20.6

SMOKE

public static final Particle SMOKE

Since:

1.20.6

LARGE_SMOKE

public static final Particle LARGE_SMOKE

Since:

1.20.6

EFFECT

public static final Particle EFFECT

Uses Particle.Spell as DataType

Since:

1.20.6

INSTANT_EFFECT

public static final Particle INSTANT_EFFECT

Uses Particle.Spell as DataType

Since:

1.20.6

ENTITY_EFFECT

public static final Particle ENTITY_EFFECT

Uses Color as DataType (with alpha support)

Since:

1.20.6

WITCH

public static final Particle WITCH

Since:

1.20.6

DRIPPING_WATER

public static final Particle DRIPPING_WATER

Since:

1.20.6

DRIPPING_LAVA

public static final Particle DRIPPING_LAVA

Since:

1.20.6

ANGRY_VILLAGER

public static final Particle ANGRY_VILLAGER

Since:

1.20.6

HAPPY_VILLAGER

public static final Particle HAPPY_VILLAGER

Since:

1.20.6

MYCELIUM

public static final Particle MYCELIUM

Since:

1.20.6

NOTE

public static final Particle NOTE

Since:

1.9.4

PORTAL

public static final Particle PORTAL

Since:

1.9.4

ENCHANT

public static final Particle ENCHANT

Since:

1.20.6

FLAME

public static final Particle FLAME

Since:

1.9.4

LAVA

public static final Particle LAVA

Since:

1.9.4

CLOUD

public static final Particle CLOUD

Since:

1.9.4

DUST

public static final Particle DUST

Uses Particle.DustOptions as DataType

Since:

1.20.6

ITEM_SNOWBALL

public static final Particle ITEM_SNOWBALL

Since:

1.20.6

ITEM_SLIME

public static final Particle ITEM_SLIME

Since:

1.20.6

HEART

public static final Particle HEART

Since:

1.9.4

ITEM

public static final Particle ITEM

Uses ItemStack as DataType

Since:

1.20.6

BLOCK

public static final Particle BLOCK

Uses BlockData as DataType

Since:

1.20.6

RAIN

public static final Particle RAIN

Since:

1.20.6

ELDER_GUARDIAN

public static final Particle ELDER_GUARDIAN

Since:

1.20.6

DRAGON_BREATH

public static final Particle DRAGON_BREATH

Uses Float as DataType, for the power of the breath

Since:

1.9.4

END_ROD

public static final Particle END_ROD

Since:

1.9.4

DAMAGE_INDICATOR

public static final Particle DAMAGE_INDICATOR

Since:

1.9.4

SWEEP_ATTACK

public static final Particle SWEEP_ATTACK

Since:

1.9.4

FALLING_DUST

public static final Particle FALLING_DUST

Uses BlockData as DataType

Since:

1.10.2

TOTEM_OF_UNDYING

public static final Particle TOTEM_OF_UNDYING

Since:

1.20.6

SPIT

public static final Particle SPIT

Since:

1.11

SQUID_INK

public static final Particle SQUID_INK

Since:

1.13

BUBBLE_POP

public static final Particle BUBBLE_POP

Since:

1.13

CURRENT_DOWN

public static final Particle CURRENT_DOWN

Since:

1.13

BUBBLE_COLUMN_UP

public static final Particle BUBBLE_COLUMN_UP

Since:

1.13

NAUTILUS

public static final Particle NAUTILUS

Since:

1.13

DOLPHIN

public static final Particle DOLPHIN

Since:

1.13

SNEEZE

public static final Particle SNEEZE

Since:

1.14

CAMPFIRE_COSY_SMOKE

public static final Particle CAMPFIRE_COSY_SMOKE

Since:

1.14

CAMPFIRE_SIGNAL_SMOKE

public static final Particle CAMPFIRE_SIGNAL_SMOKE

Since:

1.14

COMPOSTER

public static final Particle COMPOSTER

Since:

1.14

FLASH

public static final Particle FLASH

Uses Color as DataType

Since:

1.14

FALLING_LAVA

public static final Particle FALLING_LAVA

Since:

1.14

LANDING_LAVA

public static final Particle LANDING_LAVA

Since:

1.14

FALLING_WATER

public static final Particle FALLING_WATER

Since:

1.14

DRIPPING_HONEY

public static final Particle DRIPPING_HONEY

Since:

1.15

FALLING_HONEY

public static final Particle FALLING_HONEY

Since:

1.15

LANDING_HONEY

public static final Particle LANDING_HONEY

Since:

1.15

FALLING_NECTAR

public static final Particle FALLING_NECTAR

Since:

1.15

SOUL_FIRE_FLAME

public static final Particle SOUL_FIRE_FLAME

Since:

1.16.1

ASH

public static final Particle ASH

Since:

1.16.1

CRIMSON_SPORE

public static final Particle CRIMSON_SPORE

Since:

1.16.1

WARPED_SPORE

public static final Particle WARPED_SPORE

Since:

1.16.1

SOUL

public static final Particle SOUL

Since:

1.16.1

DRIPPING_OBSIDIAN_TEAR

public static final Particle DRIPPING_OBSIDIAN_TEAR

Since:

1.16.1

FALLING_OBSIDIAN_TEAR

public static final Particle FALLING_OBSIDIAN_TEAR

Since:

1.16.1

LANDING_OBSIDIAN_TEAR

public static final Particle LANDING_OBSIDIAN_TEAR

Since:

1.16.1

REVERSE_PORTAL

public static final Particle REVERSE_PORTAL

Since:

1.16.1

WHITE_ASH

public static final Particle WHITE_ASH

Since:

1.16.1

DUST_COLOR_TRANSITION

public static final Particle DUST_COLOR_TRANSITION

Uses Particle.DustTransition as DataType

Since:

1.17

VIBRATION

public static final Particle VIBRATION

Uses Vibration as DataType

Since:

1.17

FALLING_SPORE_BLOSSOM

public static final Particle FALLING_SPORE_BLOSSOM

Since:

1.17

SPORE_BLOSSOM_AIR

public static final Particle SPORE_BLOSSOM_AIR

Since:

1.17

SMALL_FLAME

public static final Particle SMALL_FLAME

Since:

1.17

SNOWFLAKE

public static final Particle SNOWFLAKE

Since:

1.17

DRIPPING_DRIPSTONE_LAVA

public static final Particle DRIPPING_DRIPSTONE_LAVA

Since:

1.17

FALLING_DRIPSTONE_LAVA

public static final Particle FALLING_DRIPSTONE_LAVA

Since:

1.17

DRIPPING_DRIPSTONE_WATER

public static final Particle DRIPPING_DRIPSTONE_WATER

Since:

1.17

FALLING_DRIPSTONE_WATER

public static final Particle FALLING_DRIPSTONE_WATER

Since:

1.17

GLOW_SQUID_INK

public static final Particle GLOW_SQUID_INK

Since:

1.17

GLOW

public static final Particle GLOW

Since:

1.17

WAX_ON

public static final Particle WAX_ON

Since:

1.17

WAX_OFF

public static final Particle WAX_OFF

Since:

1.17

ELECTRIC_SPARK

public static final Particle ELECTRIC_SPARK

Since:

1.17

SCRAPE

public static final Particle SCRAPE

Since:

1.17

SONIC_BOOM

public static final Particle SONIC_BOOM

Since:

1.19

SCULK_SOUL

public static final Particle SCULK_SOUL

Since:

1.19

SCULK_CHARGE

public static final Particle SCULK_CHARGE

Uses Float as DataType, the angle in radians

Since:

1.19

SCULK_CHARGE_POP

public static final Particle SCULK_CHARGE_POP

Since:

1.19

SHRIEK

public static final Particle SHRIEK

Uses Integer as DataType

Since:

1.19

CHERRY_LEAVES

public static final Particle CHERRY_LEAVES

Since:

1.20

PALE_OAK_LEAVES

public static final Particle PALE_OAK_LEAVES

Since:

1.21.4

RED_POPLAR_LEAVES

public static final Particle RED_POPLAR_LEAVES

Since:

26.3

ORANGE_POPLAR_LEAVES

public static final Particle ORANGE_POPLAR_LEAVES

Since:

26.3

YELLOW_POPLAR_LEAVES

public static final Particle YELLOW_POPLAR_LEAVES

Since:

26.3

TINTED_LEAVES

public static final Particle TINTED_LEAVES

Uses Color as DataType

Since:

1.21.6

EGG_CRACK

public static final Particle EGG_CRACK

Since:

1.20

DUST_PLUME

public static final Particle DUST_PLUME

Since:

1.20.4

WHITE_SMOKE

public static final Particle WHITE_SMOKE

Since:

1.20.4

GUST

public static final Particle GUST

Since:

1.20.4

SMALL_GUST

public static final Particle SMALL_GUST

Since:

1.20.6

GUST_EMITTER_LARGE

public static final Particle GUST_EMITTER_LARGE

Since:

1.20.6

GUST_EMITTER_SMALL

public static final Particle GUST_EMITTER_SMALL

Since:

1.20.6

TRIAL_SPAWNER_DETECTION

public static final Particle TRIAL_SPAWNER_DETECTION

Since:

1.20.4

TRIAL_SPAWNER_DETECTION_OMINOUS

public static final Particle TRIAL_SPAWNER_DETECTION_OMINOUS

Since:

1.20.6

VAULT_CONNECTION

public static final Particle VAULT_CONNECTION

Since:

1.20.6

INFESTED

public static final Particle INFESTED

Since:

1.20.6

ITEM_COBWEB

public static final Particle ITEM_COBWEB

Since:

1.20.6

DUST_PILLAR

public static final Particle DUST_PILLAR

Uses BlockData as DataType

Since:

1.20.6

BLOCK_CRUMBLE

public static final Particle BLOCK_CRUMBLE

Uses BlockData as DataType

Since:

1.21.3

FIREFLY

public static final Particle FIREFLY

Since:

1.21.6

TRAIL

public static final Particle TRAIL

Uses Particle.Trail as DataType

Since:

1.21.3

OMINOUS_SPAWNING

public static final Particle OMINOUS_SPAWNING

Since:

1.20.6

RAID_OMEN

public static final Particle RAID_OMEN

Since:

1.20.6

TRIAL_OMEN

public static final Particle TRIAL_OMEN

Since:

1.20.6

BLOCK_MARKER

public static final Particle BLOCK_MARKER

Uses BlockData as DataType

Since:

1.18.1

COPPER_FIRE_FLAME

public static final Particle COPPER_FIRE_FLAME

Since:

1.21.10

PAUSE_MOB_GROWTH

public static final Particle PAUSE_MOB_GROWTH

Since:

26.1.2

RESET_MOB_GROWTH

public static final Particle RESET_MOB_GROWTH

Since:

26.1.2

NOXIOUS_GAS

public static final Particle NOXIOUS_GAS

Since:

26.2

NOXIOUS_GAS_CLOUD

public static final Particle NOXIOUS_GAS_CLOUD

Since:

26.2

SULFUR_CUBE_GOO

public static final Particle SULFUR_CUBE_GOO

Since:

26.2

SULFUR_BUBBLES

public static final Particle SULFUR_BUBBLES

Since:

26.2

GEYSER

public static final Particle GEYSER

Uses Particle.Geyser as DataType

Since:

26.2

GEYSER_BASE

public static final Particle GEYSER_BASE

Uses Particle.GeyserBase as DataType

Since:

26.2

GEYSER_PLUME

public static final Particle GEYSER_PLUME

Uses Particle.Geyser as DataType

Since:

26.2

GEYSER_POOF

public static final Particle GEYSER_POOF

Uses Particle.GeyserBase as DataType

Since:

26.2

Method Details

values

public static Particle[] 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 Particle 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

getDataType

@NotNull
public @NotNull Class<?> getDataType()

Returns the required data type for the particle

Returns:

the required data type

Since:

1.9.4

getKey

@NotNull
public @NotNull NamespacedKey getKey()

Description copied from interface: Keyed

Return the namespaced identifier for this object.

Specified by:

getKey in interface Keyed

Returns:

this object's key

Since:

1.20.2

builder

@NotNull
public ParticleBuilder builder()

Creates a ParticleBuilder

Returns:

a ParticleBuilder for the particle

Since:

1.12.2