Package com.earth2me.essentials.api

Interface IWarps

All Superinterfaces:
IConf
All Known Subinterfaces:
IWarps
All Known Implementing Classes:
Warps
@Deprecated public interface IWarps extends IConf
Deprecated.
External plugins should use IWarps instead of this interface, in case future APIs are added.
Provides access to the storage of warp locations. Maintainers should add methods to this interface.

  • Method Details

    • getWarp

      Location getWarp(String warp) throws WarpNotFoundException, InvalidWorldException
      Deprecated.
      Get a warp by name
      Parameters:
      warp - - Warp name
      Returns:
      - Location the warp is set to
      Throws:
      WarpNotFoundException - When the warp is not found
      InvalidWorldException - When the world the warp is in is not found

    • isWarp

      boolean isWarp(String name)
      Deprecated.
      Checks if the provided name is a warp.
      Parameters:
      name - The warp name.
      Returns:
      true if a warp by that name exists.

    • getList

      Collection<String> getList()
      Deprecated.
      Gets a list of warps
      Returns:
      - A Collection of warps

    • getCount

      int getCount()
      Deprecated.
      Gets the number of warps
      Returns:
      the size of the list of warps

    • removeWarp

      void removeWarp(String name) throws Exception
      Deprecated.
      Delete a warp from the warp DB
      Parameters:
      name - - Name of warp
      Throws:
      Exception - If the warp could not be removed

    • setWarp

      void setWarp(String name, Location loc) throws Exception
      Deprecated.
      Set a warp
      Parameters:
      name - - Name of warp
      loc - - Location of warp
      Throws:
      Exception - If the warp could not be set

    • setWarp

      void setWarp(IUser user, String name, Location loc) throws Exception
      Deprecated.
      Set a warp
      Parameters:
      user - - User of warp
      name - - Name of warp
      loc - - Location of warp
      Throws:
      Exception - If the warp could not be set

    • getLastOwner

      UUID getLastOwner(String warp) throws WarpNotFoundException
      Deprecated.
      Gets Lastowner UUID
      Parameters:
      warp - - Name of warp
      Throws:
      WarpNotFoundException - If the warp is not found

    • isEmpty

      boolean isEmpty()
      Deprecated.
      Check to see if the file is empty
      Returns:
      Whether or not the file is empty

    • getWarpFile

      @Deprecated File getWarpFile(String name) throws InvalidNameException
      Deprecated.
      This method relates to the abandoned 3.x storage refactor and is not implemented.
      Throws:
      InvalidNameException