diff --git a/build.gradle b/build.gradle index 92649b391..3197732c5 100644 --- a/build.gradle +++ b/build.gradle @@ -122,6 +122,12 @@ configure([compileJava, compileTestJava]) { javadoc { options.jFlags('-Xms256m', '-Xmx512m') + options.links("http://docs.guava-libraries.googlecode.com/git-history/v17.0/javadoc/", + "http://google.github.io/guice/api-docs/latest/javadoc/", + "http://flowpowered.com/math/", + "http://asm.ow2.org/asm50/javadoc/user/", + "http://www.slf4j.org/apidocs/", + "http://docs.oracle.com/javase/6/docs/api/") } if (JavaVersion.current().isJava8Compatible()) { diff --git a/src/main/java/org/spongepowered/api/attribute/Attribute.java b/src/main/java/org/spongepowered/api/attribute/Attribute.java index d7000e0b6..a2057688d 100644 --- a/src/main/java/org/spongepowered/api/attribute/Attribute.java +++ b/src/main/java/org/spongepowered/api/attribute/Attribute.java @@ -28,8 +28,8 @@ package org.spongepowered.api.attribute; import com.google.common.base.Predicate; /** - * Represents an type of attribute that can be applied to a - * {@link AttributeHolder}. + * Represents a type of attribute that can be applied to an {@link + * AttributeHolder}. */ public interface Attribute { diff --git a/src/main/java/org/spongepowered/api/attribute/AttributeCalculator.java b/src/main/java/org/spongepowered/api/attribute/AttributeCalculator.java index dafd187bf..d1c882b30 100644 --- a/src/main/java/org/spongepowered/api/attribute/AttributeCalculator.java +++ b/src/main/java/org/spongepowered/api/attribute/AttributeCalculator.java @@ -35,7 +35,7 @@ public interface AttributeCalculator { * Calculates the value of an attribute given a base value and a set of * {@link Operation}s and modification values. The order of operation * evaluation will be decided according to a list sorted by each operations - * {@link Operation#compareTo(Operation)} method. Their + * {@link Operation#compareTo} method. Their * {@link Operation#changeValueImmediately()} will determine whether after * being evaluated, an operation's incrementation will be added to the value * immediately, or be summed with all other incrementations from the same diff --git a/src/main/java/org/spongepowered/api/effect/particle/ParticleEffect.java b/src/main/java/org/spongepowered/api/effect/particle/ParticleEffect.java index 876b84628..951117e16 100644 --- a/src/main/java/org/spongepowered/api/effect/particle/ParticleEffect.java +++ b/src/main/java/org/spongepowered/api/effect/particle/ParticleEffect.java @@ -24,7 +24,7 @@ */ package org.spongepowered.api.effect.particle; -import com.flowpowered.math.vector.Vector3f; +import com.flowpowered.math.vector.Vector3d; import org.spongepowered.api.item.inventory.ItemStack; import java.awt.Color; @@ -46,14 +46,14 @@ public interface ParticleEffect { * * @return The motion vector */ - Vector3f getMotion(); + Vector3d getMotion(); /** * Gets the offset vector of the particle effect. * * @return The offset vector */ - Vector3f getOffset(); + Vector3d getOffset(); /** * Gets the amount of particles that will be spawned. diff --git a/src/main/java/org/spongepowered/api/effect/particle/ParticleEffectBuilder.java b/src/main/java/org/spongepowered/api/effect/particle/ParticleEffectBuilder.java index ef119a5fc..2139e3d63 100644 --- a/src/main/java/org/spongepowered/api/effect/particle/ParticleEffectBuilder.java +++ b/src/main/java/org/spongepowered/api/effect/particle/ParticleEffectBuilder.java @@ -24,7 +24,7 @@ */ package org.spongepowered.api.effect.particle; -import com.flowpowered.math.vector.Vector3f; +import com.flowpowered.math.vector.Vector3d; import org.spongepowered.api.item.ItemType; import org.spongepowered.api.item.inventory.ItemStack; @@ -38,22 +38,22 @@ public interface ParticleEffectBuilder { /** * Sets the motion vector of the particle effect. * - *

The default motion vector is {@link Vector3f#ZERO}.

+ *

The default motion vector is {@link Vector3d#ZERO}.

* * @param motion The motion vector * @return This builder */ - ParticleEffectBuilder motion(Vector3f motion); + ParticleEffectBuilder motion(Vector3d motion); /** * Sets the offset vector of the particle effect. * - *

The default offset vector is {@link Vector3f#ZERO}.

+ *

The default offset vector is {@link Vector3d#ZERO}.

* * @param offset The offset vector * @return This builder */ - ParticleEffectBuilder offset(Vector3f offset); + ParticleEffectBuilder offset(Vector3d offset); /** * Sets the amount of particles of the particle effect. @@ -90,10 +90,10 @@ public interface ParticleEffectBuilder { Colorable color(Color color); @Override - Colorable motion(Vector3f motion); + Colorable motion(Vector3d motion); @Override - Colorable offset(Vector3f offset); + Colorable offset(Vector3d offset); @Override Colorable count(int count); @@ -120,10 +120,10 @@ public interface ParticleEffectBuilder { Resizable size(float size); @Override - Resizable motion(Vector3f motion); + Resizable motion(Vector3d motion); @Override - Resizable offset(Vector3f offset); + Resizable offset(Vector3d offset); @Override Resizable count(int count); @@ -151,10 +151,10 @@ public interface ParticleEffectBuilder { Note note(float note); @Override - Note motion(Vector3f motion); + Note motion(Vector3d motion); @Override - Note offset(Vector3f offset); + Note offset(Vector3d offset); @Override Note count(int count); @@ -189,10 +189,10 @@ public interface ParticleEffectBuilder { Material itemType(ItemType item); @Override - Material motion(Vector3f motion); + Material motion(Vector3d motion); @Override - Material offset(Vector3f offset); + Material offset(Vector3d offset); @Override Material count(int count); diff --git a/src/main/java/org/spongepowered/api/effect/sound/SoundTypes.java b/src/main/java/org/spongepowered/api/effect/sound/SoundTypes.java index 7cc2f0a1f..2685f4031 100644 --- a/src/main/java/org/spongepowered/api/effect/sound/SoundTypes.java +++ b/src/main/java/org/spongepowered/api/effect/sound/SoundTypes.java @@ -24,6 +24,9 @@ */ package org.spongepowered.api.effect.sound; +/** + * An enumeration of vanilla {@link SoundType}s. + */ public final class SoundTypes { public static final SoundType AMBIENCE_CAVE = null; diff --git a/src/main/java/org/spongepowered/api/entity/Entity.java b/src/main/java/org/spongepowered/api/entity/Entity.java index fc2dd1ede..b385dfe27 100644 --- a/src/main/java/org/spongepowered/api/entity/Entity.java +++ b/src/main/java/org/spongepowered/api/entity/Entity.java @@ -26,7 +26,6 @@ package org.spongepowered.api.entity; import com.flowpowered.math.vector.Vector3d; -import com.flowpowered.math.vector.Vector3f; import com.google.common.base.Optional; import org.spongepowered.api.service.persistence.data.DataHolder; import org.spongepowered.api.util.Identifiable; @@ -79,30 +78,59 @@ public interface Entity extends Identifiable, EntityState, DataHolder { */ boolean setLocation(Location location); + /** + * Moves the entity to the specified location, and sets the rotation. + * + *

The format of the rotation is represented by:

+ * + * + * + * @param location The location to set + * @param rotation The rotation to set + * @return True if the teleport was successful + */ + boolean setLocationAndRotation(Location location, Vector3d rotation); + /** * Moves the entity to the specified location, and sets the rotation. {@link RelativePositions} * listed inside the EnumSet are considered relative. * + *

The format of the rotation is represented by:

+ * + * + * * @param location The location to set * @param rotation The rotation to set * @param relativePositions The coordinates to set relatively * @return True if the teleport was successful */ - boolean setLocationAndRotation(Location location, Vector3f rotation, EnumSet relativePositions); + boolean setLocationAndRotation(Location location, Vector3d rotation, EnumSet relativePositions); /** * Gets the rotation as a Vector3f. * + *

The format of the rotation is represented by:

+ * + * + * * @return The rotation as a Vector3f */ - Vector3f getRotation(); + Vector3d getRotation(); /** * Sets the rotation of this entity. * + *

The format of the rotation is represented by:

+ * + * + * * @param rotation The rotation to set the entity to */ - void setRotation(Vector3f rotation); + void setRotation(Vector3d rotation); /** * Gets the current velocity of this entity. diff --git a/src/main/java/org/spongepowered/api/entity/Tamer.java b/src/main/java/org/spongepowered/api/entity/Tamer.java index e060f6c5c..05a27f5e2 100644 --- a/src/main/java/org/spongepowered/api/entity/Tamer.java +++ b/src/main/java/org/spongepowered/api/entity/Tamer.java @@ -29,8 +29,7 @@ import org.spongepowered.api.util.Identifiable; public interface Tamer extends Identifiable { /** - * Gets the name of this tamer to reference on tamed entities or null - * if it cannot be obtained. + * Gets the name of this tamer to reference on tamed entities. * * @return The name to reference this tamer */ diff --git a/src/main/java/org/spongepowered/api/entity/living/ArmorStand.java b/src/main/java/org/spongepowered/api/entity/living/ArmorStand.java index 751f97dab..cd8fd6318 100644 --- a/src/main/java/org/spongepowered/api/entity/living/ArmorStand.java +++ b/src/main/java/org/spongepowered/api/entity/living/ArmorStand.java @@ -24,7 +24,7 @@ */ package org.spongepowered.api.entity.living; -import com.flowpowered.math.vector.Vector3f; +import com.flowpowered.math.vector.Vector3d; import org.spongepowered.api.entity.ArmorEquipable; /** @@ -37,84 +37,84 @@ public interface ArmorStand extends Living, ArmorEquipable { * * @return The direction the headpiece is aiming at */ - Vector3f getHeadDirection(); + Vector3d getHeadDirection(); /** * Sets the direction of the head. * * @param direction The direction of the head */ - void setHeadDirection(Vector3f direction); + void setHeadDirection(Vector3d direction); /** * Gets the direction the body is aiming at. * * @return The direction the body is aiming at */ - Vector3f getBodyRotation(); + Vector3d getBodyRotation(); /** * Sets the direction of the body. * * @param direction The direction of the body */ - void setBodyDirection(Vector3f direction); + void setBodyDirection(Vector3d direction); /** * Gets the direction the left arm is aiming at. * * @return The direction the left arm is aiming at */ - Vector3f getLeftArmDirection(); + Vector3d getLeftArmDirection(); /** * Sets the direction of the left arm. * * @param direction The direction of the left arm */ - void setLeftArmDirection(Vector3f direction); + void setLeftArmDirection(Vector3d direction); /** * Gets the direction the right arm is aiming at. * * @return The direction the right arm is aiming at */ - Vector3f getRightArmDirection(); + Vector3d getRightArmDirection(); /** * Sets the direction of the right arm. * * @param direction The direction of the right arm */ - void setRightArmDirection(Vector3f direction); + void setRightArmDirection(Vector3d direction); /** * Gets the direction the left leg is aiming at. * * @return The direction the left leg is aiming at */ - Vector3f getLeftLegDirection(); + Vector3d getLeftLegDirection(); /** * Sets the direction of the left leg. * * @param direction The direction of the left leg */ - void setLeftLegDirection(Vector3f direction); + void setLeftLegDirection(Vector3d direction); /** * Gets the direction the right leg is aiming at. * * @return The direction the right leg is aiming at */ - Vector3f getRightLegDirection(); + Vector3d getRightLegDirection(); /** * Sets the direction of the right leg. * * @param direction The direction of the right leg */ - void setRightLegDirection(Vector3f direction); + void setRightLegDirection(Vector3d direction); /** * Returns whether this armor stand is a small armor stand or not. diff --git a/src/main/java/org/spongepowered/api/entity/living/Human.java b/src/main/java/org/spongepowered/api/entity/living/Human.java index eba01bf49..ceb188a3e 100644 --- a/src/main/java/org/spongepowered/api/entity/living/Human.java +++ b/src/main/java/org/spongepowered/api/entity/living/Human.java @@ -121,7 +121,7 @@ public interface Human extends Living, ProjectileSource, ArmorEquipable, Tamer, * Gets the experience required since the last level to level up. * *

For example, if level 14 reqiures 280 experience points, level 15 - * requires 315, and the player is at level 14, this method will return 35. + * requires 315, and the player is at level 14, this method will return * 35.

* * @return the experience required since the last level to level up diff --git a/src/main/java/org/spongepowered/api/entity/living/Living.java b/src/main/java/org/spongepowered/api/entity/living/Living.java index f88ff823a..9dec4cb35 100644 --- a/src/main/java/org/spongepowered/api/entity/living/Living.java +++ b/src/main/java/org/spongepowered/api/entity/living/Living.java @@ -25,7 +25,7 @@ package org.spongepowered.api.entity.living; -import com.flowpowered.math.vector.Vector3f; +import com.flowpowered.math.vector.Vector3d; import com.google.common.base.Optional; import org.spongepowered.api.attribute.AttributeHolder; import org.spongepowered.api.entity.Entity; @@ -178,7 +178,7 @@ public interface Living extends Entity, AttributeHolder { * * @return The camera location */ - Vector3f getEyeLocation(); + Vector3d getEyeLocation(); /** * Gets the remaining ticks of air. diff --git a/src/main/java/org/spongepowered/api/entity/living/animal/HorseColors.java b/src/main/java/org/spongepowered/api/entity/living/animal/HorseColors.java index 69895d099..c2630d81e 100644 --- a/src/main/java/org/spongepowered/api/entity/living/animal/HorseColors.java +++ b/src/main/java/org/spongepowered/api/entity/living/animal/HorseColors.java @@ -24,6 +24,9 @@ */ package org.spongepowered.api.entity.living.animal; +/** + * An enumeration of known vanilla {@link HorseColor}s. + */ public final class HorseColors { public static final HorseColor WHITE = null; diff --git a/src/main/java/org/spongepowered/api/entity/living/animal/HorseStyles.java b/src/main/java/org/spongepowered/api/entity/living/animal/HorseStyles.java index 6675862bf..a2415ca44 100644 --- a/src/main/java/org/spongepowered/api/entity/living/animal/HorseStyles.java +++ b/src/main/java/org/spongepowered/api/entity/living/animal/HorseStyles.java @@ -24,6 +24,9 @@ */ package org.spongepowered.api.entity.living.animal; +/** + * An enumeration of known vanilla {@link HorseStyle}s. + */ public final class HorseStyles { public static final HorseStyle NONE = null; diff --git a/src/main/java/org/spongepowered/api/entity/living/animal/HorseVariants.java b/src/main/java/org/spongepowered/api/entity/living/animal/HorseVariants.java index e3e821393..4e11dcbd8 100644 --- a/src/main/java/org/spongepowered/api/entity/living/animal/HorseVariants.java +++ b/src/main/java/org/spongepowered/api/entity/living/animal/HorseVariants.java @@ -24,6 +24,9 @@ */ package org.spongepowered.api.entity.living.animal; +/** + * An enumeration of known vanilla {@link HorseVariant}s. + */ public final class HorseVariants { public static final HorseVariant HORSE = null; diff --git a/src/main/java/org/spongepowered/api/entity/living/animal/OcelotTypes.java b/src/main/java/org/spongepowered/api/entity/living/animal/OcelotTypes.java index 3b6e132a4..e382b5751 100644 --- a/src/main/java/org/spongepowered/api/entity/living/animal/OcelotTypes.java +++ b/src/main/java/org/spongepowered/api/entity/living/animal/OcelotTypes.java @@ -24,6 +24,9 @@ */ package org.spongepowered.api.entity.living.animal; +/** + * An enumeration of known vanilla {@link OcelotType}s. + */ public final class OcelotTypes { public static final OcelotType WILD_OCELOT = null; diff --git a/src/main/java/org/spongepowered/api/entity/living/animal/RabbitType.java b/src/main/java/org/spongepowered/api/entity/living/animal/RabbitType.java index 5952d56ad..c02c5fa43 100644 --- a/src/main/java/org/spongepowered/api/entity/living/animal/RabbitType.java +++ b/src/main/java/org/spongepowered/api/entity/living/animal/RabbitType.java @@ -26,6 +26,9 @@ package org.spongepowered.api.entity.living.animal; import org.spongepowered.api.service.persistence.DataSerializable; +/** + * Represents a type of {@link Rabbit}. + */ public interface RabbitType extends DataSerializable { /** diff --git a/src/main/java/org/spongepowered/api/entity/living/animal/RabbitTypes.java b/src/main/java/org/spongepowered/api/entity/living/animal/RabbitTypes.java index 1eaa6e058..4656658f2 100644 --- a/src/main/java/org/spongepowered/api/entity/living/animal/RabbitTypes.java +++ b/src/main/java/org/spongepowered/api/entity/living/animal/RabbitTypes.java @@ -24,6 +24,9 @@ */ package org.spongepowered.api.entity.living.animal; +/** + * An enumeration of known vanilla {@link RabbitType}s. + */ public final class RabbitTypes { public static final RabbitType BROWN = null; diff --git a/src/main/java/org/spongepowered/api/entity/living/monster/SkeletonTypes.java b/src/main/java/org/spongepowered/api/entity/living/monster/SkeletonTypes.java index 533e72c0d..9c6d07e17 100644 --- a/src/main/java/org/spongepowered/api/entity/living/monster/SkeletonTypes.java +++ b/src/main/java/org/spongepowered/api/entity/living/monster/SkeletonTypes.java @@ -24,6 +24,9 @@ */ package org.spongepowered.api.entity.living.monster; +/** + * An enumeration of known vanilla {@link SkeletonType}s. + */ public final class SkeletonTypes { public static final SkeletonType NORMAL = null; diff --git a/src/main/java/org/spongepowered/api/entity/projectile/source/ProjectileSource.java b/src/main/java/org/spongepowered/api/entity/projectile/source/ProjectileSource.java index 8ddd7d972..6d294ae69 100644 --- a/src/main/java/org/spongepowered/api/entity/projectile/source/ProjectileSource.java +++ b/src/main/java/org/spongepowered/api/entity/projectile/source/ProjectileSource.java @@ -24,7 +24,7 @@ */ package org.spongepowered.api.entity.projectile.source; -import com.flowpowered.math.vector.Vector3f; +import com.flowpowered.math.vector.Vector3d; import org.spongepowered.api.entity.projectile.Projectile; /** @@ -49,5 +49,5 @@ public interface ProjectileSource { * @param The Type of Projectile * @return The projectile instance that was launched */ - T launchProjectile(Class projectileClass, Vector3f velocity); + T launchProjectile(Class projectileClass, Vector3d velocity); } diff --git a/src/main/java/org/spongepowered/api/entity/projectile/source/UnknownProjectileSource.java b/src/main/java/org/spongepowered/api/entity/projectile/source/UnknownProjectileSource.java index 65414fe4b..4dae640ef 100644 --- a/src/main/java/org/spongepowered/api/entity/projectile/source/UnknownProjectileSource.java +++ b/src/main/java/org/spongepowered/api/entity/projectile/source/UnknownProjectileSource.java @@ -24,7 +24,7 @@ */ package org.spongepowered.api.entity.projectile.source; -import com.flowpowered.math.vector.Vector3f; +import com.flowpowered.math.vector.Vector3d; import org.spongepowered.api.entity.projectile.Projectile; /** @@ -39,7 +39,7 @@ public final class UnknownProjectileSource implements ProjectileSource { } @Override - public T launchProjectile(Class projectileClass, Vector3f velocity) { + public T launchProjectile(Class projectileClass, Vector3d velocity) { return null; } } diff --git a/src/main/java/org/spongepowered/api/event/AbstractEvent.java b/src/main/java/org/spongepowered/api/event/AbstractEvent.java index f34894ec4..245e6ed0d 100644 --- a/src/main/java/org/spongepowered/api/event/AbstractEvent.java +++ b/src/main/java/org/spongepowered/api/event/AbstractEvent.java @@ -28,6 +28,10 @@ package org.spongepowered.api.event; import org.spongepowered.api.util.event.Event; import org.spongepowered.api.util.event.callback.CallbackList; +/** + * An abstract event that can be extended for any and all custom events as + * necessary. + */ public abstract class AbstractEvent implements Event { private final CallbackList callbacks = new CallbackList(); diff --git a/src/main/java/org/spongepowered/api/event/ExperienceEvent.java b/src/main/java/org/spongepowered/api/event/ExperienceEvent.java index 72d16fbcd..15fe870b5 100644 --- a/src/main/java/org/spongepowered/api/event/ExperienceEvent.java +++ b/src/main/java/org/spongepowered/api/event/ExperienceEvent.java @@ -24,6 +24,9 @@ */ package org.spongepowered.api.event; +/** + * An event that is related to experience. + */ public interface ExperienceEvent { /** diff --git a/src/main/java/org/spongepowered/api/event/SpongeEventFactory.java b/src/main/java/org/spongepowered/api/event/SpongeEventFactory.java index 203e5e5ab..3c8273806 100644 --- a/src/main/java/org/spongepowered/api/event/SpongeEventFactory.java +++ b/src/main/java/org/spongepowered/api/event/SpongeEventFactory.java @@ -26,7 +26,6 @@ package org.spongepowered.api.event; import com.flowpowered.math.vector.Vector3d; -import com.flowpowered.math.vector.Vector3f; import com.flowpowered.math.vector.Vector3i; import com.google.common.base.Optional; import com.google.common.cache.CacheBuilder; @@ -91,26 +90,26 @@ import org.spongepowered.api.event.entity.EntityTameEvent; import org.spongepowered.api.event.entity.EntityTeleportEvent; import org.spongepowered.api.event.entity.EntityUpdateEvent; import org.spongepowered.api.event.entity.ProjectileLaunchEvent; -import org.spongepowered.api.event.entity.living.player.PlayerBreakBlockEvent; -import org.spongepowered.api.event.entity.living.player.PlayerChangeBlockEvent; -import org.spongepowered.api.event.entity.living.player.PlayerChangeGameModeEvent; -import org.spongepowered.api.event.entity.living.player.PlayerChangeWorldEvent; -import org.spongepowered.api.event.entity.living.player.PlayerChatEvent; -import org.spongepowered.api.event.entity.living.player.PlayerDeathEvent; -import org.spongepowered.api.event.entity.living.player.PlayerDropItemEvent; -import org.spongepowered.api.event.entity.living.player.PlayerHarvestBlockEvent; -import org.spongepowered.api.event.entity.living.player.PlayerInteractBlockEvent; -import org.spongepowered.api.event.entity.living.player.PlayerInteractEntityEvent; -import org.spongepowered.api.event.entity.living.player.PlayerInteractEvent; -import org.spongepowered.api.event.entity.living.player.PlayerJoinEvent; -import org.spongepowered.api.event.entity.living.player.PlayerMoveEvent; -import org.spongepowered.api.event.entity.living.player.PlayerPickUpItemEvent; -import org.spongepowered.api.event.entity.living.player.PlayerPlaceBlockEvent; -import org.spongepowered.api.event.entity.living.player.PlayerQuitEvent; -import org.spongepowered.api.event.entity.living.player.PlayerUpdateEvent; -import org.spongepowered.api.event.entity.living.player.fishing.PlayerCastFishingLineEvent; -import org.spongepowered.api.event.entity.living.player.fishing.PlayerHookedEntityEvent; -import org.spongepowered.api.event.entity.living.player.fishing.PlayerRetractFishingLineEvent; +import org.spongepowered.api.event.entity.player.PlayerBreakBlockEvent; +import org.spongepowered.api.event.entity.player.PlayerChangeBlockEvent; +import org.spongepowered.api.event.entity.player.PlayerChangeGameModeEvent; +import org.spongepowered.api.event.entity.player.PlayerChangeWorldEvent; +import org.spongepowered.api.event.entity.player.PlayerChatEvent; +import org.spongepowered.api.event.entity.player.PlayerDeathEvent; +import org.spongepowered.api.event.entity.player.PlayerDropItemEvent; +import org.spongepowered.api.event.entity.player.PlayerHarvestBlockEvent; +import org.spongepowered.api.event.entity.player.PlayerInteractBlockEvent; +import org.spongepowered.api.event.entity.player.PlayerInteractEntityEvent; +import org.spongepowered.api.event.entity.player.PlayerInteractEvent; +import org.spongepowered.api.event.entity.player.PlayerJoinEvent; +import org.spongepowered.api.event.entity.player.PlayerMoveEvent; +import org.spongepowered.api.event.entity.player.PlayerPickUpItemEvent; +import org.spongepowered.api.event.entity.player.PlayerPlaceBlockEvent; +import org.spongepowered.api.event.entity.player.PlayerQuitEvent; +import org.spongepowered.api.event.entity.player.PlayerUpdateEvent; +import org.spongepowered.api.event.entity.player.fishing.PlayerCastFishingLineEvent; +import org.spongepowered.api.event.entity.player.fishing.PlayerHookedEntityEvent; +import org.spongepowered.api.event.entity.player.fishing.PlayerRetractFishingLineEvent; import org.spongepowered.api.event.message.CommandEvent; import org.spongepowered.api.event.message.MessageEvent; import org.spongepowered.api.event.server.StatusPingEvent; @@ -596,7 +595,7 @@ public final class SpongeEventFactory { * @return A new instance of the event */ public static EntityDisplaceEvent createEntityDisplace(Game game, Entity entity, - Location oldLocation, Location newLocation, Vector3f rotation) { + Location oldLocation, Location newLocation, Vector3d rotation) { Map values = Maps.newHashMap(); values.put("game", game); values.put("entity", entity); @@ -721,7 +720,7 @@ public final class SpongeEventFactory { * @return A new instance of the event */ public static EntityMoveEvent createEntityMove(Game game, Entity entity, - Location oldLocation, Location newLocation, Vector3f rotation) { + Location oldLocation, Location newLocation, Vector3d rotation) { Map values = Maps.newHashMap(); values.put("game", game); values.put("entity", entity); @@ -827,7 +826,7 @@ public final class SpongeEventFactory { * @return A new instance of the event */ public static EntityTeleportEvent createEntityTeleport(Game game, Cause cause, Entity entity, Location oldLocation, Location newLocation, - Vector3f rotation, boolean keepsVelocity) { + Vector3d rotation, boolean keepsVelocity) { Map values = Maps.newHashMap(); values.put("game", game); values.put("cause", Optional.fromNullable(cause)); @@ -1185,7 +1184,7 @@ public final class SpongeEventFactory { * @return A new instance of the event */ public static PlayerInteractBlockEvent createPlayerInteractBlock(Game game, Cause cause, Player player, BlockLoc block, - EntityInteractionType interactionType, @Nullable Vector3f location) { + EntityInteractionType interactionType, @Nullable Vector3d location) { Map values = Maps.newHashMap(); values.put("game", game); values.put("cause", Optional.fromNullable(cause)); @@ -1210,7 +1209,7 @@ public final class SpongeEventFactory { * @return A new instance of the event */ public static PlayerInteractEntityEvent createPlayerInteractEntity(Game game, Player player, Entity targetEntity, - EntityInteractionType interactionType, @Nullable Vector3f location) { + EntityInteractionType interactionType, @Nullable Vector3d location) { Map values = Maps.newHashMap(); values.put("game", game); values.put("entity", player); @@ -1233,7 +1232,7 @@ public final class SpongeEventFactory { * @return A new instance of the event */ public static PlayerInteractEvent createPlayerInteract(Game game, Player player, EntityInteractionType interactionType, - @Nullable Vector3f location) { + @Nullable Vector3d location) { Map values = Maps.newHashMap(); values.put("game", game); values.put("entity", player); @@ -1275,7 +1274,7 @@ public final class SpongeEventFactory { * @return A new instance of the event */ public static PlayerMoveEvent createPlayerMove(Game game, Player player, - Location oldLocation, Location newLocation, Vector3f rotation) { + Location oldLocation, Location newLocation, Vector3d rotation) { Map values = Maps.newHashMap(); values.put("game", game); values.put("entity", player); diff --git a/src/main/java/org/spongepowered/api/event/block/data/FurnaceEvent.java b/src/main/java/org/spongepowered/api/event/block/data/FurnaceEvent.java index e17408624..6115edde2 100644 --- a/src/main/java/org/spongepowered/api/event/block/data/FurnaceEvent.java +++ b/src/main/java/org/spongepowered/api/event/block/data/FurnaceEvent.java @@ -27,6 +27,9 @@ package org.spongepowered.api.event.block.data; import org.spongepowered.api.block.data.Furnace; import org.spongepowered.api.event.inventory.BlockInventoryEvent; +/** + * An event that involves a {@link Furnace}. + */ public interface FurnaceEvent extends TileEntityEvent, BlockInventoryEvent { @Override diff --git a/src/main/java/org/spongepowered/api/event/entity/EntityDisplaceEvent.java b/src/main/java/org/spongepowered/api/event/entity/EntityDisplaceEvent.java index 44c192334..ee855767e 100644 --- a/src/main/java/org/spongepowered/api/event/entity/EntityDisplaceEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/EntityDisplaceEvent.java @@ -24,7 +24,7 @@ */ package org.spongepowered.api.event.entity; -import com.flowpowered.math.vector.Vector3f; +import com.flowpowered.math.vector.Vector3d; import org.spongepowered.api.util.event.Cancellable; import org.spongepowered.api.world.Location; @@ -63,13 +63,13 @@ public interface EntityDisplaceEvent extends EntityEvent, Cancellable { * * @return The rotation the entity is facing */ - Vector3f getRotation(); + Vector3d getRotation(); /** * Sets the rotation the entity is facing. * * @param rotation The rotation the entity is facing */ - void setRotation(Vector3f rotation); + void setRotation(Vector3d rotation); } diff --git a/src/main/java/org/spongepowered/api/event/entity/living/LivingPickUpItemEvent.java b/src/main/java/org/spongepowered/api/event/entity/living/LivingPickUpItemEvent.java index 29b9ab20e..0c2b2537c 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/LivingPickUpItemEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/living/LivingPickUpItemEvent.java @@ -27,6 +27,9 @@ package org.spongepowered.api.event.entity.living; import org.spongepowered.api.event.entity.EntityPickUpItemEvent; +/** + * An event where a living entity is picking up an item. + */ public interface LivingPickUpItemEvent extends LivingEvent, EntityPickUpItemEvent { } diff --git a/src/main/java/org/spongepowered/api/event/entity/living/human/HumanPickUpItemEvent.java b/src/main/java/org/spongepowered/api/event/entity/living/human/HumanPickUpItemEvent.java index 2f245ca56..959c1a41a 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/human/HumanPickUpItemEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/living/human/HumanPickUpItemEvent.java @@ -27,6 +27,9 @@ package org.spongepowered.api.event.entity.living.human; import org.spongepowered.api.event.entity.living.LivingPickUpItemEvent; +/** + * An event where a human is picking up an item. + */ public interface HumanPickUpItemEvent extends HumanEvent, LivingPickUpItemEvent { } diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerBreakBlockEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerBreakBlockEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerBreakBlockEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerBreakBlockEvent.java index 040a2a164..be89d7e3c 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerBreakBlockEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerBreakBlockEvent.java @@ -22,7 +22,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.block.BlockLoc; import org.spongepowered.api.entity.player.Player; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerChangeBlockEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerChangeBlockEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerChangeBlockEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerChangeBlockEvent.java index 44091d2c1..fb2660e1f 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerChangeBlockEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerChangeBlockEvent.java @@ -22,7 +22,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.block.BlockLoc; import org.spongepowered.api.entity.player.Player; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerChangeGameModeEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerChangeGameModeEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerChangeGameModeEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerChangeGameModeEvent.java index a5e1a052f..5bc6784ba 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerChangeGameModeEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerChangeGameModeEvent.java @@ -23,7 +23,7 @@ * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.entity.player.Player; import org.spongepowered.api.entity.player.gamemode.GameMode; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerChangeHealthEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerChangeHealthEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerChangeHealthEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerChangeHealthEvent.java index dbcc95776..86c4d4587 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerChangeHealthEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerChangeHealthEvent.java @@ -23,7 +23,7 @@ * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.entity.Entity; import org.spongepowered.api.event.entity.living.human.HumanChangeHealthEvent; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerChangeWorldEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerChangeWorldEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerChangeWorldEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerChangeWorldEvent.java index d5b6f2b0b..7d2f124c5 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerChangeWorldEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerChangeWorldEvent.java @@ -23,7 +23,7 @@ * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.entity.player.Player; import org.spongepowered.api.util.event.Cancellable; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerChatEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerChatEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerChatEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerChatEvent.java index 95ee3a913..6eeefa593 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerChatEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerChatEvent.java @@ -23,7 +23,7 @@ * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.entity.player.Player; import org.spongepowered.api.event.message.MessageEvent; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerDeathEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerDeathEvent.java similarity index 98% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerDeathEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerDeathEvent.java index c35d7656b..60cfb50de 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerDeathEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerDeathEvent.java @@ -23,7 +23,7 @@ * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.entity.player.Player; import org.spongepowered.api.event.entity.living.human.HumanDeathEvent; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerDropItemEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerDropItemEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerDropItemEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerDropItemEvent.java index 61e312367..7a7280df0 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerDropItemEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerDropItemEvent.java @@ -23,7 +23,7 @@ * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.entity.player.Player; import org.spongepowered.api.event.entity.living.human.HumanDropItemEvent; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerEnterBedEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerEnterBedEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerEnterBedEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerEnterBedEvent.java index 64e4dde2e..8ee7d8e76 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerEnterBedEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerEnterBedEvent.java @@ -22,7 +22,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.event.entity.living.human.HumanEnterBedEvent; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerEquipmentChangeEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerEquipmentChangeEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerEquipmentChangeEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerEquipmentChangeEvent.java index 937fcb2be..88fc28e4d 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerEquipmentChangeEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerEquipmentChangeEvent.java @@ -22,7 +22,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.event.entity.living.human.HumanEquipmentChangeEvent; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerEvent.java index 54b890960..a943c5fcb 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerEvent.java @@ -23,7 +23,7 @@ * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.entity.player.Player; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerExpChangeEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerExpChangeEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerExpChangeEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerExpChangeEvent.java index 42f986684..b24bde5a2 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerExpChangeEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerExpChangeEvent.java @@ -22,7 +22,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.event.entity.living.human.HumanExpChangeEvent; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerHarvestBlockEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerHarvestBlockEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerHarvestBlockEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerHarvestBlockEvent.java index 656d5f917..73c137203 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerHarvestBlockEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerHarvestBlockEvent.java @@ -23,7 +23,7 @@ * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.block.BlockLoc; import org.spongepowered.api.entity.player.Player; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerInteractBlockEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerInteractBlockEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerInteractBlockEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerInteractBlockEvent.java index db9c9a6e1..ad7e17cbf 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerInteractBlockEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerInteractBlockEvent.java @@ -22,7 +22,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.block.BlockLoc; import org.spongepowered.api.entity.player.Player; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerInteractEntityEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerInteractEntityEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerInteractEntityEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerInteractEntityEvent.java index 7d37ab34c..27ea5df21 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerInteractEntityEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerInteractEntityEvent.java @@ -22,7 +22,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.entity.Entity; import org.spongepowered.api.entity.player.Player; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerInteractEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerInteractEvent.java similarity index 93% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerInteractEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerInteractEvent.java index 909bf1226..71a492625 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerInteractEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerInteractEvent.java @@ -23,9 +23,9 @@ * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; -import com.flowpowered.math.vector.Vector3f; +import com.flowpowered.math.vector.Vector3d; import com.google.common.base.Optional; import org.spongepowered.api.entity.EntityInteractionType; import org.spongepowered.api.entity.player.Player; @@ -54,6 +54,6 @@ public interface PlayerInteractEvent extends PlayerEvent, HumanInteractEvent { * * @return The position, if available */ - Optional getClickedPosition(); + Optional getClickedPosition(); } diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerItemConsumeEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerItemConsumeEvent.java similarity index 89% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerItemConsumeEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerItemConsumeEvent.java index 795952f26..b3ef9991b 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerItemConsumeEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerItemConsumeEvent.java @@ -22,10 +22,14 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.event.entity.living.human.HumanItemConsumeEvent; +/** + * An event when a player consumes an item. Examples may include: eating, + * drinking a potion, etc. + */ public interface PlayerItemConsumeEvent extends PlayerEvent, HumanItemConsumeEvent { } diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerJoinEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerJoinEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerJoinEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerJoinEvent.java index e1b0da4d0..10545b441 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerJoinEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerJoinEvent.java @@ -23,7 +23,7 @@ * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.entity.player.Player; import org.spongepowered.api.text.Text; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerLeaveBedEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerLeaveBedEvent.java similarity index 97% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerLeaveBedEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerLeaveBedEvent.java index 2864d6f00..b9664c89f 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerLeaveBedEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerLeaveBedEvent.java @@ -22,7 +22,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import com.google.common.base.Optional; import org.spongepowered.api.event.entity.living.human.HumanLeaveBedEvent; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerLevelChangeEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerLevelChangeEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerLevelChangeEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerLevelChangeEvent.java index a59850e31..48dc1a4eb 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerLevelChangeEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerLevelChangeEvent.java @@ -22,7 +22,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.event.entity.living.human.HumanLevelChangeEvent; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerMoveEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerMoveEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerMoveEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerMoveEvent.java index dc660d389..eefe60e5b 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerMoveEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerMoveEvent.java @@ -23,7 +23,7 @@ * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.entity.player.Player; import org.spongepowered.api.event.entity.living.human.HumanMoveEvent; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerPickUpItemEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerPickUpItemEvent.java similarity index 92% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerPickUpItemEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerPickUpItemEvent.java index 22cf57db3..d2e38ede1 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerPickUpItemEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerPickUpItemEvent.java @@ -23,10 +23,13 @@ * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.event.entity.living.human.HumanPickUpItemEvent; +/** + * An event where a player is picking up an item. + */ public interface PlayerPickUpItemEvent extends PlayerEvent, HumanPickUpItemEvent { } diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerPlaceBlockEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerPlaceBlockEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerPlaceBlockEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerPlaceBlockEvent.java index 2e51a3541..3eca52d1d 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerPlaceBlockEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerPlaceBlockEvent.java @@ -22,7 +22,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.block.BlockLoc; import org.spongepowered.api.entity.player.Player; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerQuitEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerQuitEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerQuitEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerQuitEvent.java index fba695759..6ace62fde 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerQuitEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerQuitEvent.java @@ -23,7 +23,7 @@ * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.entity.player.Player; import org.spongepowered.api.text.Text; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerRespawnEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerRespawnEvent.java similarity index 97% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerRespawnEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerRespawnEvent.java index 5a0118253..011c945f5 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerRespawnEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerRespawnEvent.java @@ -22,7 +22,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.world.Location; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerSleepEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerSleepEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerSleepEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerSleepEvent.java index c1eacb115..2b6a8a887 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerSleepEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerSleepEvent.java @@ -22,7 +22,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.event.entity.living.human.HumanSleepEvent; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerUpdateEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/PlayerUpdateEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/PlayerUpdateEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/PlayerUpdateEvent.java index d3fe96ec6..1532e5832 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/PlayerUpdateEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/PlayerUpdateEvent.java @@ -23,7 +23,7 @@ * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player; +package org.spongepowered.api.event.entity.player; import org.spongepowered.api.entity.player.Player; import org.spongepowered.api.event.entity.living.human.HumanUpdateEvent; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/fishing/PlayerCastFishingLineEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/fishing/PlayerCastFishingLineEvent.java similarity index 95% rename from src/main/java/org/spongepowered/api/event/entity/living/player/fishing/PlayerCastFishingLineEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/fishing/PlayerCastFishingLineEvent.java index a04c9e2a8..7067dc512 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/fishing/PlayerCastFishingLineEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/fishing/PlayerCastFishingLineEvent.java @@ -22,7 +22,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player.fishing; +package org.spongepowered.api.event.entity.player.fishing; import org.spongepowered.api.event.entity.living.human.fishing.HumanCastFishingLineEvent; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/fishing/PlayerFishEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/fishing/PlayerFishEvent.java similarity index 91% rename from src/main/java/org/spongepowered/api/event/entity/living/player/fishing/PlayerFishEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/fishing/PlayerFishEvent.java index 9eaf49503..ff3a1f6e9 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/fishing/PlayerFishEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/fishing/PlayerFishEvent.java @@ -22,10 +22,10 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player.fishing; +package org.spongepowered.api.event.entity.player.fishing; import org.spongepowered.api.event.entity.living.human.fishing.HumanFishEvent; -import org.spongepowered.api.event.entity.living.player.PlayerEvent; +import org.spongepowered.api.event.entity.player.PlayerEvent; /** * Called when a {@link org.spongepowered.api.entity.player.Player} performs diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/fishing/PlayerHookedEntityEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/fishing/PlayerHookedEntityEvent.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/fishing/PlayerHookedEntityEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/fishing/PlayerHookedEntityEvent.java index acf5cda27..7e54095b1 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/fishing/PlayerHookedEntityEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/fishing/PlayerHookedEntityEvent.java @@ -22,7 +22,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player.fishing; +package org.spongepowered.api.event.entity.player.fishing; import org.spongepowered.api.event.entity.living.human.fishing.HumanHookedEntityEvent; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/fishing/PlayerRetractFishingLineEvent.java b/src/main/java/org/spongepowered/api/event/entity/player/fishing/PlayerRetractFishingLineEvent.java similarity index 95% rename from src/main/java/org/spongepowered/api/event/entity/living/player/fishing/PlayerRetractFishingLineEvent.java rename to src/main/java/org/spongepowered/api/event/entity/player/fishing/PlayerRetractFishingLineEvent.java index 791671120..b3a0b9e44 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/fishing/PlayerRetractFishingLineEvent.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/fishing/PlayerRetractFishingLineEvent.java @@ -22,7 +22,7 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player.fishing; +package org.spongepowered.api.event.entity.player.fishing; import org.spongepowered.api.event.entity.living.human.fishing.HumanRetractFishingLineEvent; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/fishing/package-info.java b/src/main/java/org/spongepowered/api/event/entity/player/fishing/package-info.java similarity index 94% rename from src/main/java/org/spongepowered/api/event/entity/living/player/fishing/package-info.java rename to src/main/java/org/spongepowered/api/event/entity/player/fishing/package-info.java index b9db4af43..407bfe96b 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/fishing/package-info.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/fishing/package-info.java @@ -22,5 +22,5 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -package org.spongepowered.api.event.entity.living.player.fishing; +package org.spongepowered.api.event.entity.player.fishing; diff --git a/src/main/java/org/spongepowered/api/event/entity/living/player/package-info.java b/src/main/java/org/spongepowered/api/event/entity/player/package-info.java similarity index 96% rename from src/main/java/org/spongepowered/api/event/entity/living/player/package-info.java rename to src/main/java/org/spongepowered/api/event/entity/player/package-info.java index ce3b1cce3..203f89af0 100644 --- a/src/main/java/org/spongepowered/api/event/entity/living/player/package-info.java +++ b/src/main/java/org/spongepowered/api/event/entity/player/package-info.java @@ -23,4 +23,4 @@ * THE SOFTWARE. */ -@org.spongepowered.api.util.annotation.NonnullByDefault package org.spongepowered.api.event.entity.living.player; +@org.spongepowered.api.util.annotation.NonnullByDefault package org.spongepowered.api.event.entity.player; diff --git a/src/main/java/org/spongepowered/api/event/inventory/InventoryClickEvent.java b/src/main/java/org/spongepowered/api/event/inventory/InventoryClickEvent.java index ccefe82b1..a0b85943f 100644 --- a/src/main/java/org/spongepowered/api/event/inventory/InventoryClickEvent.java +++ b/src/main/java/org/spongepowered/api/event/inventory/InventoryClickEvent.java @@ -24,5 +24,10 @@ */ package org.spongepowered.api.event.inventory; +/** + * Represents an event when a viewer has clicked inside an inventory. + * + *

Note that this event is incomplete.

+ */ public interface InventoryClickEvent extends ViewerEvent { } diff --git a/src/main/java/org/spongepowered/api/event/net/package-info.java b/src/main/java/org/spongepowered/api/event/net/package-info.java new file mode 100644 index 000000000..f0cb7c565 --- /dev/null +++ b/src/main/java/org/spongepowered/api/event/net/package-info.java @@ -0,0 +1,26 @@ +/* + * This file is part of Sponge, licensed under the MIT License (MIT). + * + * Copyright (c) SpongePowered.org + * Copyright (c) contributors + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +@org.spongepowered.api.util.annotation.NonnullByDefault package org.spongepowered.api.event.net; diff --git a/src/main/java/org/spongepowered/api/event/rcon/RconCommandEvent.java b/src/main/java/org/spongepowered/api/event/rcon/RconCommandEvent.java index f4f7345ad..ae3e08af5 100644 --- a/src/main/java/org/spongepowered/api/event/rcon/RconCommandEvent.java +++ b/src/main/java/org/spongepowered/api/event/rcon/RconCommandEvent.java @@ -27,6 +27,9 @@ package org.spongepowered.api.event.rcon; import org.spongepowered.api.event.message.CommandEvent; import org.spongepowered.api.util.command.source.RconSource; +/** + * An event when an {@link RconSource} executes a command. + */ public interface RconCommandEvent extends CommandEvent, RconEvent { @Override diff --git a/src/main/java/org/spongepowered/api/event/rcon/RconEvent.java b/src/main/java/org/spongepowered/api/event/rcon/RconEvent.java index e235e05d7..12873045b 100644 --- a/src/main/java/org/spongepowered/api/event/rcon/RconEvent.java +++ b/src/main/java/org/spongepowered/api/event/rcon/RconEvent.java @@ -27,6 +27,9 @@ package org.spongepowered.api.event.rcon; import org.spongepowered.api.event.GameEvent; import org.spongepowered.api.util.command.source.RconSource; +/** + * An event that is associated with an {@link RconSource}. + */ public interface RconEvent extends GameEvent { /** diff --git a/src/main/java/org/spongepowered/api/event/rcon/RconLoginEvent.java b/src/main/java/org/spongepowered/api/event/rcon/RconLoginEvent.java index 8e732e6f4..ab2fd2daf 100644 --- a/src/main/java/org/spongepowered/api/event/rcon/RconLoginEvent.java +++ b/src/main/java/org/spongepowered/api/event/rcon/RconLoginEvent.java @@ -26,6 +26,9 @@ package org.spongepowered.api.event.rcon; import org.spongepowered.api.util.event.Cancellable; +/** + * An event when an Rcon source logs in to the server. + */ public interface RconLoginEvent extends RconEvent, Cancellable { /** diff --git a/src/main/java/org/spongepowered/api/event/rcon/package-info.java b/src/main/java/org/spongepowered/api/event/rcon/package-info.java index 9f422cad2..8a685f637 100644 --- a/src/main/java/org/spongepowered/api/event/rcon/package-info.java +++ b/src/main/java/org/spongepowered/api/event/rcon/package-info.java @@ -22,4 +22,5 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ +@org.spongepowered.api.util.annotation.NonnullByDefault package org.spongepowered.api.event.rcon; diff --git a/src/main/java/org/spongepowered/api/event/world/ChunkForcedEvent.java b/src/main/java/org/spongepowered/api/event/world/ChunkForcedEvent.java index 52672173a..c73b3ca04 100644 --- a/src/main/java/org/spongepowered/api/event/world/ChunkForcedEvent.java +++ b/src/main/java/org/spongepowered/api/event/world/ChunkForcedEvent.java @@ -29,7 +29,11 @@ import com.flowpowered.math.vector.Vector3i; import org.spongepowered.api.event.GameEvent; import org.spongepowered.api.world.ChunkManager; -// NOTE: This does not extend ChunkEvent as Chunk may not be currently loaded. +/** + * Represents a {@link org.spongepowered.api.world.ChunkManager.LoadingTicket} + * forcing a chunk to load into the world. Note that the loading ticket may + * have not finished so the chunk may not have finished loading yet. + */ public interface ChunkForcedEvent extends GameEvent { /** diff --git a/src/main/java/org/spongepowered/api/item/Fishes.java b/src/main/java/org/spongepowered/api/item/Fishes.java index dbbaca1ea..a0eebd40d 100644 --- a/src/main/java/org/spongepowered/api/item/Fishes.java +++ b/src/main/java/org/spongepowered/api/item/Fishes.java @@ -27,7 +27,7 @@ package org.spongepowered.api.item; public final class Fishes { - public static final Fish RAW_FISH = null; + public static final Fish COD = null; public static final Fish SALMON = null; public static final Fish CLOWNFISH = null; public static final Fish PUFFERFISH = null; diff --git a/src/main/java/org/spongepowered/api/item/inventory/ItemStack.java b/src/main/java/org/spongepowered/api/item/inventory/ItemStack.java index 7ebf0aca2..308b27d87 100644 --- a/src/main/java/org/spongepowered/api/item/inventory/ItemStack.java +++ b/src/main/java/org/spongepowered/api/item/inventory/ItemStack.java @@ -153,7 +153,7 @@ public interface ItemStack extends DataHolder, DataSerializable, AttributeSource * @param container The raw data to validate * @return True if the data is valid */ - boolean vaildateData(DataContainer container); + boolean validateData(DataContainer container); /** * Attempts to set all data of this {@link ItemStack} according to the diff --git a/src/main/java/org/spongepowered/api/plugin/PluginManager.java b/src/main/java/org/spongepowered/api/plugin/PluginManager.java index 2ddf8724d..0ba7cef50 100644 --- a/src/main/java/org/spongepowered/api/plugin/PluginManager.java +++ b/src/main/java/org/spongepowered/api/plugin/PluginManager.java @@ -30,6 +30,11 @@ import org.slf4j.Logger; import java.util.Collection; +/** + * The manager that manages plugins. This manager can retrieve {@link + * PluginContainer}s from {@link Plugin} instances, getting {@link Logger}s, + * etc. + */ public interface PluginManager { /** diff --git a/src/main/java/org/spongepowered/api/service/SimpleServiceManager.java b/src/main/java/org/spongepowered/api/service/SimpleServiceManager.java index 8365c0751..5331359f6 100644 --- a/src/main/java/org/spongepowered/api/service/SimpleServiceManager.java +++ b/src/main/java/org/spongepowered/api/service/SimpleServiceManager.java @@ -43,6 +43,9 @@ import java.util.concurrent.locks.ReentrantLock; import javax.annotation.Nullable; import javax.inject.Inject; +/** + * The default implementation of {@link ServiceManager}. + */ public class SimpleServiceManager implements ServiceManager { private final ConcurrentMap, Provider> providers = diff --git a/src/main/java/org/spongepowered/api/service/persistence/data/MemoryDataContainer.java b/src/main/java/org/spongepowered/api/service/persistence/data/MemoryDataContainer.java index 0e26bc01f..3da4a5867 100644 --- a/src/main/java/org/spongepowered/api/service/persistence/data/MemoryDataContainer.java +++ b/src/main/java/org/spongepowered/api/service/persistence/data/MemoryDataContainer.java @@ -26,6 +26,11 @@ package org.spongepowered.api.service.persistence.data; import com.google.common.base.Optional; +/** + * The default implementation of {@link DataContainer} that can be instantiated + * for any use. This is the primary implementation of any {@link DataView} that + * is used throughout both SpongeAPI and Sponge implementation. + */ public class MemoryDataContainer extends MemoryDataView implements DataContainer { @Override diff --git a/src/main/java/org/spongepowered/api/service/persistence/data/MemoryDataView.java b/src/main/java/org/spongepowered/api/service/persistence/data/MemoryDataView.java index 057845795..b9a4148eb 100644 --- a/src/main/java/org/spongepowered/api/service/persistence/data/MemoryDataView.java +++ b/src/main/java/org/spongepowered/api/service/persistence/data/MemoryDataView.java @@ -190,38 +190,38 @@ public class MemoryDataView implements DataView { checkState(this.container != null); if (value instanceof DataView) { - checkArgument(!(value).equals(this)); + checkArgument(value != this); copyDataView(path, (DataView) value); } else if (value instanceof DataSerializable) { DataContainer valueContainer = ((DataSerializable) value).toContainer(); checkArgument(!(valueContainer).equals(this)); copyDataView(path, valueContainer); - } - - List parts = path.getParts(); - if (parts.size() > 1) { - String subKey = parts.get(0); - DataQuery subQuery = new DataQuery(subKey); - Optional subViewOptional = this.getUnsafeView(subQuery); - DataView subView; - if (!subViewOptional.isPresent()) { - this.createView(subQuery); - subView = (DataView) this.map.get(subKey); - } else { - subView = subViewOptional.get(); - } - List subParts = Lists.newArrayListWithCapacity(parts.size() - 1); - for (int i = 1; i < parts.size(); i++) { - subParts.add(parts.get(i)); - } - subView.set(new DataQuery(subParts), value); } else { - if (value instanceof Collection) { - setCollection(parts.get(0), (Collection) value); - } else if (value instanceof Object[]) { - setCollection(parts.get(0), Lists.newArrayList((Object[]) value)); + List parts = path.getParts(); + if (parts.size() > 1) { + String subKey = parts.get(0); + DataQuery subQuery = new DataQuery(subKey); + Optional subViewOptional = this.getUnsafeView(subQuery); + DataView subView; + if (!subViewOptional.isPresent()) { + this.createView(subQuery); + subView = (DataView) this.map.get(subKey); + } else { + subView = subViewOptional.get(); + } + List subParts = Lists.newArrayListWithCapacity(parts.size() - 1); + for (int i = 1; i < parts.size(); i++) { + subParts.add(parts.get(i)); + } + subView.set(new DataQuery(subParts), value); } else { - this.map.put(parts.get(0), value); + if (value instanceof Collection) { + setCollection(parts.get(0), (Collection) value); + } else if (value instanceof Object[]) { + setCollection(parts.get(0), Lists.newArrayList((Object[]) value)); + } else { + this.map.put(parts.get(0), value); + } } } } @@ -252,7 +252,7 @@ public class MemoryDataView implements DataView { private void copyDataView(DataQuery path, DataView value) { Collection valueKeys = value.getKeys(true); for (DataQuery oldKey : valueKeys) { - set(path.then(oldKey), value.get(oldKey)); + set(path.then(oldKey), value.get(oldKey).get()); } } diff --git a/src/main/java/org/spongepowered/api/text/selector/ArgumentTypes.java b/src/main/java/org/spongepowered/api/text/selector/ArgumentTypes.java index 7a5ec055f..920e6b19a 100644 --- a/src/main/java/org/spongepowered/api/text/selector/ArgumentTypes.java +++ b/src/main/java/org/spongepowered/api/text/selector/ArgumentTypes.java @@ -24,7 +24,7 @@ */ package org.spongepowered.api.text.selector; -import com.flowpowered.math.vector.Vector3f; +import com.flowpowered.math.vector.Vector3d; import com.flowpowered.math.vector.Vector3i; import org.spongepowered.api.entity.EntityType; import org.spongepowered.api.entity.player.gamemode.GameMode; @@ -120,7 +120,7 @@ public final class ArgumentTypes { * {@code rx}/{@code ry} (for minimum) and {@code rxm}/{@code rym} selector * keys.

*/ - public static final ArgumentType.Limit> ROTATION = null; + public static final ArgumentType.Limit> ROTATION = null; /** * The argument type filtering targets based on the {@link EntityType}. diff --git a/src/main/java/org/spongepowered/api/util/Axis.java b/src/main/java/org/spongepowered/api/util/Axis.java index 6c0f6cabf..8fe63af5c 100644 --- a/src/main/java/org/spongepowered/api/util/Axis.java +++ b/src/main/java/org/spongepowered/api/util/Axis.java @@ -27,6 +27,9 @@ package org.spongepowered.api.util; import com.flowpowered.math.vector.Vector3d; +/** + * Represents a three dimensional cartesian axis. + */ public enum Axis { X(new Vector3d(1, 0, 0)), diff --git a/src/main/java/org/spongepowered/api/util/AxisDirection.java b/src/main/java/org/spongepowered/api/util/AxisDirection.java index bb323664c..57255d7f1 100644 --- a/src/main/java/org/spongepowered/api/util/AxisDirection.java +++ b/src/main/java/org/spongepowered/api/util/AxisDirection.java @@ -24,6 +24,10 @@ */ package org.spongepowered.api.util; +/** + * Represents the directional axis is either + * positive, zero, or negative. + */ public enum AxisDirection { PLUS(1), diff --git a/src/main/java/org/spongepowered/api/util/command/source/RconSource.java b/src/main/java/org/spongepowered/api/util/command/source/RconSource.java index aee3e73d2..ef4583f70 100644 --- a/src/main/java/org/spongepowered/api/util/command/source/RconSource.java +++ b/src/main/java/org/spongepowered/api/util/command/source/RconSource.java @@ -27,7 +27,7 @@ package org.spongepowered.api.util.command.source; import java.net.InetSocketAddress; /** - * Represents an Rcon client + * Represents an Rcon client. */ public interface RconSource extends RemoteSource { diff --git a/src/main/java/org/spongepowered/api/util/event/Cancellable.java b/src/main/java/org/spongepowered/api/util/event/Cancellable.java index 4aa01ae96..06968c362 100644 --- a/src/main/java/org/spongepowered/api/util/event/Cancellable.java +++ b/src/main/java/org/spongepowered/api/util/event/Cancellable.java @@ -25,6 +25,9 @@ package org.spongepowered.api.util.event; +/** + * Represents an event that can be cancelled. + */ public interface Cancellable { /** diff --git a/src/main/java/org/spongepowered/api/world/ChunkManager.java b/src/main/java/org/spongepowered/api/world/ChunkManager.java index e35cfef04..778506ed7 100644 --- a/src/main/java/org/spongepowered/api/world/ChunkManager.java +++ b/src/main/java/org/spongepowered/api/world/ChunkManager.java @@ -37,6 +37,10 @@ import org.spongepowered.api.entity.Entity; import java.util.List; import java.util.UUID; +/** + * A manager of chunks. Chunks can be managed via tickets that may represent + * forced-chunk-loading, player-chunk-loading, entity-chunk-loading, etc. + */ public interface ChunkManager { /** diff --git a/src/main/java/org/spongepowered/api/world/extent/EntityUniverse.java b/src/main/java/org/spongepowered/api/world/extent/EntityUniverse.java index b13c55f95..5dfbe57f0 100644 --- a/src/main/java/org/spongepowered/api/world/extent/EntityUniverse.java +++ b/src/main/java/org/spongepowered/api/world/extent/EntityUniverse.java @@ -71,6 +71,13 @@ public interface EntityUniverse { /** * Create an entity instance at the given position. * + *

Creating an entity does not spawn the entity into the world. An + * entity created means the entity can be spawned at the given location. + * If {@link Optional#absent()} was returned, the entity is not able to + * spawn at the given location. Furthermore, this allows for the {@link + * Entity} to be customized further prior to traditional "ticking" and + * processing by core systems.

+ * * @param type The type * @param position The position * @return An entity, if one was created @@ -80,6 +87,13 @@ public interface EntityUniverse { /** * Create an entity instance at the given position. * + *

Creating an entity does not spawn the entity into the world. An + * entity created means the entity can be spawned at the given location. + * If {@link Optional#absent()} was returned, the entity is not able to + * spawn at the given location. Furthermore, this allows for the {@link + * Entity} to be customized further prior to traditional "ticking" and + * processing by core systems.

+ * * @param snapshot The snapshot * @param position The position * @return An entity, if one was created @@ -89,6 +103,13 @@ public interface EntityUniverse { /** * Create an entity instance at the given position. * + *

Creating an entity does not spawn the entity into the world. An + * entity created means the entity can be spawned at the given location. + * If {@link Optional#absent()} was returned, the entity is not able to + * spawn at the given location. Furthermore, this allows for the {@link + * Entity} to be customized further prior to traditional "ticking" and + * processing by core systems.

+ * * @param type The type * @param position The position * @return An entity, if one was created @@ -98,6 +119,13 @@ public interface EntityUniverse { /** * Create an entity instance at the given position. * + *

Creating an entity does not spawn the entity into the world. An + * entity created means the entity can be spawned at the given location. + * If {@link Optional#absent()} was returned, the entity is not able to + * spawn at the given location. Furthermore, this allows for the {@link + * Entity} to be customized further prior to traditional "ticking" and + * processing by core systems.

+ * * @param snapshot The snapshot * @param position The position * @return An entity, if one was created @@ -107,13 +135,29 @@ public interface EntityUniverse { /** * Create an entity instance at the given position. * + *

Creating an entity does not spawn the entity into the world. An + * entity created means the entity can be spawned at the given location. + * If {@link Optional#absent()} was returned, the entity is not able to + * spawn at the given location. Furthermore, this allows for the {@link + * Entity} to be customized further prior to traditional "ticking" and + * processing by core systems.

+ * * @param entityContainer The data container of the entity * @return An entity, if one was created */ Optional createEntity(DataContainer entityContainer); /** - * Spawns an entity using the already set properties (extent, position, rotation). + * Spawns an entity using the already set properties (extent, position, + * rotation). + * + *

The requirements involve that all necessary setup of states and data + * is already preformed on the entity retrieved from the various {@link + * #createEntity(EntityType,Vector3d)} methods. Calling this will make the + * now-spawned entity able to be processed by various systems.

+ * + *

If the entity was unable to spawn, the entity is not removed, but it + * should be taken note that there can be many reasons for a failure.

* * @param entity The entity to spawn * @return True if successful, false if not diff --git a/src/main/java/org/spongepowered/api/world/storage/WorldStorage.java b/src/main/java/org/spongepowered/api/world/storage/WorldStorage.java index ba483fd51..d47ff6647 100644 --- a/src/main/java/org/spongepowered/api/world/storage/WorldStorage.java +++ b/src/main/java/org/spongepowered/api/world/storage/WorldStorage.java @@ -30,6 +30,13 @@ import com.google.common.util.concurrent.ListenableFuture; import org.spongepowered.api.service.persistence.data.DataContainer; import org.spongepowered.api.world.Chunk; +/** + * Represents the storage manager of a particular {@link org.spongepowered.api.world.World}. + * + *

It should be noted that this can have direct access to the underlying + * storage system of the world and interface with deleting and modifying + * chunks.

+ */ public interface WorldStorage { /** diff --git a/src/test/java/org/spongepowered/api/service/persistence/data/MemoryDataTest.java b/src/test/java/org/spongepowered/api/service/persistence/data/MemoryDataTest.java index bbe5fb23e..e67904aa6 100644 --- a/src/test/java/org/spongepowered/api/service/persistence/data/MemoryDataTest.java +++ b/src/test/java/org/spongepowered/api/service/persistence/data/MemoryDataTest.java @@ -215,7 +215,7 @@ public class MemoryDataTest { List myList = ImmutableList.of("foo", "bar", "baz"); - SimpleData temp = new SimpleData(1, 2.0, "foo", ImmutableList.of("foo", "bar", "baz")); + SimpleData temp = new SimpleData(1, 2.0, "foo", myList); DataContainer container = temp.toContainer(); Optional fromContainer = container.getSerializable(new DataQuery(), SimpleData.class, service);