From 2e6e7534cfefeeb5284d24be5328a507cf8ce598 Mon Sep 17 00:00:00 2001 From: jack lin Date: Tue, 12 Aug 2014 15:50:19 +1200 Subject: [PATCH] Edited get/set method javadoc PlayerInteractEvent --- .../event/player/PlayerInteractEvent.java | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/src/main/java/org/bukkit/event/player/PlayerInteractEvent.java b/src/main/java/org/bukkit/event/player/PlayerInteractEvent.java index 59567d99..06e6d961 100644 --- a/src/main/java/org/bukkit/event/player/PlayerInteractEvent.java +++ b/src/main/java/org/bukkit/event/player/PlayerInteractEvent.java @@ -33,9 +33,9 @@ public PlayerInteractEvent(final Player who, final Action action, final ItemStac } /** - * Returns the action type + * Gets the action preformed * - * @return Action returns the type of interaction + * @return Action returns the action preformed */ public Action getAction() { return action; @@ -67,19 +67,19 @@ public void setCancelled(boolean cancel) { } /** - * Returns the item in hand represented by this event + * Gets the item in hand represented by this event * - * @return ItemStack the item used + * @return ItemStack the item involved */ public ItemStack getItem() { return this.item; } /** - * Convenience method. Returns the material of the item represented by + * Convenience method. Gets the material of the item represented by * this event * - * @return Material the material of the item used + * @return Material the material of the item involved */ public Material getMaterial() { if (!hasItem()) { @@ -122,16 +122,16 @@ public boolean isBlockInHand() { } /** - * Returns the clicked block + * Gets the clicked block * - * @return Block returns the block clicked with this item. + * @return Block returns the block clicked. */ public Block getClickedBlock() { return blockClicked; } /** - * Returns the face of the block that was clicked + * Gets the face of the block that was clicked * * @return BlockFace returns the face of the block that was clicked */ @@ -151,6 +151,7 @@ public Result useInteractedBlock() { } /** + * Sets the action to take with the interacted block * @param useInteractedBlock the action to take with the interacted block */ public void setUseInteractedBlock(Result useInteractedBlock) { @@ -170,6 +171,7 @@ public Result useItemInHand() { } /** + * Sets the action to take with the item in hand * @param useItemInHand the action to take with the item in hand */ public void setUseItemInHand(Result useItemInHand) {