Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.Effect Enum Reference


enum  Type

Public Member Functions

 Effect (int id, Type type)
 Effect (int id, Type type, Class<?> data)
int getId ()
Type getType ()
Class<?> getData ()

Static Public Member Functions

static Effect getById (int id)
 [static initializer]

Public Attributes

 CLICK2 =(1000, Type.SOUND)
 CLICK1 =(1001, Type.SOUND)
 BOW_FIRE =(1002, Type.SOUND)
 DOOR_TOGGLE =(1003, Type.SOUND)
 RECORD_PLAY =(1005, Type.SOUND, Material.class)
 GHAST_SHOOT =(1008, Type.SOUND)
 BLAZE_SHOOT =(1009, Type.SOUND)
 SMOKE =(2000, Type.VISUAL, BlockFace.class)
 STEP_SOUND =(2001, Type.SOUND, Material.class)
 POTION_BREAK =(2002, Type.VISUAL, Potion.class)

Detailed Description

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

Definition at line 13 of file Effect.java.

Member Function Documentation

static Effect org.bukkit.Effect.getById ( int  id)

Gets the Effect associated with the given ID.

idID of the Effect to return
Effect with the given ID
Magic value

Definition at line 133 of file Effect.java.

133  {
134  return BY_ID.get(id);
135  }
Class<?> org.bukkit.Effect.getData ( )
The class which represents data for this effect, or null if none

Definition at line 121 of file Effect.java.

121  {
122  return this.data;
123  }
int org.bukkit.Effect.getId ( )

Gets the ID for this effect.

ID of this effect
Magic value

Definition at line 106 of file Effect.java.

106  {
107  return this.id;
108  }
Type org.bukkit.Effect.getType ( )
The type of the effect.

Definition at line 113 of file Effect.java.

113  {
114  return this.type;
115  }

Member Data Documentation

org.bukkit.Effect.BLAZE_SHOOT =(1009, Type.SOUND)

Sound of blaze firing.

Definition at line 49 of file Effect.java.

org.bukkit.Effect.BOW_FIRE =(1002, Type.SOUND)

Sound of a bow firing.

Definition at line 25 of file Effect.java.

org.bukkit.Effect.CLICK1 =(1001, Type.SOUND)

A click sound.

Definition at line 21 of file Effect.java.

org.bukkit.Effect.CLICK2 =(1000, Type.SOUND)

An alternate click sound.

Definition at line 17 of file Effect.java.

org.bukkit.Effect.DOOR_TOGGLE =(1003, Type.SOUND)

Sound of a door opening/closing.

Definition at line 29 of file Effect.java.

org.bukkit.Effect.ENDER_SIGNAL =(2003, Type.VISUAL)

An ender eye signal; a visual effect.

Definition at line 78 of file Effect.java.

org.bukkit.Effect.EXTINGUISH =(1004, Type.SOUND)

Sound of fire being extinguished.

Definition at line 33 of file Effect.java.

org.bukkit.Effect.GHAST_SHOOT =(1008, Type.SOUND)

Sound of ghast firing.

Definition at line 45 of file Effect.java.

org.bukkit.Effect.GHAST_SHRIEK =(1007, Type.SOUND)

Sound of ghast shrieking.

Definition at line 41 of file Effect.java.

org.bukkit.Effect.MOBSPAWNER_FLAMES =(2004, Type.VISUAL)

The flames seen on a mobspawner; a visual effect.

Definition at line 82 of file Effect.java.

org.bukkit.Effect.POTION_BREAK =(2002, Type.VISUAL, Potion.class)

Visual effect of a splash potion breaking. Needs potion data value as additional info.

Definition at line 74 of file Effect.java.

org.bukkit.Effect.RECORD_PLAY =(1005, Type.SOUND, Material.class)

A song from a record. Needs the record item ID as additional info

Definition at line 37 of file Effect.java.

org.bukkit.Effect.SMOKE =(2000, Type.VISUAL, BlockFace.class)

A visual smoke effect. Needs direction as additional info.

Definition at line 65 of file Effect.java.

org.bukkit.Effect.STEP_SOUND =(2001, Type.SOUND, Material.class)

Sound of a block breaking. Needs block ID as additional info.

Definition at line 69 of file Effect.java.

org.bukkit.Effect.ZOMBIE_CHEW_IRON_DOOR =(1011, Type.SOUND)

Sound of zombies chewing on iron doors.

Definition at line 57 of file Effect.java.

org.bukkit.Effect.ZOMBIE_CHEW_WOODEN_DOOR =(1010, Type.SOUND)

Sound of zombies chewing on wooden doors.

Definition at line 53 of file Effect.java.

org.bukkit.Effect.ZOMBIE_DESTROY_DOOR =(1012, Type.SOUND)

Sound of zombies destroying a door.

Definition at line 61 of file Effect.java.

The documentation for this enum was generated from the following file: