diff options
Diffstat (limited to 'src/main/java/org/bukkit/entity')
25 files changed, 58 insertions, 45 deletions
diff --git a/src/main/java/org/bukkit/entity/Animals.java b/src/main/java/org/bukkit/entity/Animals.java index f23db9bc..960c441f 100644 --- a/src/main/java/org/bukkit/entity/Animals.java +++ b/src/main/java/org/bukkit/entity/Animals.java @@ -7,7 +7,7 @@ package org.bukkit.entity; public interface Animals extends Creature { /** * Gets the age of this animal. - * + * * @return Age */ public int getAge(); diff --git a/src/main/java/org/bukkit/entity/Blaze.java b/src/main/java/org/bukkit/entity/Blaze.java index 0033acd0..7a5505b7 100644 --- a/src/main/java/org/bukkit/entity/Blaze.java +++ b/src/main/java/org/bukkit/entity/Blaze.java @@ -4,5 +4,5 @@ package org.bukkit.entity; * Represents a Blaze monster */ public interface Blaze extends Monster { - + } diff --git a/src/main/java/org/bukkit/entity/Boat.java b/src/main/java/org/bukkit/entity/Boat.java index bbd772fe..c4f98400 100644 --- a/src/main/java/org/bukkit/entity/Boat.java +++ b/src/main/java/org/bukkit/entity/Boat.java @@ -18,11 +18,11 @@ public interface Boat extends Vehicle { * @param speed The max speed. */ public void setMaxSpeed(double speed); - + /** * Gets the deceleration rate (newSpeed = curSpeed * rate) of occupied * boats. The default is 0.2. - * + * * @return */ public double getOccupiedDeceleration(); @@ -31,7 +31,7 @@ public interface Boat extends Vehicle { * Sets the deceleration rate (newSpeed = curSpeed * rate) of occupied * boats. Setting this to a higher value allows for quicker acceleration. * The default is 0.2. - * + * * @param speed deceleration rate */ public void setOccupiedDeceleration(double rate); @@ -40,7 +40,7 @@ public interface Boat extends Vehicle { * Gets the deceleration rate (newSpeed = curSpeed * rate) of unoccupied * boats. The default is -1. Values below 0 indicate that no additional * deceleration is imposed. - * + * * @return */ public double getUnoccupiedDeceleration(); @@ -50,21 +50,21 @@ public interface Boat extends Vehicle { * boats. Setting this to a higher value allows for quicker deceleration * of boats when a player disembarks. The default is -1. Values below 0 * indicate that no additional deceleration is imposed. - * + * * @param rate deceleration rate */ public void setUnoccupiedDeceleration(double rate); /** * Get whether boats can work on land. - * + * * @return whether boats can work on land */ public boolean getWorkOnLand(); /** * Set whether boats can work on land. - * + * * @param workOnLand whether boats can work on land */ public void setWorkOnLand(boolean workOnLand); diff --git a/src/main/java/org/bukkit/entity/ComplexEntityPart.java b/src/main/java/org/bukkit/entity/ComplexEntityPart.java index ced09c4b..5db43e0a 100644 --- a/src/main/java/org/bukkit/entity/ComplexEntityPart.java +++ b/src/main/java/org/bukkit/entity/ComplexEntityPart.java @@ -6,7 +6,7 @@ package org.bukkit.entity; public interface ComplexEntityPart extends Entity { /** * Gets the parent {@link ComplexLivingEntity} of this part. - * + * * @return Parent complex entity */ public ComplexLivingEntity getParent(); diff --git a/src/main/java/org/bukkit/entity/ComplexLivingEntity.java b/src/main/java/org/bukkit/entity/ComplexLivingEntity.java index 6de2c561..2670d17b 100644 --- a/src/main/java/org/bukkit/entity/ComplexLivingEntity.java +++ b/src/main/java/org/bukkit/entity/ComplexLivingEntity.java @@ -8,7 +8,7 @@ import java.util.Set; public interface ComplexLivingEntity extends LivingEntity { /** * Gets a list of parts that belong to this complex entity - * + * * @return List of parts */ public Set<ComplexEntityPart> getParts(); diff --git a/src/main/java/org/bukkit/entity/CreatureType.java b/src/main/java/org/bukkit/entity/CreatureType.java index 40c037da..2f1ab5a5 100644 --- a/src/main/java/org/bukkit/entity/CreatureType.java +++ b/src/main/java/org/bukkit/entity/CreatureType.java @@ -50,7 +50,7 @@ public enum CreatureType { public String getName() { return name; } - + public Class<? extends Entity> getEntityClass() { return clazz; } diff --git a/src/main/java/org/bukkit/entity/EnderDragon.java b/src/main/java/org/bukkit/entity/EnderDragon.java index 18e8bca6..609f3ba5 100644 --- a/src/main/java/org/bukkit/entity/EnderDragon.java +++ b/src/main/java/org/bukkit/entity/EnderDragon.java @@ -4,5 +4,5 @@ package org.bukkit.entity; * Represents an Ender Dragon */ public interface EnderDragon extends ComplexLivingEntity { - + } diff --git a/src/main/java/org/bukkit/entity/EnderPearl.java b/src/main/java/org/bukkit/entity/EnderPearl.java index 77c81ec1..51e4f907 100644 --- a/src/main/java/org/bukkit/entity/EnderPearl.java +++ b/src/main/java/org/bukkit/entity/EnderPearl.java @@ -4,5 +4,5 @@ package org.bukkit.entity; * Represents an Ender Pearl entity */ public interface EnderPearl extends Projectile { - + } diff --git a/src/main/java/org/bukkit/entity/EnderSignal.java b/src/main/java/org/bukkit/entity/EnderSignal.java index 94a2f947..49a21ad3 100644 --- a/src/main/java/org/bukkit/entity/EnderSignal.java +++ b/src/main/java/org/bukkit/entity/EnderSignal.java @@ -4,5 +4,5 @@ package org.bukkit.entity; * Represents an Ender Signal, which is often created upon throwing an ender eye */ public interface EnderSignal extends Entity { - + } diff --git a/src/main/java/org/bukkit/entity/Entity.java b/src/main/java/org/bukkit/entity/Entity.java index eca0a8a2..b47a7ddb 100644 --- a/src/main/java/org/bukkit/entity/Entity.java +++ b/src/main/java/org/bukkit/entity/Entity.java @@ -122,6 +122,7 @@ public interface Entity { /** * Returns true if this entity has been marked for removal. + * * @return True if it is dead. */ public boolean isDead(); @@ -165,49 +166,53 @@ public interface Entity { /** * Returns the distance this entity has fallen + * * @return The distance. */ public float getFallDistance(); /** * Sets the fall distance for this entity + * * @param distance The new distance. */ public void setFallDistance(float distance); /** * Record the last {@link EntityDamageEvent} inflicted on this entity + * * @param event a {@link EntityDamageEvent} */ public void setLastDamageCause(EntityDamageEvent event); /** * Retrieve the last {@link EntityDamageEvent} inflicted on this entity. This event may have been cancelled. + * * @return the last known {@link EntityDamageEvent} or null if hitherto unharmed */ public EntityDamageEvent getLastDamageCause(); /** * Returns a unique and persistent id for this entity + * * @return unique id */ public UUID getUniqueId(); - + /** * Gets the amount of ticks this entity has lived for. * <p> * This is the equivalent to "age" in entities. - * + * * @return Age of entity */ public int getTicksLived(); - + /** * Sets the amount of ticks this entity has lived for. * <p> - * This is the equivalent to "age" in entities. May not be - * less than one tick. - * + * This is the equivalent to "age" in entities. May not be less than one tick. + * * @param value Age of entity */ public void setTicksLived(int value); diff --git a/src/main/java/org/bukkit/entity/ExperienceOrb.java b/src/main/java/org/bukkit/entity/ExperienceOrb.java index 4093e998..40783b89 100644 --- a/src/main/java/org/bukkit/entity/ExperienceOrb.java +++ b/src/main/java/org/bukkit/entity/ExperienceOrb.java @@ -10,10 +10,10 @@ public interface ExperienceOrb extends Entity { * @return Amount of experience */ public int getExperience(); - + /** * Sets how much experience is contained within this orb - * + * * @param value Amount of experience */ public void setExperience(int value); diff --git a/src/main/java/org/bukkit/entity/Explosive.java b/src/main/java/org/bukkit/entity/Explosive.java index 0a737855..bc68190c 100644 --- a/src/main/java/org/bukkit/entity/Explosive.java +++ b/src/main/java/org/bukkit/entity/Explosive.java @@ -6,24 +6,28 @@ package org.bukkit.entity; public interface Explosive extends Entity { /** * Set the radius affected by this explosive's explosion + * * @param yield The explosive yield */ public void setYield(float yield); /** * Return the radius or yield of this explosive's explosion + * * @return the radius of blocks affected */ public float getYield(); /** * Set whether or not this explosive's explosion causes fire + * * @param isIncendiary Whether it should cause fire */ public void setIsIncendiary(boolean isIncendiary); /** * Return whether or not this explosive creates a fire when exploding + * * @return true if the explosive creates fire, false otherwise */ public boolean isIncendiary(); diff --git a/src/main/java/org/bukkit/entity/HumanEntity.java b/src/main/java/org/bukkit/entity/HumanEntity.java index 09bcf8ff..654a7475 100644 --- a/src/main/java/org/bukkit/entity/HumanEntity.java +++ b/src/main/java/org/bukkit/entity/HumanEntity.java @@ -40,14 +40,6 @@ public interface HumanEntity extends LivingEntity, AnimalTamer, Permissible { public void setItemInHand(ItemStack item); /** - * Changes the item in hand to another of your 'action slots'. - * - * @param index The new index to use, only valid ones are 0-8. - * - public void selectItemInHand(int index); - */ - - /** * Returns whether this player is slumbering. * * @return slumber state diff --git a/src/main/java/org/bukkit/entity/LivingEntity.java b/src/main/java/org/bukkit/entity/LivingEntity.java index 94504bcf..c57b84d1 100644 --- a/src/main/java/org/bukkit/entity/LivingEntity.java +++ b/src/main/java/org/bukkit/entity/LivingEntity.java @@ -25,10 +25,10 @@ public interface LivingEntity extends Entity { * @throws IllegalArgumentException Thrown if the health is < 0 or > max */ public void setHealth(int health); - + /** * Gets the maximum health this entity may have - * + * * @return Maximum health */ public int getMaxHealth(); @@ -86,12 +86,14 @@ public interface LivingEntity extends Entity { /** * Throws an egg from the entity. + * * @return The egg thrown. */ public Egg throwEgg(); /** * Throws a snowball from the entity. + * * @return The snowball thrown. */ public Snowball throwSnowball(); diff --git a/src/main/java/org/bukkit/entity/Minecart.java b/src/main/java/org/bukkit/entity/Minecart.java index 4a748a92..554c3fdb 100644 --- a/src/main/java/org/bukkit/entity/Minecart.java +++ b/src/main/java/org/bukkit/entity/Minecart.java @@ -23,7 +23,7 @@ public interface Minecart extends Vehicle { /** * Gets the maximum speed of a minecart. The speed is unrelated to the velocity. - * + * * @return The max speed */ public double getMaxSpeed(); @@ -69,6 +69,7 @@ public interface Minecart extends Vehicle { * Gets the derailed velocity modifier. Used for minecarts that are on the ground, but not on rails. * * A derailed minecart's velocity is multiplied by this factor each tick. + * * @return derailed visible speed */ public Vector getDerailedVelocityMod(); diff --git a/src/main/java/org/bukkit/entity/MushroomCow.java b/src/main/java/org/bukkit/entity/MushroomCow.java index 56439497..84154de1 100644 --- a/src/main/java/org/bukkit/entity/MushroomCow.java +++ b/src/main/java/org/bukkit/entity/MushroomCow.java @@ -4,5 +4,5 @@ package org.bukkit.entity; * Represents a mushroom {@link Cow} */ public interface MushroomCow extends Cow { - + } diff --git a/src/main/java/org/bukkit/entity/NPC.java b/src/main/java/org/bukkit/entity/NPC.java index 2c651a5b..0c6b175b 100644 --- a/src/main/java/org/bukkit/entity/NPC.java +++ b/src/main/java/org/bukkit/entity/NPC.java @@ -4,5 +4,5 @@ package org.bukkit.entity; * Represents a non-player character */ public interface NPC extends Creature { - + } diff --git a/src/main/java/org/bukkit/entity/Painting.java b/src/main/java/org/bukkit/entity/Painting.java index 94e0e36e..a6473ea6 100644 --- a/src/main/java/org/bukkit/entity/Painting.java +++ b/src/main/java/org/bukkit/entity/Painting.java @@ -10,12 +10,14 @@ import org.bukkit.material.Attachable; public interface Painting extends Entity, Attachable { /** * Get the art on this painting + * * @return The art */ public Art getArt(); /** * Set the art on this painting + * * @param art The new art * @return False if the new art won't fit at the painting's current location */ @@ -23,10 +25,11 @@ public interface Painting extends Entity, Attachable { /** * Set the art on this painting + * * @param art The new art * @param force If true, force the new art regardless of whether it fits at the current location - * Note that forcing it where it can't fit normally causes it to drop as an item unless you override - * this by catching the PAINTING_BREAK event. + * Note that forcing it where it can't fit normally causes it to drop as an item unless you override + * this by catching the PAINTING_BREAK event. * @return False if force was false and the new art won't fit at the painting's current location */ public boolean setArt(Art art, boolean force); @@ -34,6 +37,7 @@ public interface Painting extends Entity, Attachable { /** * Sets the direction of the painting, potentially overriding rules of placement. Note that if the result * is not valid the painting would normally drop as an item. + * * @param face The new direction. * @param force Whether to force it. * @return False if force was false and there was no block for it to attach to in order to face the given direction. diff --git a/src/main/java/org/bukkit/entity/Pig.java b/src/main/java/org/bukkit/entity/Pig.java index fe1b0f4c..28f59f2c 100644 --- a/src/main/java/org/bukkit/entity/Pig.java +++ b/src/main/java/org/bukkit/entity/Pig.java @@ -6,7 +6,7 @@ package org.bukkit.entity; public interface Pig extends Animals, Vehicle { /** - * Check if the pig has a saddle. + * Check if the pig has a saddle. * * @return if the pig has been saddled. */ diff --git a/src/main/java/org/bukkit/entity/Player.java b/src/main/java/org/bukkit/entity/Player.java index 71a6e980..8fbb9509 100644 --- a/src/main/java/org/bukkit/entity/Player.java +++ b/src/main/java/org/bukkit/entity/Player.java @@ -37,7 +37,7 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer { * @param name The new display name. */ public void setDisplayName(String name); - + /** * Gets the name that is shown on the player list. * @@ -82,6 +82,7 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer { /** * Gets the socket address of this player + * * @return the player's address */ public InetSocketAddress getAddress(); @@ -117,12 +118,14 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer { /** * Returns if the player is in sneak mode + * * @return true if player is in sneak mode */ public boolean isSneaking(); /** * Sets the sneak mode the player + * * @param sneak true if player should appear sneaking */ public void setSneaking(boolean sneak); @@ -214,7 +217,7 @@ public interface Player extends HumanEntity, CommandSender, OfflinePlayer { /** * Send a chunk change. This fakes a chunk change packet for a user at * a certain location. The updated cuboid must be entirely within a single - * chunk. This will not actually change the world in any way. + * chunk. This will not actually change the world in any way. * * At least one of the dimensions of the cuboid must be even. The size of the * data buffer must be 2.5*sx*sy*sz and formatted in accordance with the Packet51 diff --git a/src/main/java/org/bukkit/entity/SmallFireball.java b/src/main/java/org/bukkit/entity/SmallFireball.java index 870b8a26..33f54d3e 100644 --- a/src/main/java/org/bukkit/entity/SmallFireball.java +++ b/src/main/java/org/bukkit/entity/SmallFireball.java @@ -4,5 +4,5 @@ package org.bukkit.entity; * Represents a small {@link Fireball} */ public interface SmallFireball extends Fireball { - + } diff --git a/src/main/java/org/bukkit/entity/Snowman.java b/src/main/java/org/bukkit/entity/Snowman.java index 84c31e9e..49005ed2 100644 --- a/src/main/java/org/bukkit/entity/Snowman.java +++ b/src/main/java/org/bukkit/entity/Snowman.java @@ -4,5 +4,5 @@ package org.bukkit.entity; * Represents a snowman entity */ public interface Snowman extends Creature { - + } diff --git a/src/main/java/org/bukkit/entity/TNTPrimed.java b/src/main/java/org/bukkit/entity/TNTPrimed.java index e463e453..bf4ea515 100644 --- a/src/main/java/org/bukkit/entity/TNTPrimed.java +++ b/src/main/java/org/bukkit/entity/TNTPrimed.java @@ -6,12 +6,14 @@ package org.bukkit.entity; public interface TNTPrimed extends Explosive { /** * Set the number of ticks until the TNT blows up after being primed. + * * @param fuseTicks The fuse ticks */ public void setFuseTicks(int fuseTicks); /** * Retrieve the number of ticks until the explosion of this TNTPrimed entity + * * @return the number of ticks until this TNTPrimed explodes */ public int getFuseTicks(); diff --git a/src/main/java/org/bukkit/entity/ThrownPotion.java b/src/main/java/org/bukkit/entity/ThrownPotion.java index 1daffced..789ade54 100644 --- a/src/main/java/org/bukkit/entity/ThrownPotion.java +++ b/src/main/java/org/bukkit/entity/ThrownPotion.java @@ -4,5 +4,5 @@ package org.bukkit.entity; * Represents a thrown potion bottle */ public interface ThrownPotion extends Projectile { - + } diff --git a/src/main/java/org/bukkit/entity/Villager.java b/src/main/java/org/bukkit/entity/Villager.java index 6d8dc763..1fa8392f 100644 --- a/src/main/java/org/bukkit/entity/Villager.java +++ b/src/main/java/org/bukkit/entity/Villager.java @@ -4,5 +4,5 @@ package org.bukkit.entity; * Represents a villager NPC */ public interface Villager extends NPC { - + } |