Pulling all pending Bukkit-JavaDoc changes
A special thanks goes to @aerouk for almost all of the changes found here.
This commit is contained in:
@@ -42,8 +42,8 @@ public class PlayerInteractEvent extends PlayerEvent implements Cancellable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the cancellation state of this event. Set to true if you
|
||||
* want to prevent buckets from placing water and so forth
|
||||
* Gets the cancellation state of this event. Set to true if you want to
|
||||
* prevent buckets from placing water and so forth
|
||||
*
|
||||
* @return boolean cancellation state
|
||||
*/
|
||||
@@ -52,8 +52,8 @@ public class PlayerInteractEvent extends PlayerEvent implements Cancellable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the cancellation state of this event. A canceled event will not
|
||||
* be executed in the server, but will still pass to other plugins
|
||||
* Sets the cancellation state of this event. A canceled event will not be
|
||||
* executed in the server, but will still pass to other plugins
|
||||
* <p>
|
||||
* Canceling this event will prevent use of food (player won't lose the
|
||||
* food item), prevent bows/snowballs/eggs from firing, etc. (player won't
|
||||
@@ -76,8 +76,8 @@ public class PlayerInteractEvent extends PlayerEvent implements Cancellable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Convenience method. Returns the material of the item represented by this
|
||||
* event
|
||||
* Convenience method. Returns the material of the item represented by
|
||||
* this event
|
||||
*
|
||||
* @return Material the material of the item used
|
||||
*/
|
||||
@@ -108,8 +108,8 @@ public class PlayerInteractEvent extends PlayerEvent implements Cancellable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Convenience method to inform the user whether this was a block placement
|
||||
* event.
|
||||
* Convenience method to inform the user whether this was a block
|
||||
* placement event.
|
||||
*
|
||||
* @return boolean true if the item in hand was a block
|
||||
*/
|
||||
@@ -140,8 +140,9 @@ public class PlayerInteractEvent extends PlayerEvent implements Cancellable {
|
||||
}
|
||||
|
||||
/**
|
||||
* This controls the action to take with the block (if any) that was clicked on
|
||||
* This event gets processed for all blocks, but most don't have a default action
|
||||
* This controls the action to take with the block (if any) that was
|
||||
* clicked on. This event gets processed for all blocks, but most don't
|
||||
* have a default action
|
||||
*
|
||||
* @return the action to take with the interacted block
|
||||
*/
|
||||
@@ -157,9 +158,10 @@ public class PlayerInteractEvent extends PlayerEvent implements Cancellable {
|
||||
}
|
||||
|
||||
/**
|
||||
* This controls the action to take with the item the player is holding
|
||||
* This includes both blocks and items (such as flint and steel or records)
|
||||
* When this is set to default, it will be allowed if no action is taken on the interacted block
|
||||
* This controls the action to take with the item the player is holding.
|
||||
* This includes both blocks and items (such as flint and steel or
|
||||
* records). When this is set to default, it will be allowed if no action
|
||||
* is taken on the interacted block.
|
||||
*
|
||||
* @return the action to take with the item in hand
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user