Deprecate magic values

By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
Bukkit/Spigot
2013-08-19 13:32:18 -05:00
parent d9f3848e22
commit f9bec6eadd
108 changed files with 1194 additions and 11 deletions

View File

@@ -66,6 +66,11 @@ public enum CreatureType {
return clazz;
}
/**
*
* @deprecated Magic value
*/
@Deprecated
public short getTypeId() {
return typeId;
}
@@ -74,6 +79,11 @@ public enum CreatureType {
return NAME_MAP.get(name);
}
/**
*
* @deprecated Magic value
*/
@Deprecated
public static CreatureType fromId(int id) {
if (id > Short.MAX_VALUE) {
return null;

View File

@@ -197,6 +197,11 @@ public enum EntityType {
}
}
/**
*
* @deprecated Magic value
*/
@Deprecated
public String getName() {
return name;
}
@@ -205,10 +210,20 @@ public enum EntityType {
return clazz;
}
/**
*
* @deprecated Magic value
*/
@Deprecated
public short getTypeId() {
return typeId;
}
/**
*
* @deprecated Magic value
*/
@Deprecated
public static EntityType fromName(String name) {
if (name == null) {
return null;
@@ -216,6 +231,11 @@ public enum EntityType {
return NAME_MAP.get(name.toLowerCase());
}
/**
*
* @deprecated Magic value
*/
@Deprecated
public static EntityType fromId(int id) {
if (id > Short.MAX_VALUE) {
return null;

View File

@@ -6,6 +6,7 @@ import org.bukkit.Material;
* Represents a falling block
*/
public interface FallingBlock extends Entity {
/**
* Get the Material of the falling block
*
@@ -17,14 +18,18 @@ public interface FallingBlock extends Entity {
* Get the ID of the falling block
*
* @return ID type of the block
* @deprecated Magic value
*/
@Deprecated
int getBlockId();
/**
* Get the data for the falling block
*
* @return data of the block
* @deprecated Magic value
*/
@Deprecated
byte getBlockData();
/**

View File

@@ -51,7 +51,9 @@ public interface LivingEntity extends Entity, Damageable {
* limited by server by at least 100 blocks, no less)
* @return list containing all blocks along the living entity's line
* of sight
* @deprecated Magic value
*/
@Deprecated
public List<Block> getLineOfSight(HashSet<Byte> transparent, int maxDistance);
/**
@@ -62,7 +64,9 @@ public interface LivingEntity extends Entity, Damageable {
* @param maxDistance this is the maximum distance to scan
* (may be limited by server by at least 100 blocks, no less)
* @return block that the living entity has targeted
* @deprecated Magic value
*/
@Deprecated
public Block getTargetBlock(HashSet<Byte> transparent, int maxDistance);
/**
@@ -76,7 +80,9 @@ public interface LivingEntity extends Entity, Damageable {
* further limited by the server, but never to less than 100 blocks
* @return list containing the last 2 blocks along the living entity's
* line of sight
* @deprecated Magic value
*/
@Deprecated
public List<Block> getLastTwoTargetBlocks(HashSet<Byte> transparent, int maxDistance);
/**

View File

@@ -60,7 +60,9 @@ public interface Ocelot extends Animals, Tameable {
* Gets the ID of this cat type.
*
* @return Type ID.
* @deprecated Magic value
*/
@Deprecated
public int getId() {
return id;
}
@@ -70,7 +72,9 @@ public interface Ocelot extends Animals, Tameable {
*
* @param id ID of the cat type to get.
* @return Resulting type, or null if not found.
* @deprecated Magic value
*/
@Deprecated
public static Type getType(int id) {
return (id >= types.length) ? null : types[id];
}

View File

@@ -187,7 +187,9 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
* @param loc The location of a note block.
* @param instrument The instrument ID.
* @param note The note ID.
* @deprecated Magic value
*/
@Deprecated
public void playNote(Location loc, byte instrument, byte note);
/**
@@ -225,7 +227,9 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
* @param sound the internal sound name to play
* @param volume the volume of the sound
* @param pitch the pitch of the sound
* @deprecated Magic value
*/
@Deprecated
public void playSound(Location location, String sound, float volume, float pitch);
/**
@@ -234,7 +238,9 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
* @param loc the location to play the effect at
* @param effect the {@link Effect}
* @param data a data bit needed for some effects
* @deprecated Magic value
*/
@Deprecated
public void playEffect(Location loc, Effect effect, int data);
/**
@@ -253,7 +259,9 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
* @param loc The location of the changed block
* @param material The new block
* @param data The block data
* @deprecated Magic value
*/
@Deprecated
public void sendBlockChange(Location loc, Material material, byte data);
/**
@@ -271,7 +279,9 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
* @param sz The z size of the cuboid
* @param data The data to be sent
* @return true if the chunk change packet was sent
* @deprecated Magic value
*/
@Deprecated
public boolean sendChunkChange(Location loc, int sx, int sy, int sz, byte[] data);
/**
@@ -281,7 +291,9 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
* @param loc The location of the changed block
* @param material The new block ID
* @param data The block data
* @deprecated Magic value
*/
@Deprecated
public void sendBlockChange(Location loc, int material, byte data);
/**

View File

@@ -42,7 +42,9 @@ public interface Skeleton extends Monster {
* Gets the ID of this skeleton type.
*
* @return Skeleton type ID
* @deprecated Magic value
*/
@Deprecated
public int getId() {
return id;
}
@@ -52,7 +54,9 @@ public interface Skeleton extends Monster {
*
* @param id ID of the skeleton type to get.
* @return Resulting skeleton type, or null if not found.
* @deprecated Magic value
*/
@Deprecated
public static SkeletonType getType(int id) {
return (id >= types.length) ? null : types[id];
}

View File

@@ -4,16 +4,17 @@ package org.bukkit.entity;
* Represents a villager NPC
*/
public interface Villager extends Ageable, NPC {
/**
* Gets the current profession of this villager.
*
* @return Current profession.
*/
public Profession getProfession();
/**
* Sets the new profession of this villager.
*
*
* @param profession New profession.
*/
public void setProfession(Profession profession);
@@ -46,7 +47,9 @@ public interface Villager extends Ageable, NPC {
* Gets the ID of this profession.
*
* @return Profession ID.
* @deprecated Magic value
*/
@Deprecated
public int getId() {
return id;
}
@@ -56,7 +59,9 @@ public interface Villager extends Ageable, NPC {
*
* @param id ID of the profession to get.
* @return Resulting profession, or null if not found.
* @deprecated Magic value
*/
@Deprecated
public static Profession getProfession(int id) {
return (id >= professions.length) ? null : professions[id];
}