Package org.bukkit

Enum Effect

java.lang.Object
java.lang.Enum<Effect>
org.bukkit.Effect
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Effect>, java.lang.constant.Constable
public enum Effect
extends java.lang.Enum<Effect>
A list of effects that the server is able to send to players.

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  Effect.Type
    Represents the type of an effect.

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

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    BLAZE_SHOOT
    Sound of blaze firing.
    BOW_FIRE
    Sound of a bow firing.
    CLICK1
    A click sound.
    CLICK2
    An alternate click sound.
    CLOUD
    A puff of white smoke
    COLOURED_DUST
    Multicolored dust particles
    CRIT
    Critical hit particles
    DOOR_TOGGLE
    Sound of a door opening/closing.
    ENDER_SIGNAL
    An ender eye signal; a visual effect.
    EXPLOSION
    Explosion particles
    EXPLOSION_HUGE
    The biggest explosion particle effect
    EXPLOSION_LARGE
    A larger version of the explode particle
    EXTINGUISH
    Sound of fire being extinguished.
    FIREWORKS_SPARK
    The spark that comes off a fireworks
    FLAME
    Fire particles
    FLYING_GLYPH
    The symbols that fly towards the enchantment table
    FOOTSTEP
    A small gray square
    GHAST_SHOOT
    Sound of ghast firing.
    GHAST_SHRIEK
    Sound of ghast shrieking.
    HAPPY_VILLAGER
    The particle that appears when trading with a villager
    HEART
    The particle that appears when breading animals
    INSTANT_SPELL
    A puff of white stars
    ITEM_BREAK
    The particles generated when a tool breaks.
    LARGE_SMOKE
    The smoke particles that appears on blazes, minecarts with furnaces and fire
    LAVA_POP
    The particles that pop out of lava
    LAVADRIP
    The lava drip particle that appears on blocks under lava
    MAGIC_CRIT
    Blue critical hit particles
    MOBSPAWNER_FLAMES
    The flames seen on a mobspawner; a visual effect.
    NOTE
    The note that appears above note blocks
    PARTICLE_SMOKE
    Smoke particles
    PORTAL
    The particles shown at nether portals
    POTION_BREAK
    Visual effect of a splash potion breaking.
    POTION_SWIRL
    Multicolored potion effect particles
    POTION_SWIRL_TRANSPARENT
    Multicolored potion effect particles that are slightly transparent
    RECORD_PLAY
    A song from a record.
    SLIME
    The particle shown when a slime jumps
    SMALL_SMOKE
    Small gray particles
    SMOKE
    A visual smoke effect.
    SNOW_SHOVEL
    White particles
    SNOWBALL_BREAK
    Snowball breaking
    SPELL
    A puff of white potion swirls
    SPLASH
    Water particles
    STEP_SOUND
    Sound of a block breaking.
    TILE_BREAK
    The particles generated while breaking a block.
    TILE_DUST
    The particles generated while sprinting a block This particle requires a Material and data value so that the client can select the correct texture.
    VILLAGER_THUNDERCLOUD
    The particle that appears when hitting a villager
    VOID_FOG
    Small gray particles
    WATERDRIP
    The water drip particle that appears on blocks under water
    WITCH_MAGIC
    A puff of purple particles
    ZOMBIE_CHEW_IRON_DOOR
    Sound of zombies chewing on iron doors.
    ZOMBIE_CHEW_WOODEN_DOOR
    Sound of zombies chewing on wooden doors.
    ZOMBIE_DESTROY_DOOR
    Sound of zombies destroying a door.

  • Method Summary

    Modifier and Type Method Description
    static Effect getById​(int id)
    Deprecated.
    Magic value
    static Effect getByName​(java.lang.String name)
    Gets the Effect associated with the given name.
    java.lang.Class<?> getData()  
    int getId()
    Deprecated.
    Magic value
    java.lang.String getName()
    Returns the effect's name.
    Effect.Type getType()  
    static Effect valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static Effect[] values()
    Returns an array containing the constants of this enum type, 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

    • CLICK2

      public static final Effect CLICK2
      An alternate click sound.

    • CLICK1

      public static final Effect CLICK1
      A click sound.

    • BOW_FIRE

      public static final Effect BOW_FIRE
      Sound of a bow firing.

    • DOOR_TOGGLE

      public static final Effect DOOR_TOGGLE
      Sound of a door opening/closing.

    • EXTINGUISH

      public static final Effect EXTINGUISH
      Sound of fire being extinguished.

    • RECORD_PLAY

      public static final Effect RECORD_PLAY
      A song from a record. Needs the record item ID as additional info

    • GHAST_SHRIEK

      public static final Effect GHAST_SHRIEK
      Sound of ghast shrieking.

    • GHAST_SHOOT

      public static final Effect GHAST_SHOOT
      Sound of ghast firing.

    • BLAZE_SHOOT

      public static final Effect BLAZE_SHOOT
      Sound of blaze firing.

    • ZOMBIE_CHEW_WOODEN_DOOR

      public static final Effect ZOMBIE_CHEW_WOODEN_DOOR
      Sound of zombies chewing on wooden doors.

    • ZOMBIE_CHEW_IRON_DOOR

      public static final Effect ZOMBIE_CHEW_IRON_DOOR
      Sound of zombies chewing on iron doors.

    • ZOMBIE_DESTROY_DOOR

      public static final Effect ZOMBIE_DESTROY_DOOR
      Sound of zombies destroying a door.

    • SMOKE

      public static final Effect SMOKE
      A visual smoke effect. Needs direction as additional info.

    • STEP_SOUND

      public static final Effect STEP_SOUND
      Sound of a block breaking. Needs block ID as additional info.

    • POTION_BREAK

      public static final Effect POTION_BREAK
      Visual effect of a splash potion breaking. Needs potion data value as additional info.

    • ENDER_SIGNAL

      public static final Effect ENDER_SIGNAL
      An ender eye signal; a visual effect.

    • MOBSPAWNER_FLAMES

      public static final Effect MOBSPAWNER_FLAMES
      The flames seen on a mobspawner; a visual effect.

    • FIREWORKS_SPARK

      public static final Effect FIREWORKS_SPARK
      The spark that comes off a fireworks

    • CRIT

      public static final Effect CRIT
      Critical hit particles

    • MAGIC_CRIT

      public static final Effect MAGIC_CRIT
      Blue critical hit particles

    • POTION_SWIRL

      public static final Effect POTION_SWIRL
      Multicolored potion effect particles

    • POTION_SWIRL_TRANSPARENT

      public static final Effect POTION_SWIRL_TRANSPARENT
      Multicolored potion effect particles that are slightly transparent

    • SPELL

      public static final Effect SPELL
      A puff of white potion swirls

    • INSTANT_SPELL

      public static final Effect INSTANT_SPELL
      A puff of white stars

    • WITCH_MAGIC

      public static final Effect WITCH_MAGIC
      A puff of purple particles

    • NOTE

      public static final Effect NOTE
      The note that appears above note blocks

    • PORTAL

      public static final Effect PORTAL
      The particles shown at nether portals

    • FLYING_GLYPH

      public static final Effect FLYING_GLYPH
      The symbols that fly towards the enchantment table

    • FLAME

      public static final Effect FLAME
      Fire particles

    • LAVA_POP

      public static final Effect LAVA_POP
      The particles that pop out of lava

    • FOOTSTEP

      public static final Effect FOOTSTEP
      A small gray square

    • SPLASH

      public static final Effect SPLASH
      Water particles

    • PARTICLE_SMOKE

      public static final Effect PARTICLE_SMOKE
      Smoke particles

    • EXPLOSION_HUGE

      public static final Effect EXPLOSION_HUGE
      The biggest explosion particle effect

    • EXPLOSION_LARGE

      public static final Effect EXPLOSION_LARGE
      A larger version of the explode particle

    • EXPLOSION

      public static final Effect EXPLOSION
      Explosion particles

    • VOID_FOG

      public static final Effect VOID_FOG
      Small gray particles

    • SMALL_SMOKE

      public static final Effect SMALL_SMOKE
      Small gray particles

    • CLOUD

      public static final Effect CLOUD
      A puff of white smoke

    • COLOURED_DUST

      public static final Effect COLOURED_DUST
      Multicolored dust particles

    • SNOWBALL_BREAK

      public static final Effect SNOWBALL_BREAK
      Snowball breaking

    • WATERDRIP

      public static final Effect WATERDRIP
      The water drip particle that appears on blocks under water

    • LAVADRIP

      public static final Effect LAVADRIP
      The lava drip particle that appears on blocks under lava

    • SNOW_SHOVEL

      public static final Effect SNOW_SHOVEL
      White particles

    • SLIME

      public static final Effect SLIME
      The particle shown when a slime jumps

    • HEART

      public static final Effect HEART
      The particle that appears when breading animals

    • VILLAGER_THUNDERCLOUD

      public static final Effect VILLAGER_THUNDERCLOUD
      The particle that appears when hitting a villager

    • HAPPY_VILLAGER

      public static final Effect HAPPY_VILLAGER
      The particle that appears when trading with a villager

    • LARGE_SMOKE

      public static final Effect LARGE_SMOKE
      The smoke particles that appears on blazes, minecarts with furnaces and fire

    • ITEM_BREAK

      public static final Effect ITEM_BREAK
      The particles generated when a tool breaks. This particle requires a Material so that the client can select the correct texture.

    • TILE_BREAK

      public static final Effect TILE_BREAK
      The particles generated while breaking a block. This particle requires a Material and data value so that the client can select the correct texture.

    • TILE_DUST

      public static final Effect TILE_DUST
      The particles generated while sprinting a block This particle requires a Material and data value so that the client can select the correct texture.

  • Method Details

    • values

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

    • valueOf

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

    • getId

      @Deprecated public int getId()
      Deprecated.
      Magic value
      Gets the ID for this effect.
      Returns:
      if this Effect isn't of type PARTICLE it returns ID of this effect

    • getName

      public java.lang.String getName()
      Returns the effect's name. This returns null if the effect is not a particle
      Returns:
      The effect's name

    • getType

      public Effect.Type getType()
      Returns:
      The type of the effect.

    • getData

      public java.lang.Class<?> getData()
      Returns:
      if this Effect isn't of type PARTICLE it returns the class which represents data for this effect, or null if none

    • getById

      @Deprecated public static Effect getById​(int id)
      Deprecated.
      Magic value
      Gets the Effect associated with the given ID.
      Parameters:
      id - ID of the Effect to return
      Returns:
      Effect with the given ID

    • getByName

      public static Effect getByName​(java.lang.String name)
      Gets the Effect associated with the given name.
      Parameters:
      name - name of the Effect to return
      Returns:
      Effect with the given name