Pulling all pending Bukkit-JavaDoc changes
By: Edmond Poon <sagaciouszzzz@gmail.com>
This commit is contained in:
@@ -4,6 +4,9 @@ import org.bukkit.World;
|
||||
import org.bukkit.entity.Player;
|
||||
import org.bukkit.event.HandlerList;
|
||||
|
||||
/**
|
||||
* Called when a player switches to another world.
|
||||
*/
|
||||
public class PlayerChangedWorldEvent extends PlayerEvent {
|
||||
private static final HandlerList handlers = new HandlerList();
|
||||
private final World from;
|
||||
@@ -13,6 +16,11 @@ public class PlayerChangedWorldEvent extends PlayerEvent {
|
||||
this.from = from;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the world the player is switching from.
|
||||
*
|
||||
* @return player's previous world
|
||||
*/
|
||||
public World getFrom() {
|
||||
return from;
|
||||
}
|
||||
|
||||
@@ -109,6 +109,7 @@ public class PlayerCommandPreprocessEvent extends PlayerEvent implements Cancell
|
||||
* The set returned is not guaranteed to be mutable and may auto-populate on access.
|
||||
* Any listener accessing the returned set should be aware that it may reduce performance for a lazy set implementation.
|
||||
* Listeners should be aware that modifying the list may throw {@link UnsupportedOperationException} if the event caller provides an unmodifiable set.
|
||||
*
|
||||
* @deprecated This method is provided for backward compatibility with no guarantee to the effect of viewing or modifying the set.
|
||||
* @return All Players who will see this chat message
|
||||
*/
|
||||
|
||||
@@ -47,6 +47,7 @@ public class PlayerFishEvent extends PlayerEvent implements Cancellable {
|
||||
|
||||
/**
|
||||
* Gets the fishing hook.
|
||||
*
|
||||
* @return Fish the entity representing the fishing hook/bobber.
|
||||
*/
|
||||
public Fish getHook() {
|
||||
|
||||
@@ -5,6 +5,9 @@ import org.bukkit.entity.Player;
|
||||
import org.bukkit.event.Cancellable;
|
||||
import org.bukkit.event.HandlerList;
|
||||
|
||||
/**
|
||||
* Called when the GameMode of the player is changed.
|
||||
*/
|
||||
public class PlayerGameModeChangeEvent extends PlayerEvent implements Cancellable {
|
||||
private static final HandlerList handlers = new HandlerList();
|
||||
private boolean cancelled;
|
||||
@@ -23,6 +26,11 @@ public class PlayerGameModeChangeEvent extends PlayerEvent implements Cancellabl
|
||||
this.cancelled = cancel;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the GameMode the player is switched to.
|
||||
*
|
||||
* @return player's new GameMode
|
||||
*/
|
||||
public GameMode getNewGameMode() {
|
||||
return newGameMode;
|
||||
}
|
||||
|
||||
@@ -22,7 +22,6 @@ public class PlayerItemConsumeEvent extends PlayerEvent implements Cancellable {
|
||||
private ItemStack item;
|
||||
|
||||
/**
|
||||
*
|
||||
* @param player the player consuming
|
||||
* @param item the ItemStack being consumed
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user