Package org.bukkit
Enum Class Particle
- All Implemented Interfaces:
- Serializable,- Comparable<Particle>,- Constable,- Keyed,- RegistryAware
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classOptions which can be applied to redstone dust particles - a particle color and size.static classOptions which can be applied to a color transitioning dust particles.static classOptions which can be applied to trail particles - a location, color and duration.Nested classes/interfaces inherited from class java.lang.EnumEnum.EnumDesc<E extends Enum<E>>
- 
Enum Constant SummaryEnum ConstantsEnum ConstantDescriptionUsesBlockDataas DataTypeUsesBlockDataas DataTypeUsesBlockDataas DataTypeUsesParticle.DustOptionsas DataTypeUsesParticle.DustTransitionas DataTypeUsesBlockDataas DataTypeUsesColoras DataTypeUsesBlockDataas DataTypeUsesItemStackas DataTypeUseFloatas DataTypeUseIntegeras DataTypeUsesParticle.Trailas DataTypeUsesVibrationas DataType
- 
Method SummaryModifier and TypeMethodDescriptionClass<?> Returns the required data type for the particlegetKey()Deprecated.Gets the key of this instance if it is registered otherwise returnsnull.Gets the key of this instance if it is registered otherwise throws an error.booleanReturns whether this instance is register in a registry and therefore has a key or not.static ParticleReturns 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.
- 
Enum Constant Details- 
POOF
- 
EXPLOSION
- 
EXPLOSION_EMITTER
- 
FIREWORK
- 
BUBBLE
- 
SPLASH
- 
FISHING
- 
UNDERWATER
- 
CRIT
- 
ENCHANTED_HIT
- 
SMOKE
- 
LARGE_SMOKE
- 
EFFECT
- 
INSTANT_EFFECT
- 
ENTITY_EFFECTUsesColoras DataType
- 
WITCH
- 
DRIPPING_WATER
- 
DRIPPING_LAVA
- 
ANGRY_VILLAGER
- 
HAPPY_VILLAGER
- 
MYCELIUM
- 
NOTE
- 
PORTAL
- 
ENCHANT
- 
FLAME
- 
LAVA
- 
CLOUD
- 
DUSTUsesParticle.DustOptionsas DataType
- 
ITEM_SNOWBALL
- 
ITEM_SLIME
- 
HEART
- 
ITEMUsesItemStackas DataType
- 
BLOCKUsesBlockDataas DataType
- 
RAIN
- 
ELDER_GUARDIAN
- 
DRAGON_BREATH
- 
END_ROD
- 
DAMAGE_INDICATOR
- 
SWEEP_ATTACK
- 
FALLING_DUSTUsesBlockDataas DataType
- 
TOTEM_OF_UNDYING
- 
SPIT
- 
SQUID_INK
- 
BUBBLE_POP
- 
CURRENT_DOWN
- 
BUBBLE_COLUMN_UP
- 
NAUTILUS
- 
DOLPHIN
- 
SNEEZE
- 
CAMPFIRE_COSY_SMOKE
- 
CAMPFIRE_SIGNAL_SMOKE
- 
COMPOSTER
- 
FLASH
- 
FALLING_LAVA
- 
LANDING_LAVA
- 
FALLING_WATER
- 
DRIPPING_HONEY
- 
FALLING_HONEY
- 
LANDING_HONEY
- 
FALLING_NECTAR
- 
SOUL_FIRE_FLAME
- 
ASH
- 
CRIMSON_SPORE
- 
WARPED_SPORE
- 
SOUL
- 
DRIPPING_OBSIDIAN_TEAR
- 
FALLING_OBSIDIAN_TEAR
- 
LANDING_OBSIDIAN_TEAR
- 
REVERSE_PORTAL
- 
WHITE_ASH
- 
DUST_COLOR_TRANSITIONUsesParticle.DustTransitionas DataType
- 
VIBRATIONUsesVibrationas DataType
- 
FALLING_SPORE_BLOSSOM
- 
SPORE_BLOSSOM_AIR
- 
SMALL_FLAME
- 
SNOWFLAKE
- 
DRIPPING_DRIPSTONE_LAVA
- 
FALLING_DRIPSTONE_LAVA
- 
DRIPPING_DRIPSTONE_WATER
- 
FALLING_DRIPSTONE_WATER
- 
GLOW_SQUID_INK
- 
GLOW
- 
WAX_ON
- 
WAX_OFF
- 
ELECTRIC_SPARK
- 
SCRAPE
- 
SONIC_BOOM
- 
SCULK_SOUL
- 
SCULK_CHARGEUseFloatas DataType
- 
SCULK_CHARGE_POP
- 
SHRIEKUseIntegeras DataType
- 
CHERRY_LEAVES
- 
PALE_OAK_LEAVES
- 
EGG_CRACK
- 
DUST_PLUME
- 
WHITE_SMOKE
- 
GUST
- 
SMALL_GUST
- 
GUST_EMITTER_LARGE
- 
GUST_EMITTER_SMALL
- 
TRIAL_SPAWNER_DETECTION
- 
TRIAL_SPAWNER_DETECTION_OMINOUS
- 
VAULT_CONNECTION
- 
INFESTED
- 
ITEM_COBWEB
- 
DUST_PILLARUsesBlockDataas DataType
- 
BLOCK_CRUMBLEUsesBlockDataas DataType
- 
TRAILUsesParticle.Trailas DataType
- 
OMINOUS_SPAWNING
- 
RAID_OMEN
- 
TRIAL_OMEN
- 
BLOCK_MARKERUsesBlockDataas DataType
 
- 
- 
Method Details- 
valuesReturns 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
 
- 
valueOfReturns 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
 
- 
getDataTypeReturns the required data type for the particle- Returns:
- the required data type
 
- 
getKeyOrThrowDescription copied from interface:RegistryAwareGets the key of this instance if it is registered otherwise throws an error.
 This is a convenience method and plugins should always checkRegistryAware.isRegistered()before using this method.- Specified by:
- getKeyOrThrowin interface- RegistryAware
- Returns:
- the key with which this instance is registered.
- See Also:
 
- 
getKeyOrNullDescription copied from interface:RegistryAwareGets the key of this instance if it is registered otherwise returnsnull.- Specified by:
- getKeyOrNullin interface- RegistryAware
- Returns:
- the key with which this instance is registered or nullif not registered.
- See Also:
 
- 
isRegisteredpublic boolean isRegistered()Description copied from interface:RegistryAwareReturns whether this instance is register in a registry and therefore has a key or not.- Specified by:
- isRegisteredin interface- RegistryAware
- Returns:
- true, if this instance is registered. Otherwise, false.
- See Also:
 
- 
getKeyDeprecated.A key might not always be present, usegetKeyOrThrow()instead.Return the namespaced identifier for this object.
 
- 
getKeyOrThrow()instead.