org.bukkit
Enum Effect

java.lang.Object
  java.lang.Enum<Effect>
      org.bukkit.Effect

All Implemented Interfaces:

Serializable, Comparable<Effect>

public enum Effect
extends Enum<Effect>

A list of effects that the server is able to send to players.

Nested Class Summary

static class

Effect.Type Represents the type of an effect.

Enum Constant Summary

BLAZE_SHOOT
Sound of blaze firing.

BOW_FIRE
Sound of a bow firing.

CLICK1
A click sound.

CLICK2
An alternate click sound.

DOOR_TOGGLE
Sound of a door opening/closing.

ENDER_SIGNAL
An ender eye signal; a visual effect.

EXTINGUISH
Sound of fire being extinguished.

GHAST_SHOOT
Sound of ghast firing.

GHAST_SHRIEK
Sound of ghast shrieking.

MOBSPAWNER_FLAMES
The flames seen on a mobspawner; a visual effect.

POTION_BREAK
Visual effect of a splash potion breaking.

RECORD_PLAY
A song from a record.

SMOKE
A visual smoke effect.

STEP_SOUND
Sound of a block breaking.

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

static Effect	getById(int id) Gets the Effect associated with the given ID.
Class<?>	getData()
int	getId() Gets the ID for this effect.
Effect.Type	getType()
static Effect	valueOf(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're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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.

Method Detail

values

public static final Effect[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(Effect c : Effect.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static Effect valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

getId

public int getId()

Gets the ID for this effect.

Returns:

ID of this effect

getType

public Effect.Type getType()

Returns:

The type of the effect.

getData

public Class<?> getData()

Returns:

The class which represents data for this effect, or null if none

getById

public static Effect getById(int id)

Gets the Effect associated with the given ID.

Parameters:

id - ID of the Effect to return

Returns:

Effect with the given ID