Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edited get/set method javadoc PlayerInteractEvent #92

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Edited get/set method javadoc PlayerInteractEvent #92

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions src/main/java/org/bukkit/event/player/PlayerInteractEvent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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()) {
Expand Down Expand Up @@ -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
*/
Expand All @@ -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) {
Expand All @@ -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) {
Expand Down