SteamWar/Paper
10
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/entity/EntityCombustByBlockEvent.java
View File

@@ -3,6 +3,9 @@ package org.bukkit.event.entity;
import org.bukkit.block.Block;
import org.bukkit.entity.Entity;
/**
* Called when a block causes an entity to combust.
*/
public class EntityCombustByBlockEvent extends EntityCombustEvent {
private final Block combuster;

3
paper-api/src/main/java/org/bukkit/event/entity/EntityCombustByEntityEvent.java
View File

@@ -2,6 +2,9 @@ package org.bukkit.event.entity;
import org.bukkit.entity.Entity;
/**
* Called when an entity causes another entity to combust.
*/
public class EntityCombustByEntityEvent extends EntityCombustEvent {
private final Entity combuster;

39
paper-api/src/main/java/org/bukkit/event/entity/EntityPortalEvent.java
View File

@@ -6,9 +6,10 @@ import org.bukkit.entity.Entity;
import org.bukkit.event.HandlerList;
/**
* Called when a non-player entity is about to teleport because it is in contact with a portal
* Called when a non-player entity is about to teleport because it is in
* contact with a portal.
* <p>
* For players see {@link org.bukkit.event.player.PlayerPortalEvent PlayerPortalEvent}
* For players see {@link org.bukkit.event.player.PlayerPortalEvent}
*/
public class EntityPortalEvent extends EntityTeleportEvent {
private static final HandlerList handlers = new HandlerList();
@@ -20,18 +21,52 @@ public class EntityPortalEvent extends EntityTeleportEvent {
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 #getEntity()} 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 #getEntity()} will only be
* teleported to the {@link #getTo()} Location.
*
* @return whether to use the Travel Agent
*/
public boolean useTravelAgent() {
return useTravelAgent;
}
/**
* 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;
}

7
paper-api/src/main/java/org/bukkit/event/entity/ItemDespawnEvent.java
View File

@@ -5,6 +5,13 @@ import org.bukkit.entity.Item;
import org.bukkit.event.Cancellable;
import org.bukkit.event.HandlerList;
/**
* This event is called when a {@link org.bukkit.entity.Item} is removed from
* the world because it has existed for 5 minutes.
* <p>
* Cancelling the event results in the item being allowed to exist for 5 more
* minutes. This behavior is not guaranteed and may change in future versions.
*/
public class ItemDespawnEvent extends EntityEvent implements Cancellable {
private static final HandlerList handlers = new HandlerList();
private boolean canceled;