TF-EssentialsX/Essentials/src/com/earth2me/essentials/api/ITeleport.java

package com.earth2me.essentials.api;

import com.earth2me.essentials.IUser;
import com.earth2me.essentials.Trade;
import org.bukkit.Location;
import org.bukkit.entity.Player;
import org.bukkit.event.player.PlayerTeleportEvent.TeleportCause;


public interface ITeleport
{		
	/**
	 * Used to skip teleportPlayer delay when teleporting someone to a location or player.
	 *
	 * @param loc - Where should the player end up
	 * @param cooldown - If cooldown should be enforced
	 * @param cause - The reported teleportPlayer cause
	 * @throws Exception
	 */
	void now(Location loc, boolean cooldown, TeleportCause cause) throws Exception;

	/**
	 * Used to skip teleportPlayer delay when teleporting someone to a location or player.
	 *
	 * @param entity - Where should the player end up
	 * @param cooldown - If cooldown should be enforced
	 * @param cause - The reported teleportPlayer cause
	 * @throws Exception
	 */
	void now(Player entity, boolean cooldown, TeleportCause cause) throws Exception;

	@Deprecated
	void teleport(Location loc, Trade chargeFor) throws Exception;
	
	/**
	 * Teleport a player to a specific location
	 *
	 * @param loc - Where should the player end up
	 * @param chargeFor - What the user will be charged if teleportPlayer is successful
	 * @param cause - The reported teleportPlayer cause
	 * @throws Exception
	 */
	void teleport(Location loc, Trade chargeFor, TeleportCause cause) throws Exception;

	/**
	 * Teleport a player to a specific player
	 *
	 * @param entity - Where should the player end up
	 * @param chargeFor - What the user will be charged if teleportPlayer is successful
	 * @param cause - The reported teleportPlayer cause
	 * @throws Exception
	 */
	void teleport(Player entity, Trade chargeFor, TeleportCause cause) throws Exception;
	
		/**
	 * Teleport a player to a specific location
	 *
	 * @param otherUser - Which user will be teleported
	 * @param loc - Where should the player end up
	 * @param chargeFor - What the user will be charged if teleportPlayer is successful
	 * @param cause - The reported teleportPlayer cause
	 * @throws Exception
	 */
	void teleportPlayer(IUser otherUser, Location loc, Trade chargeFor, TeleportCause cause) throws Exception;

	/**
	 * Teleport a player to a specific player
	 *
	 * @param otherUser - Which user will be teleported
	 * @param entity - Where should the player end up
	 * @param chargeFor - What the user will be charged if teleportPlayer is successful
	 * @param cause - The reported teleportPlayer cause
	 * @throws Exception
	 */
	void teleportPlayer(IUser otherUser, Player entity, Trade chargeFor, TeleportCause cause) throws Exception;

	/**
	 * Teleport wrapper used to handle teleporting players to them, like /tphere
	 *
	 * @param otherUser - Which user will be teleported
	 * @param chargeFor - What the user will be charged if teleportPlayer is successful
	 * @param cause - The reported teleportPlayer cause
	 * @throws Exception
	 */
	public void teleportToMe(IUser otherUser, Trade chargeFor, TeleportCause cause) throws Exception;

	/**
	 * Teleport wrapper used to handle tp fallback on /jail and /home
	 *
	 * @param chargeFor - What the user will be charged if teleportPlayer is successful
	 * @param cause - The reported teleportPlayer cause
	 * @throws Exception
	 */
	public void respawn(final Trade chargeFor, TeleportCause cause) throws Exception;

	/**
	 * Teleport wrapper used to handle /warp teleports
	 *
	 * @param otherUser - Which user will be teleported
	 * @param warp - The name of the warp the user will be teleported too.
	 * @param chargeFor - What the user will be charged if teleportPlayer is successful
	 * @param cause - The reported teleportPlayer cause
	 * @throws Exception
	 */
	public void warp(IUser otherUser, String warp, Trade chargeFor, TeleportCause cause) throws Exception;

	/**
	 * Teleport wrapper used to handle /back teleports
	 *
	 * @param chargeFor - What the user will be charged if teleportPlayer is successful
	 * @throws Exception
	 */
	public void back(Trade chargeFor) throws Exception;

	/**
	 * Teleport wrapper used to handle throwing user home after a jail sentence
	 *
	 * @throws Exception
	 */
	public void back() throws Exception;

	/**
	 * Teleport wrapper used to handle /home teleports
	 *
	 * @param loc - Location where player will be teleported too
	 * @param chargeFor - What the user will be charged if teleportPlayer is successful
	 * @throws Exception
	 */
	public void home(Location loc, Trade chargeFor) throws Exception;
}