diff options
author | EthanZeigler <ethanzeigler@gmail.com> | 2016-12-24 09:27:52 -0500 |
---|---|---|
committer | md_5 <git@md-5.net> | 2016-12-30 09:43:35 +1100 |
commit | 7e06c5b90030426a4200627364c70cd0c3cecee8 (patch) | |
tree | 33325aa68f682ddc7e4229ebc6562ec9102fb33a | |
parent | d991ef4bc922b6d3fd68e2e48d88545654b57eb8 (diff) | |
download | bukkit-7e06c5b90030426a4200627364c70cd0c3cecee8.tar bukkit-7e06c5b90030426a4200627364c70cd0c3cecee8.tar.gz bukkit-7e06c5b90030426a4200627364c70cd0c3cecee8.tar.lz bukkit-7e06c5b90030426a4200627364c70cd0c3cecee8.tar.xz bukkit-7e06c5b90030426a4200627364c70cd0c3cecee8.zip |
Improve documentation of the PlayerInteractEvent and PlayerInteractAtEntityEvent
-rw-r--r-- | src/main/java/org/bukkit/event/player/PlayerInteractAtEntityEvent.java | 4 | ||||
-rw-r--r-- | src/main/java/org/bukkit/event/player/PlayerInteractEvent.java | 4 |
2 files changed, 5 insertions, 3 deletions
diff --git a/src/main/java/org/bukkit/event/player/PlayerInteractAtEntityEvent.java b/src/main/java/org/bukkit/event/player/PlayerInteractAtEntityEvent.java index 15f9624a..de39245e 100644 --- a/src/main/java/org/bukkit/event/player/PlayerInteractAtEntityEvent.java +++ b/src/main/java/org/bukkit/event/player/PlayerInteractAtEntityEvent.java @@ -7,8 +7,8 @@ import org.bukkit.inventory.EquipmentSlot; import org.bukkit.util.Vector; /** - * Represents an event that is called when a player right clicks an entity - * with a location on the entity the was clicked. + * Represents an event that is called when a player right clicks an entity that + * also contains the location where the entity was clicked. */ public class PlayerInteractAtEntityEvent extends PlayerInteractEntityEvent { private static final HandlerList handlers = new HandlerList(); diff --git a/src/main/java/org/bukkit/event/player/PlayerInteractEvent.java b/src/main/java/org/bukkit/event/player/PlayerInteractEvent.java index 818b4813..0c841fb1 100644 --- a/src/main/java/org/bukkit/event/player/PlayerInteractEvent.java +++ b/src/main/java/org/bukkit/event/player/PlayerInteractEvent.java @@ -11,7 +11,9 @@ import org.bukkit.event.block.Action; import org.bukkit.inventory.EquipmentSlot; /** - * Called when a player interacts with an object or air. + * Represents an event that is called when a player interacts with an object or + * air, potentially fired once for each hand. The hand can be determined using + * {@link #getHand()}. * <p> * This event will fire as cancelled if the vanilla behavior * is to do nothing (e.g interacting with air) |