org.bukkit.event.player
Class PlayerPortalEvent

java.lang.Object
  extended by org.bukkit.event.Event
      extended by org.bukkit.event.player.PlayerEvent
          extended by org.bukkit.event.player.PlayerMoveEvent
              extended by org.bukkit.event.player.PlayerTeleportEvent
                  extended by org.bukkit.event.player.PlayerPortalEvent
All Implemented Interfaces:
Cancellable

public class PlayerPortalEvent
extends PlayerTeleportEvent

Called when a player is about to teleport because it is in contact with a portal.

For other entities see EntityPortalEvent


Nested Class Summary
 
Nested classes/interfaces inherited from class org.bukkit.event.player.PlayerTeleportEvent
PlayerTeleportEvent.TeleportCause
 
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
 
Field Summary
protected  TravelAgent travelAgent
           
protected  boolean useTravelAgent
           
 
Fields inherited from class org.bukkit.event.player.PlayerEvent
player
 
Constructor Summary
PlayerPortalEvent(Player player, Location from, Location to, TravelAgent pta)
           
PlayerPortalEvent(Player player, Location from, Location to, TravelAgent pta, PlayerTeleportEvent.TeleportCause cause)
           
 
Method Summary
static HandlerList getHandlerList()
           
 HandlerList getHandlers()
           
 TravelAgent getPortalTravelAgent()
          Gets the Travel Agent used (or not) in this event.
 void setPortalTravelAgent(TravelAgent travelAgent)
          Sets the Travel Agent used (or not) in this event.
 boolean useTravelAgent()
          Gets whether or not the Travel Agent will be used.
 void useTravelAgent(boolean useTravelAgent)
          Sets whether or not the Travel Agent will be used.
 
Methods inherited from class org.bukkit.event.player.PlayerTeleportEvent
getCause
 
Methods inherited from class org.bukkit.event.player.PlayerMoveEvent
getFrom, getTo, isCancelled, setCancelled, setFrom, setTo
 
Methods inherited from class org.bukkit.event.player.PlayerEvent
getPlayer
 
Methods inherited from class org.bukkit.event.Event
getEventName, isAsynchronous
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

useTravelAgent

protected boolean useTravelAgent

travelAgent

protected TravelAgent travelAgent
Constructor Detail

PlayerPortalEvent

public PlayerPortalEvent(Player player,
                         Location from,
                         Location to,
                         TravelAgent pta)

PlayerPortalEvent

public PlayerPortalEvent(Player player,
                         Location from,
                         Location to,
                         TravelAgent pta,
                         PlayerTeleportEvent.TeleportCause cause)
Method Detail

useTravelAgent

public void useTravelAgent(boolean useTravelAgent)
Sets whether or not the Travel Agent will be used.

If this is set to true, the TravelAgent will try to find a Portal at the PlayerMoveEvent.getTo() Location, and will try to create one if there is none.

If this is set to false, the PlayerEvent.getPlayer() will only be teleported to the PlayerMoveEvent.getTo() Location.

Parameters:
useTravelAgent - whether to use the Travel Agent

useTravelAgent

public boolean useTravelAgent()
Gets whether or not the Travel Agent will be used.

If this is set to true, the TravelAgent will try to find a Portal at the PlayerMoveEvent.getTo() Location, and will try to create one if there is none.

If this is set to false, the PlayerEvent.getPlayer()} will only be teleported to the PlayerMoveEvent.getTo() Location.

Returns:
whether to use the Travel Agent

getPortalTravelAgent

public TravelAgent getPortalTravelAgent()
Gets the Travel Agent used (or not) in this event.

Returns:
the Travel Agent used (or not) in this event

setPortalTravelAgent

public void setPortalTravelAgent(TravelAgent travelAgent)
Sets the Travel Agent used (or not) in this event.

Parameters:
travelAgent - the Travel Agent used (or not) in this event

getHandlers

public HandlerList getHandlers()
Overrides:
getHandlers in class PlayerTeleportEvent

getHandlerList

public static HandlerList getHandlerList()


Copyright © 2013. All Rights Reserved.