org.bukkit.Effect Maven / Gradle / Ivy

Go to download
package org.bukkit;

import com.google.common.collect.Maps;
import org.bukkit.block.BlockFace;
import org.bukkit.material.MaterialData;
import org.bukkit.potion.Potion;

import java.util.Map;

/**
 * A list of effects that the server is able to send to players.
 */
public enum Effect {
  /**
   * An alternate click sound.
   */
  CLICK2(1000, Type.SOUND),
  /**
   * A click sound.
   */
  CLICK1(1001, Type.SOUND),
  /**
   * Sound of a bow firing.
   */
  BOW_FIRE(1002, Type.SOUND),
  /**
   * Sound of a door opening/closing.
   */
  DOOR_TOGGLE(1003, Type.SOUND),
  /**
   * Sound of fire being extinguished.
   */
  EXTINGUISH(1004, Type.SOUND),
  /**
   * A song from a record. Needs the record item ID as additional info
   */
  RECORD_PLAY(1005, Type.SOUND, Material.class),
  /**
   * Sound of ghast shrieking.
   */
  GHAST_SHRIEK(1007, Type.SOUND),
  /**
   * Sound of ghast firing.
   */
  GHAST_SHOOT(1008, Type.SOUND),
  /**
   * Sound of blaze firing.
   */
  BLAZE_SHOOT(1009, Type.SOUND),
  /**
   * Sound of zombies chewing on wooden doors.
   */
  ZOMBIE_CHEW_WOODEN_DOOR(1010, Type.SOUND),
  /**
   * Sound of zombies chewing on iron doors.
   */
  ZOMBIE_CHEW_IRON_DOOR(1011, Type.SOUND),
  /**
   * Sound of zombies destroying a door.
   */
  ZOMBIE_DESTROY_DOOR(1012, Type.SOUND),
  /**
   * A visual smoke effect. Needs direction as additional info.
   */
  SMOKE(2000, Type.VISUAL, BlockFace.class),
  /**
   * Sound of a block breaking. Needs block ID as additional info.
   */
  STEP_SOUND(2001, Type.SOUND, Material.class),
  /**
   * Visual effect of a splash potion breaking. Needs potion data value as
   * additional info.
   */
  POTION_BREAK(2002, Type.VISUAL, Potion.class),
  /**
   * An ender eye signal; a visual effect.
   */
  ENDER_SIGNAL(2003, Type.VISUAL),
  /**
   * The flames seen on a mobspawner; a visual effect.
   */
  MOBSPAWNER_FLAMES(2004, Type.VISUAL),
  /**
   * The spark that comes off a fireworks
   */
  FIREWORKS_SPARK("fireworksSpark", Type.PARTICLE),
  /**
   * Critical hit particles
   */
  CRIT("crit", Type.PARTICLE),
  /**
   * Blue critical hit particles
   */
  MAGIC_CRIT("magicCrit", Type.PARTICLE),
  /**
   * Multicolored potion effect particles
   */
  POTION_SWIRL("mobSpell", Type.PARTICLE),
  /**
   * Multicolored potion effect particles that are slightly transparent
   */
  POTION_SWIRL_TRANSPARENT("mobSpellAmbient", Type.PARTICLE),
  /**
   * A puff of white potion swirls
   */
  SPELL("spell", Type.PARTICLE),
  /**
   * A puff of white stars
   */
  INSTANT_SPELL("instantSpell", Type.PARTICLE),
  /**
   * A puff of purple particles
   */
  WITCH_MAGIC("witchMagic", Type.PARTICLE),
  /**
   * The note that appears above note blocks
   */
  NOTE("note", Type.PARTICLE),
  /**
   * The particles shown at nether portals
   */
  PORTAL("portal", Type.PARTICLE),
  /**
   * The symbols that fly towards the enchantment table
   */
  FLYING_GLYPH("enchantmenttable", Type.PARTICLE),
  /**
   * Fire particles
   */
  FLAME("flame", Type.PARTICLE),
  /**
   * The particles that pop out of lava
   */
  LAVA_POP("lava", Type.PARTICLE),
  /**
   * A small gray square
   */
  FOOTSTEP("footstep", Type.PARTICLE),
  /**
   * Water particles
   */
  SPLASH("splash", Type.PARTICLE),
  /**
   * Smoke particles
   */
  PARTICLE_SMOKE("smoke", Type.PARTICLE),
  /**
   * The biggest explosion particle effect
   */
  EXPLOSION_HUGE("hugeexplosion", Type.PARTICLE),
  /**
   * A larger version of the explode particle
   */
  EXPLOSION_LARGE("largeexplode", Type.PARTICLE),
  /**
   * Explosion particles
   */
  EXPLOSION("explode", Type.PARTICLE),
  /**
   * Small gray particles
   */
  VOID_FOG("depthsuspend", Type.PARTICLE),
  /**
   * Small gray particles
   */
  SMALL_SMOKE("townaura", Type.PARTICLE),
  /**
   * A puff of white smoke
   */
  CLOUD("cloud", Type.PARTICLE),
  /**
   * Multicolored dust particles
   */
  COLOURED_DUST("reddust", Type.PARTICLE),
  /**
   * Snowball breaking
   */
  SNOWBALL_BREAK("snowballpoof", Type.PARTICLE),
  /**
   * The water drip particle that appears on blocks under water
   */
  WATERDRIP("dripWater", Type.PARTICLE),
  /**
   * The lava drip particle that appears on blocks under lava
   */
  LAVADRIP("dripLava", Type.PARTICLE),
  /**
   * White particles
   */
  SNOW_SHOVEL("snowshovel", Type.PARTICLE),
  /**
   * The particle shown when a slime jumps
   */
  SLIME("slime", Type.PARTICLE),
  /**
   * The particle that appears when breading animals
   */
  HEART("heart", Type.PARTICLE),
  /**
   * The particle that appears when hitting a villager
   */
  VILLAGER_THUNDERCLOUD("angryVillager", Type.PARTICLE),
  /**
   * The particle that appears when trading with a villager
   */
  HAPPY_VILLAGER("happyVillager", Type.PARTICLE),
  /**
   * The smoke particles that appears on blazes, minecarts
   * with furnaces and fire
   */
  LARGE_SMOKE("largesmoke", Type.PARTICLE),
  /**
   * The particles generated when a tool breaks.
   * This particle requires a Material so that the client can select the correct texture.
   */
  ITEM_BREAK("iconcrack", Type.PARTICLE, Material.class),
  /**
   * 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_BREAK("blockcrack", Type.PARTICLE, MaterialData.class),
  /**
   * The particles generated while sprinting a block
   * This particle requires a Material and data value so that the client can select the correct texture.
   */
  TILE_DUST("blockdust", Type.PARTICLE, MaterialData.class);

  private static final Map BY_ID = Maps.newHashMap();
  private static final Map BY_NAME = Maps.newHashMap();

  static {
    for (Effect effect : values()) {
      if (effect.type != Type.PARTICLE) {
        BY_ID.put(effect.id, effect);
      }
    }
  }

  static {
    for (Effect effect : values()) {
      if (effect.type == Type.PARTICLE) {
        BY_NAME.put(effect.particleName, effect);
      }
    }
  }

  private final int id;
  private final Type type;
  private final Class data;
  private final String particleName;

  Effect(int id, Type type) {
    this(id, type, null);
  }

  Effect(int id, Type type, Class data) {
    this.id = id;
    this.type = type;
    this.data = data;
    particleName = null;
  }

  Effect(String particleName, Type type, Class data) {
    this.particleName = particleName;
    this.type = type;
    id = 0;
    this.data = data;
  }

  Effect(String particleName, Type type) {
    this.particleName = particleName;
    this.type = type;
    id = 0;
    this.data = null;
  }

  /**
   * Gets the Effect associated with the given ID.
   *
   * @param id ID of the Effect to return
   * @return Effect with the given ID
   * @deprecated Magic value
   */
  @Deprecated
  public static Effect getById(int id) {
    return BY_ID.get(id);
  }

  /**
   * Gets the Effect associated with the given name.
   *
   * @param name name of the Effect to return
   * @return Effect with the given name
   */
  public static Effect getByName(String name) {
    return BY_NAME.get(name);
  }

  /**
   * Gets the ID for this effect.
   *
   * @return if this Effect isn't of type PARTICLE it returns ID of this effect
   * @deprecated Magic value
   */
  @Deprecated
  public int getId() {
    return this.id;
  }

  /**
   * Returns the effect's name. This returns null if the effect is not a particle
   *
   * @return The effect's name
   */
  public String getName() {
    return particleName;
  }

  /**
   * @return The type of the effect.
   */
  public Type getType() {
    return this.type;
  }

  /**
   * @return if this Effect isn't of type PARTICLE it returns the class which represents data for this effect, or null if none
   */
  public Class getData() {
    return this.data;
  }

  /**
   * Represents the type of an effect.
   */
  public enum Type {SOUND, VISUAL, PARTICLE}
}