Enum Class ParticleTypes

java.lang.Object

java.lang.Enum<ParticleTypes>

dev.wyck.wrapper.environment.particle.ParticleTypes

All Implemented Interfaces:

WrappedConstant<ParticleTypes>, Serializable, Comparable<ParticleTypes>, Constable

@NullMarked
@AsOf("2.0.0")
public enum ParticleTypes
extends Enum<ParticleTypes>
implements WrappedConstant<ParticleTypes>

An enum that wraps around Minecraft's ParticleTypes, providing additional metadata and functionality. Each enum constant corresponds to a specific particle type in Minecraft.

Since:

2.0.0

See Also:

• AmbientParticle
• ParticleCatalog
• ParticleData

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANGRY_VILLAGER
ASH
BLOCK
BLOCK_CRUMBLE
BLOCK_MARKER
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
DRIPPING_DRIPSTONE_LAVA
DRIPPING_DRIPSTONE_WATER
DRIPPING_HONEY
DRIPPING_LAVA
DRIPPING_OBSIDIAN_TEAR
DRIPPING_WATER
DUST
DUST_COLOR_TRANSITION
DUST_PILLAR
DUST_PLUME
EFFECT
EGG_CRACK
ELDER_GUARDIAN
ELECTRIC_SPARK
ENCHANT
ENCHANTED_HIT
END_ROD
ENTITY_EFFECT
EXPLOSION
EXPLOSION_EMITTER
FALLING_DRIPSTONE_LAVA
FALLING_DRIPSTONE_WATER
FALLING_DUST
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
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
SCULK_CHARGE_POP
SCULK_SOUL
SHRIEK
SMALL_FLAME
SMALL_GUST
SMOKE
SNEEZE
SNOWFLAKE
SONIC_BOOM
SOUL
SOUL_FIRE_FLAME
SPIT
SPLASH
SPORE_BLOSSOM_AIR
SQUID_INK
SWEEP_ATTACK
TINTED_LEAVES
TOTEM_OF_UNDYING
TRAIL
TRIAL_OMEN
TRIAL_SPAWNER_DETECTED_PLAYER
TRIAL_SPAWNER_DETECTED_PLAYER_OMINOUS
UNDERWATER
VAULT_CONNECTION
VIBRATION
WARPED_SPORE
WAX_OFF
WAX_ON
WHITE_ASH
WHITE_SMOKE
WITCH

Field Summary

Fields

Modifier and Type	Field	Description
static final RegisteredConstantTranslator<ParticleTypes>	TRANSLATOR

Method Summary

Modifier and Type	Method	Description
static @Nullable ParticleTypes	byKey(String key)	Returns the constant whose namespaced key matches (e.g.
@Nullable Class<? extends ParticleData>	getParticleDataClass()
boolean	isSimple()
ParticleType	particleType()	Gets a version-agnostic handle to this particle type, resolved on first access via the registered factory and cached.
ResourceKey	resourceKey()	The resource key of this particle.
RegisteredConstantTranslator<ParticleTypes>	translator()
static ParticleTypes	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ParticleTypes[]	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 WrappedConstant

fromNms, toNms

Enum Constant Details

ANGRY_VILLAGER

public static final ParticleTypes ANGRY_VILLAGER

BLOCK

public static final ParticleTypes BLOCK

BLOCK_MARKER

public static final ParticleTypes BLOCK_MARKER

BUBBLE

public static final ParticleTypes BUBBLE

CLOUD

public static final ParticleTypes CLOUD

COPPER_FIRE_FLAME

public static final ParticleTypes COPPER_FIRE_FLAME

CRIT

public static final ParticleTypes CRIT

DAMAGE_INDICATOR

public static final ParticleTypes DAMAGE_INDICATOR

DRAGON_BREATH

public static final ParticleTypes DRAGON_BREATH

DRIPPING_LAVA

public static final ParticleTypes DRIPPING_LAVA

FALLING_LAVA

public static final ParticleTypes FALLING_LAVA

LANDING_LAVA

public static final ParticleTypes LANDING_LAVA

DRIPPING_WATER

public static final ParticleTypes DRIPPING_WATER

FALLING_WATER

public static final ParticleTypes FALLING_WATER

DUST

public static final ParticleTypes DUST

DUST_COLOR_TRANSITION

public static final ParticleTypes DUST_COLOR_TRANSITION

EFFECT

public static final ParticleTypes EFFECT

ELDER_GUARDIAN

public static final ParticleTypes ELDER_GUARDIAN

ENCHANTED_HIT

public static final ParticleTypes ENCHANTED_HIT

ENCHANT

public static final ParticleTypes ENCHANT

END_ROD

public static final ParticleTypes END_ROD

ENTITY_EFFECT

public static final ParticleTypes ENTITY_EFFECT

EXPLOSION_EMITTER

public static final ParticleTypes EXPLOSION_EMITTER

EXPLOSION

public static final ParticleTypes EXPLOSION

GUST

public static final ParticleTypes GUST

SMALL_GUST

public static final ParticleTypes SMALL_GUST

GUST_EMITTER_LARGE

public static final ParticleTypes GUST_EMITTER_LARGE

GUST_EMITTER_SMALL

public static final ParticleTypes GUST_EMITTER_SMALL

SONIC_BOOM

public static final ParticleTypes SONIC_BOOM

FALLING_DUST

public static final ParticleTypes FALLING_DUST

FIREWORK

public static final ParticleTypes FIREWORK

FISHING

public static final ParticleTypes FISHING

FLAME

public static final ParticleTypes FLAME

INFESTED

public static final ParticleTypes INFESTED

CHERRY_LEAVES

public static final ParticleTypes CHERRY_LEAVES

PALE_OAK_LEAVES

public static final ParticleTypes PALE_OAK_LEAVES

TINTED_LEAVES

public static final ParticleTypes TINTED_LEAVES

SCULK_SOUL

public static final ParticleTypes SCULK_SOUL

SCULK_CHARGE

public static final ParticleTypes SCULK_CHARGE

SCULK_CHARGE_POP

public static final ParticleTypes SCULK_CHARGE_POP

SOUL_FIRE_FLAME

public static final ParticleTypes SOUL_FIRE_FLAME

SOUL

public static final ParticleTypes SOUL

FLASH

public static final ParticleTypes FLASH

HAPPY_VILLAGER

public static final ParticleTypes HAPPY_VILLAGER

COMPOSTER

public static final ParticleTypes COMPOSTER

HEART

public static final ParticleTypes HEART

INSTANT_EFFECT

public static final ParticleTypes INSTANT_EFFECT

ITEM

public static final ParticleTypes ITEM

VIBRATION

public static final ParticleTypes VIBRATION

TRAIL

public static final ParticleTypes TRAIL

ITEM_SLIME

public static final ParticleTypes ITEM_SLIME

ITEM_COBWEB

public static final ParticleTypes ITEM_COBWEB

ITEM_SNOWBALL

public static final ParticleTypes ITEM_SNOWBALL

LARGE_SMOKE

public static final ParticleTypes LARGE_SMOKE

LAVA

public static final ParticleTypes LAVA

MYCELIUM

public static final ParticleTypes MYCELIUM

NOTE

public static final ParticleTypes NOTE

POOF

public static final ParticleTypes POOF

PORTAL

public static final ParticleTypes PORTAL

RAIN

public static final ParticleTypes RAIN

SMOKE

public static final ParticleTypes SMOKE

WHITE_SMOKE

public static final ParticleTypes WHITE_SMOKE

SNEEZE

public static final ParticleTypes SNEEZE

SPIT

public static final ParticleTypes SPIT

SQUID_INK

public static final ParticleTypes SQUID_INK

SWEEP_ATTACK

public static final ParticleTypes SWEEP_ATTACK

TOTEM_OF_UNDYING

public static final ParticleTypes TOTEM_OF_UNDYING

UNDERWATER

public static final ParticleTypes UNDERWATER

SPLASH

public static final ParticleTypes SPLASH

WITCH

public static final ParticleTypes WITCH

BUBBLE_POP

public static final ParticleTypes BUBBLE_POP

CURRENT_DOWN

public static final ParticleTypes CURRENT_DOWN

BUBBLE_COLUMN_UP

public static final ParticleTypes BUBBLE_COLUMN_UP

NAUTILUS

public static final ParticleTypes NAUTILUS

DOLPHIN

public static final ParticleTypes DOLPHIN

CAMPFIRE_COSY_SMOKE

public static final ParticleTypes CAMPFIRE_COSY_SMOKE

CAMPFIRE_SIGNAL_SMOKE

public static final ParticleTypes CAMPFIRE_SIGNAL_SMOKE

DRIPPING_HONEY

public static final ParticleTypes DRIPPING_HONEY

FALLING_HONEY

public static final ParticleTypes FALLING_HONEY

LANDING_HONEY

public static final ParticleTypes LANDING_HONEY

FALLING_NECTAR

public static final ParticleTypes FALLING_NECTAR

FALLING_SPORE_BLOSSOM

public static final ParticleTypes FALLING_SPORE_BLOSSOM

ASH

public static final ParticleTypes ASH

CRIMSON_SPORE

public static final ParticleTypes CRIMSON_SPORE

WARPED_SPORE

public static final ParticleTypes WARPED_SPORE

SPORE_BLOSSOM_AIR

public static final ParticleTypes SPORE_BLOSSOM_AIR

DRIPPING_OBSIDIAN_TEAR

public static final ParticleTypes DRIPPING_OBSIDIAN_TEAR

FALLING_OBSIDIAN_TEAR

public static final ParticleTypes FALLING_OBSIDIAN_TEAR

LANDING_OBSIDIAN_TEAR

public static final ParticleTypes LANDING_OBSIDIAN_TEAR

REVERSE_PORTAL

public static final ParticleTypes REVERSE_PORTAL

WHITE_ASH

public static final ParticleTypes WHITE_ASH

SMALL_FLAME

public static final ParticleTypes SMALL_FLAME

SNOWFLAKE

public static final ParticleTypes SNOWFLAKE

DRIPPING_DRIPSTONE_LAVA

public static final ParticleTypes DRIPPING_DRIPSTONE_LAVA

FALLING_DRIPSTONE_LAVA

public static final ParticleTypes FALLING_DRIPSTONE_LAVA

DRIPPING_DRIPSTONE_WATER

public static final ParticleTypes DRIPPING_DRIPSTONE_WATER

FALLING_DRIPSTONE_WATER

public static final ParticleTypes FALLING_DRIPSTONE_WATER

GLOW_SQUID_INK

public static final ParticleTypes GLOW_SQUID_INK

GLOW

public static final ParticleTypes GLOW

WAX_ON

public static final ParticleTypes WAX_ON

WAX_OFF

public static final ParticleTypes WAX_OFF

ELECTRIC_SPARK

public static final ParticleTypes ELECTRIC_SPARK

SCRAPE

public static final ParticleTypes SCRAPE

SHRIEK

public static final ParticleTypes SHRIEK

EGG_CRACK

public static final ParticleTypes EGG_CRACK

DUST_PLUME

public static final ParticleTypes DUST_PLUME

TRIAL_SPAWNER_DETECTED_PLAYER

public static final ParticleTypes TRIAL_SPAWNER_DETECTED_PLAYER

TRIAL_SPAWNER_DETECTED_PLAYER_OMINOUS

public static final ParticleTypes TRIAL_SPAWNER_DETECTED_PLAYER_OMINOUS

VAULT_CONNECTION

public static final ParticleTypes VAULT_CONNECTION

DUST_PILLAR

public static final ParticleTypes DUST_PILLAR

OMINOUS_SPAWNING

public static final ParticleTypes OMINOUS_SPAWNING

RAID_OMEN

public static final ParticleTypes RAID_OMEN

TRIAL_OMEN

public static final ParticleTypes TRIAL_OMEN

BLOCK_CRUMBLE

public static final ParticleTypes BLOCK_CRUMBLE

FIREFLY

public static final ParticleTypes FIREFLY

Field Details

TRANSLATOR

public static final RegisteredConstantTranslator<ParticleTypes> TRANSLATOR

Method Details

values

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

resourceKey

@AsOf("3.0.0")
public ResourceKey resourceKey()

The resource key of this particle.

Returns:

the resource key of this particle.

Since:

3.0.0

translator

@AsOf("3.0.0")
public RegisteredConstantTranslator<ParticleTypes> translator()

Specified by:

translator in interface WrappedConstant<ParticleTypes>

particleType

@AsOf("1.1.0")
public ParticleType particleType()

Gets a version-agnostic handle to this particle type, resolved on first access via the registered factory and cached.

getParticleDataClass

@AsOf("1.1.0")
public @Nullable Class<? extends ParticleData> getParticleDataClass()

isSimple

@AsOf("1.1.0")
public boolean isSimple()

byKey

@AsOf("2.3.0")
public static @Nullable ParticleTypes byKey(String key)

Returns the constant whose namespaced key matches (e.g. "flame"), or null if none.

Since:

2.3.0