Package org.bukkit

Enum Class Particle

java.lang.Object

java.lang.Enum<Particle>

org.bukkit.Particle

All Implemented Interfaces:

Serializable, Comparable<Particle>, Constable, Keyed, RegistryAware

public enum Particle
extends Enum<Particle>
implements Keyed, RegistryAware

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Particle.DustOptions	Options which can be applied to redstone 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.Trail	Options which can be applied to trail particles - a location, color and duration.

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

Enum.EnumDesc<E extends Enum<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
CRIMSON_SPORE
CRIT
CURRENT_DOWN
DAMAGE_INDICATOR
DOLPHIN
DRAGON_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
EGG_CRACK
ELDER_GUARDIAN
ELECTRIC_SPARK
ENCHANT
ENCHANTED_HIT
END_ROD
ENTITY_EFFECT	Uses Color as DataType
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
GLOW
GLOW_SQUID_INK
GUST
GUST_EMITTER_LARGE
GUST_EMITTER_SMALL
HAPPY_VILLAGER
HEART
INFESTED
INSTANT_EFFECT
ITEM	Uses ItemStack as DataType
ITEM_COBWEB
ITEM_SLIME
ITEM_SNOWBALL
LANDING_HONEY
LANDING_LAVA
LANDING_OBSIDIAN_TEAR
LARGE_SMOKE
LAVA
MYCELIUM
NAUTILUS
NOTE
OMINOUS_SPAWNING
PALE_OAK_LEAVES
POOF
PORTAL
RAID_OMEN
RAIN
REVERSE_PORTAL
SCRAPE
SCULK_CHARGE	Use Float as DataType
SCULK_CHARGE_POP
SCULK_SOUL
SHRIEK	Use Integer as DataType
SMALL_FLAME
SMALL_GUST
SMOKE
SNEEZE
SNOWFLAKE
SONIC_BOOM
SOUL
SOUL_FIRE_FLAME
SPIT
SPLASH
SPORE_BLOSSOM_AIR
SQUID_INK
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

Method Summary

Modifier and Type	Method	Description
Class<?>	getDataType()	Returns the required data type for the particle
NamespacedKey	getKey()	Deprecated. A key might not always be present, use getKeyOrThrow() instead.
NamespacedKey	getKeyOrNull()	Gets the key of this instance if it is registered otherwise returns null.
NamespacedKey	getKeyOrThrow()	Gets the key of this instance if it is registered otherwise throws an error.
boolean	isRegistered()	Returns whether this instance is register in a registry and therefore has a key or not.
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 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

POOF

public static final Particle POOF

EXPLOSION

public static final Particle EXPLOSION

EXPLOSION_EMITTER

public static final Particle EXPLOSION_EMITTER

FIREWORK

public static final Particle FIREWORK

BUBBLE

public static final Particle BUBBLE

SPLASH

public static final Particle SPLASH

FISHING

public static final Particle FISHING

UNDERWATER

public static final Particle UNDERWATER

CRIT

public static final Particle CRIT

ENCHANTED_HIT

public static final Particle ENCHANTED_HIT

SMOKE

public static final Particle SMOKE

LARGE_SMOKE

public static final Particle LARGE_SMOKE

EFFECT

public static final Particle EFFECT

INSTANT_EFFECT

public static final Particle INSTANT_EFFECT

ENTITY_EFFECT

public static final Particle ENTITY_EFFECT

Uses Color as DataType

WITCH

public static final Particle WITCH

DRIPPING_WATER

public static final Particle DRIPPING_WATER

DRIPPING_LAVA

public static final Particle DRIPPING_LAVA

ANGRY_VILLAGER

public static final Particle ANGRY_VILLAGER

HAPPY_VILLAGER

public static final Particle HAPPY_VILLAGER

MYCELIUM

public static final Particle MYCELIUM

NOTE

public static final Particle NOTE

PORTAL

public static final Particle PORTAL

ENCHANT

public static final Particle ENCHANT

FLAME

public static final Particle FLAME

LAVA

public static final Particle LAVA

CLOUD

public static final Particle CLOUD

DUST

public static final Particle DUST

Uses Particle.DustOptions as DataType

ITEM_SNOWBALL

public static final Particle ITEM_SNOWBALL

ITEM_SLIME

public static final Particle ITEM_SLIME

HEART

public static final Particle HEART

ITEM

public static final Particle ITEM

Uses ItemStack as DataType

BLOCK

public static final Particle BLOCK

Uses BlockData as DataType

RAIN

public static final Particle RAIN

ELDER_GUARDIAN

public static final Particle ELDER_GUARDIAN

DRAGON_BREATH

public static final Particle DRAGON_BREATH

END_ROD

public static final Particle END_ROD

DAMAGE_INDICATOR

public static final Particle DAMAGE_INDICATOR

SWEEP_ATTACK

public static final Particle SWEEP_ATTACK

FALLING_DUST

public static final Particle FALLING_DUST

Uses BlockData as DataType

TOTEM_OF_UNDYING

public static final Particle TOTEM_OF_UNDYING

SPIT

public static final Particle SPIT

SQUID_INK

public static final Particle SQUID_INK

BUBBLE_POP

public static final Particle BUBBLE_POP

CURRENT_DOWN

public static final Particle CURRENT_DOWN

BUBBLE_COLUMN_UP

public static final Particle BUBBLE_COLUMN_UP

NAUTILUS

public static final Particle NAUTILUS

DOLPHIN

public static final Particle DOLPHIN

SNEEZE

public static final Particle SNEEZE

CAMPFIRE_COSY_SMOKE

public static final Particle CAMPFIRE_COSY_SMOKE

CAMPFIRE_SIGNAL_SMOKE

public static final Particle CAMPFIRE_SIGNAL_SMOKE

COMPOSTER

public static final Particle COMPOSTER

FLASH

public static final Particle FLASH

FALLING_LAVA

public static final Particle FALLING_LAVA

LANDING_LAVA

public static final Particle LANDING_LAVA

FALLING_WATER

public static final Particle FALLING_WATER

DRIPPING_HONEY

public static final Particle DRIPPING_HONEY

FALLING_HONEY

public static final Particle FALLING_HONEY

LANDING_HONEY

public static final Particle LANDING_HONEY

FALLING_NECTAR

public static final Particle FALLING_NECTAR

SOUL_FIRE_FLAME

public static final Particle SOUL_FIRE_FLAME

ASH

public static final Particle ASH

CRIMSON_SPORE

public static final Particle CRIMSON_SPORE

WARPED_SPORE

public static final Particle WARPED_SPORE

SOUL

public static final Particle SOUL

DRIPPING_OBSIDIAN_TEAR

public static final Particle DRIPPING_OBSIDIAN_TEAR

FALLING_OBSIDIAN_TEAR

public static final Particle FALLING_OBSIDIAN_TEAR

LANDING_OBSIDIAN_TEAR

public static final Particle LANDING_OBSIDIAN_TEAR

REVERSE_PORTAL

public static final Particle REVERSE_PORTAL

WHITE_ASH

public static final Particle WHITE_ASH

DUST_COLOR_TRANSITION

public static final Particle DUST_COLOR_TRANSITION

Uses Particle.DustTransition as DataType

VIBRATION

public static final Particle VIBRATION

Uses Vibration as DataType

FALLING_SPORE_BLOSSOM

public static final Particle FALLING_SPORE_BLOSSOM

SPORE_BLOSSOM_AIR

public static final Particle SPORE_BLOSSOM_AIR

SMALL_FLAME

public static final Particle SMALL_FLAME

SNOWFLAKE

public static final Particle SNOWFLAKE

DRIPPING_DRIPSTONE_LAVA

public static final Particle DRIPPING_DRIPSTONE_LAVA

FALLING_DRIPSTONE_LAVA

public static final Particle FALLING_DRIPSTONE_LAVA

DRIPPING_DRIPSTONE_WATER

public static final Particle DRIPPING_DRIPSTONE_WATER

FALLING_DRIPSTONE_WATER

public static final Particle FALLING_DRIPSTONE_WATER

GLOW_SQUID_INK

public static final Particle GLOW_SQUID_INK

GLOW

public static final Particle GLOW

WAX_ON

public static final Particle WAX_ON

WAX_OFF

public static final Particle WAX_OFF

ELECTRIC_SPARK

public static final Particle ELECTRIC_SPARK

SCRAPE

public static final Particle SCRAPE

SONIC_BOOM

public static final Particle SONIC_BOOM

SCULK_SOUL

public static final Particle SCULK_SOUL

SCULK_CHARGE

public static final Particle SCULK_CHARGE

Use Float as DataType

SCULK_CHARGE_POP

public static final Particle SCULK_CHARGE_POP

SHRIEK

public static final Particle SHRIEK

Use Integer as DataType

CHERRY_LEAVES

public static final Particle CHERRY_LEAVES

PALE_OAK_LEAVES

public static final Particle PALE_OAK_LEAVES

TINTED_LEAVES

public static final Particle TINTED_LEAVES

Uses Color as DataType

EGG_CRACK

public static final Particle EGG_CRACK

DUST_PLUME

public static final Particle DUST_PLUME

WHITE_SMOKE

public static final Particle WHITE_SMOKE

GUST

public static final Particle GUST

SMALL_GUST

public static final Particle SMALL_GUST

GUST_EMITTER_LARGE

public static final Particle GUST_EMITTER_LARGE

GUST_EMITTER_SMALL

public static final Particle GUST_EMITTER_SMALL

TRIAL_SPAWNER_DETECTION

public static final Particle TRIAL_SPAWNER_DETECTION

TRIAL_SPAWNER_DETECTION_OMINOUS

public static final Particle TRIAL_SPAWNER_DETECTION_OMINOUS

VAULT_CONNECTION

public static final Particle VAULT_CONNECTION

INFESTED

public static final Particle INFESTED

ITEM_COBWEB

public static final Particle ITEM_COBWEB

DUST_PILLAR

public static final Particle DUST_PILLAR

Uses BlockData as DataType

BLOCK_CRUMBLE

@Experimental
public static final Particle BLOCK_CRUMBLE

Uses BlockData as DataType

TRAIL

@Experimental
public static final Particle TRAIL

Uses Particle.Trail as DataType

OMINOUS_SPAWNING

public static final Particle OMINOUS_SPAWNING

RAID_OMEN

public static final Particle RAID_OMEN

TRIAL_OMEN

public static final Particle TRIAL_OMEN

BLOCK_MARKER

public static final Particle BLOCK_MARKER

Uses BlockData as DataType

FIREFLY

public static final Particle FIREFLY

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 Class<?> getDataType()

Returns the required data type for the particle

Returns:

the required data type

getKeyOrThrow

@NotNull
public NamespacedKey getKeyOrThrow()

Description copied from interface: RegistryAware

Gets the key of this instance if it is registered otherwise throws an error.
This is a convenience method and plugins should always check RegistryAware.isRegistered() before using this method.

Specified by:

getKeyOrThrow in interface RegistryAware

Returns:

the key with which this instance is registered.

See Also:

• RegistryAware.isRegistered()
• RegistryAware.getKeyOrNull()
• Registry

getKeyOrNull

@Nullable
public NamespacedKey getKeyOrNull()

Description copied from interface: RegistryAware

Gets the key of this instance if it is registered otherwise returns null.

Specified by:

getKeyOrNull in interface RegistryAware

Returns:

the key with which this instance is registered or null if not registered.

See Also:

• RegistryAware.getKeyOrThrow()
• Registry

isRegistered

public boolean isRegistered()

Description copied from interface: RegistryAware

Returns whether this instance is register in a registry and therefore has a key or not.

Specified by:

isRegistered in interface RegistryAware

Returns:

true, if this instance is registered. Otherwise, false.

See Also:

• RegistryAware.getKeyOrThrow()
• Registry

getKey

@NotNull
@Deprecated(since="1.21.4")
public NamespacedKey getKey()

Deprecated.

A key might not always be present, use getKeyOrThrow() instead.

Return the namespaced identifier for this object.

Specified by:

getKey in interface Keyed

Returns:

this object's key

See Also:

• getKeyOrThrow()
• isRegistered()