org.bukkit.event.entity.EntityPortalEvent Maven / Gradle / Ivy

Go to download
package org.bukkit.event.entity;

import org.bukkit.Location;
import org.bukkit.TravelAgent;
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.
 * 
 * For players see {@link org.bukkit.event.player.PlayerPortalEvent}
 */
public class EntityPortalEvent extends EntityTeleportEvent {
  private static final HandlerList handlers = new HandlerList();
  protected boolean useTravelAgent = true;
  protected TravelAgent travelAgent;

  public EntityPortalEvent(final Entity entity, final Location from, final Location to, final TravelAgent pta) {
    super(entity, from, to);
    this.travelAgent = pta;
  }

  public static HandlerList getHandlerList() {
    return handlers;
  }

  /**
   * 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 {@link #getTo()} Location, and will try to create one if there is
   * none.
   * 

   * 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.
   * 

   * 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.
   * 
   * 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;
  }

  @Override
  public HandlerList getHandlers() {
    return handlers;
  }
}