Implementation of richer playEffect methods. Addresses BUKKIT-857

By: Celtic Minstrel <celtic.minstrel.ca@some.place>
This commit is contained in:
Bukkit/Spigot
2012-02-26 12:53:31 -05:00
parent 27fb3d2fea
commit da943825be
5 changed files with 87 additions and 18 deletions

View File

@@ -4,30 +4,41 @@ import java.util.Map;
import com.google.common.collect.Maps;
import org.bukkit.block.BlockFace;
import org.bukkit.potion.Potion;
/**
* A list of effects that the server is able to send to players.
*/
public enum Effect {
CLICK2(1000),
CLICK1(1001),
BOW_FIRE(1002),
DOOR_TOGGLE(1003),
EXTINGUISH(1004),
RECORD_PLAY(1005),
GHAST_SHRIEK(1007),
GHAST_SHOOT(1008),
BLAZE_SHOOT(1009),
SMOKE(2000),
STEP_SOUND(2001),
POTION_BREAK(2002),
ENDER_SIGNAL(2003),
MOBSPAWNER_FLAMES(2004);
CLICK2(1000, Type.SOUND),
CLICK1(1001, Type.SOUND),
BOW_FIRE(1002, Type.SOUND),
DOOR_TOGGLE(1003, Type.SOUND),
EXTINGUISH(1004, Type.SOUND),
RECORD_PLAY(1005, Type.SOUND, Material.class),
GHAST_SHRIEK(1007, Type.SOUND),
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),
ENDER_SIGNAL(2003, Type.VISUAL),
MOBSPAWNER_FLAMES(2004, Type.VISUAL);
private final int id;
private final Type type;
private final Class<?> data;
private static final Map<Integer, Effect> BY_ID = Maps.newHashMap();
Effect(int id) {
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;
}
/**
@@ -39,6 +50,20 @@ public enum Effect {
return this.id;
}
/**
* @return The type of the effect.
*/
public Type getType() {
return this.type;
}
/**
* @return The class which represents data for this effect, or null if none
*/
public Class<?> getData() {
return this.data;
}
/**
* Gets the Effect associated with the given ID.
*
@@ -54,4 +79,9 @@ public enum Effect {
BY_ID.put(effect.id, effect);
}
}
/**
* Represents the type of an effect.
*/
public enum Type {SOUND, VISUAL}
}