SteamWar/Paper
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Pulling all pending Bukkit-JavaDoc changes

Browse Source 
By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
Bukkit/Spigot
2013-09-10 21:02:53 -05:00
parent f60d6710d5
commit 67439804f4
61 changed files with 219 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
paper-api/src/main/java/org/bukkit/event/player/PlayerBucketEvent.java
View File

@@ -7,6 +7,9 @@ import org.bukkit.entity.Player;
import org.bukkit.event.Cancellable;
import org.bukkit.inventory.ItemStack;
/**
* Called when a player interacts with a Bucket
*/
public abstract class PlayerBucketEvent extends PlayerEvent implements Cancellable {
private ItemStack itemStack;
private boolean cancelled = false;

2
paper-api/src/main/java/org/bukkit/event/player/PlayerEditBookEvent.java
View File

@@ -77,7 +77,7 @@ public class PlayerEditBookEvent extends PlayerEvent implements Cancellable {
/**
* Sets the book meta that will actually be added to the book.
*
* @param bookMeta new book meta
* @param newBookMeta new book meta
* @throws IllegalArgumentException if the new book meta is null
*/
public void setNewBookMeta(BookMeta newBookMeta) throws IllegalArgumentException {

39
paper-api/src/main/java/org/bukkit/event/player/PlayerPortalEvent.java
View File

@@ -6,7 +6,10 @@ import org.bukkit.entity.Player;
import org.bukkit.event.HandlerList;
/**
* Called when a player is about to teleport because it is in contact with a portal
* Called when a player is about to teleport because it is in contact with a
* portal.
* <p>
* For other entities see {@link org.bukkit.event.entity.EntityPortalEvent}
*/
public class PlayerPortalEvent extends PlayerTeleportEvent {
private static final HandlerList handlers = new HandlerList();
@@ -23,18 +26,52 @@ public class PlayerPortalEvent extends PlayerTeleportEvent {
this.travelAgent = pta;
}
/**
* Sets whether or not the Travel Agent will be used.
* <p>
* If this is set to true, the TravelAgent will try to find a Portal at
* the {@link #getTo()} Location, and will try to create one if there is
* none.
* <p>
* If this is set to false, the {@link #getPlayer()} will only be
* teleported to the {@link #getTo()} Location.
*
* @param useTravelAgent whether to use the Travel Agent
*/
public void useTravelAgent(boolean useTravelAgent) {
this.useTravelAgent = useTravelAgent;
}
/**
* Gets whether or not the Travel Agent will be used.
* <p>
* If this is set to true, the TravelAgent will try to find a Portal at
* the {@link #getTo()} Location, and will try to create one if there is
* none.
* <p>
* If this is set to false, the {@link #getPlayer()}} will only be
* teleported to the {@link #getTo()} Location.
*
* @return whether to use the Travel Agent
*/
public boolean useTravelAgent() {
return useTravelAgent && travelAgent != null;
}
/**
* Gets the Travel Agent used (or not) in this event.
*
* @return the Travel Agent used (or not) in this event
*/
public TravelAgent getPortalTravelAgent() {
return this.travelAgent;
}
/**
* Sets the Travel Agent used (or not) in this event.
*
* @param travelAgent the Travel Agent used (or not) in this event
*/
public void setPortalTravelAgent(TravelAgent travelAgent) {
this.travelAgent = travelAgent;
}