org.bukkit.event.entity
Class EntityPortalEvent

java.lang.Object
  extended by org.bukkit.event.Event
      extended by org.bukkit.event.entity.EntityEvent
          extended by org.bukkit.event.entity.EntityTeleportEvent
              extended by org.bukkit.event.entity.EntityPortalEvent
All Implemented Interfaces:
Cancellable

public class EntityPortalEvent
extends EntityTeleportEvent

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

For players see PlayerPortalEvent


Nested Class Summary
 
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.entity.EntityEvent
entity
 
Constructor Summary
EntityPortalEvent(Entity entity, Location from, Location to, TravelAgent pta)
           
 
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.entity.EntityTeleportEvent
getFrom, getTo, isCancelled, setCancelled, setFrom, setTo
 
Methods inherited from class org.bukkit.event.entity.EntityEvent
getEntity, getEntityType
 
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

EntityPortalEvent

public EntityPortalEvent(Entity entity,
                         Location from,
                         Location to,
                         TravelAgent pta)
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 EntityTeleportEvent.getTo() Location, and will try to create one if there is none.

If this is set to false, the EntityEvent.getEntity() will only be teleported to the EntityTeleportEvent.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 EntityTeleportEvent.getTo() Location, and will try to create one if there is none.

If this is set to false, the EntityEvent.getEntity() will only be teleported to the EntityTeleportEvent.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 EntityTeleportEvent

getHandlerList

public static HandlerList getHandlerList()


Copyright © 2013. All Rights Reserved.