Pulling all pending Bukkit-JavaDoc changes
By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
@@ -15,7 +15,8 @@ public enum EventPriority {
|
||||
*/
|
||||
LOW(1),
|
||||
/**
|
||||
* Event call is neither important or unimportant, and may be ran normally
|
||||
* Event call is neither important nor unimportant, and may be ran
|
||||
* normally
|
||||
*/
|
||||
NORMAL(2),
|
||||
/**
|
||||
|
||||
@@ -13,10 +13,10 @@ import org.bukkit.event.HandlerList;
|
||||
* <p>
|
||||
* The constructor provides a boolean to indicate if the event was fired
|
||||
* synchronously or asynchronously. When asynchronous, this event can be
|
||||
* called from any thread, but the main thread, and has limited access to the
|
||||
* called from any thread, sans the main thread, and has limited access to the
|
||||
* API.
|
||||
* <p>
|
||||
* If a player is the direct cause of this event by incoming packet, this
|
||||
* If a player is the direct cause of this event by an incoming packet, this
|
||||
* event will be asynchronous. If a plugin triggers this event by compelling a
|
||||
* player to chat, this event will be synchronous.
|
||||
* <p>
|
||||
|
||||
@@ -10,8 +10,8 @@ import org.bukkit.event.HandlerList;
|
||||
/**
|
||||
* Called when a player statistic is incremented.
|
||||
* <p>
|
||||
* This event is not called for {@link org.bukkit.Statistic#PLAY_ONE_MINUTE}
|
||||
* or movement based statistics.
|
||||
* This event is not called for {@link org.bukkit.Statistic#PLAY_ONE_TICK} or
|
||||
* movement based statistics.
|
||||
*
|
||||
*/
|
||||
public class PlayerStatisticIncrementEvent extends PlayerEvent implements Cancellable {
|
||||
@@ -52,7 +52,7 @@ public class PlayerStatisticIncrementEvent extends PlayerEvent implements Cancel
|
||||
|
||||
/**
|
||||
* Gets the statistic that is being incremented.
|
||||
*
|
||||
*
|
||||
* @return the incremented statistic
|
||||
*/
|
||||
public Statistic getStatistic() {
|
||||
@@ -61,7 +61,7 @@ public class PlayerStatisticIncrementEvent extends PlayerEvent implements Cancel
|
||||
|
||||
/**
|
||||
* Gets the previous value of the statistic.
|
||||
*
|
||||
*
|
||||
* @return the previous value of the statistic
|
||||
*/
|
||||
public int getPreviousValue() {
|
||||
@@ -70,7 +70,7 @@ public class PlayerStatisticIncrementEvent extends PlayerEvent implements Cancel
|
||||
|
||||
/**
|
||||
* Gets the new value of the statistic.
|
||||
*
|
||||
*
|
||||
* @return the new value of the statistic
|
||||
*/
|
||||
public int getNewValue() {
|
||||
@@ -80,7 +80,7 @@ public class PlayerStatisticIncrementEvent extends PlayerEvent implements Cancel
|
||||
/**
|
||||
* Gets the EntityType if {@link #getStatistic() getStatistic()} is an
|
||||
* entity statistic otherwise returns null.
|
||||
*
|
||||
*
|
||||
* @return the EntityType of the statistic
|
||||
*/
|
||||
public EntityType getEntityType() {
|
||||
@@ -90,7 +90,7 @@ public class PlayerStatisticIncrementEvent extends PlayerEvent implements Cancel
|
||||
/**
|
||||
* Gets the Material if {@link #getStatistic() getStatistic()} is a block
|
||||
* or item statistic otherwise returns null.
|
||||
*
|
||||
*
|
||||
* @return the Material of the statistic
|
||||
*/
|
||||
public Material getMaterial() {
|
||||
|
||||
Reference in New Issue
Block a user