Interface Warp

All Known Implementing Classes:
WarpManager, WarpSQLManager, WarpYMLManager
public interface Warp
The interface Warp.

  • Method Details

    • addWarp

      boolean addWarp(String name, String creatorName, UUID creatorUUID, org.bukkit.Material icon, List<String> lores, boolean isPublic, Set<UUID> allowedPlayers, double cost, String permission, Timestamp expirationDate, Timestamp creationDate, org.bukkit.Location location)
      Add warp boolean.
      Parameters:
      name - the name
      creatorName - the creator name
      creatorUUID - the creator uuid
      icon - the icon
      lores - the lores
      isPublic - the is public
      allowedPlayers - the allowed players
      cost - the cost
      permission - the permission
      expirationDate - the expiration date
      creationDate - the creation date
      location - the location
      Returns:
      the boolean

    • addWarp

      boolean addWarp(String serializedData)
      Parse and add a warp from serialized data (e.g. from a file/DB). The exact format is implementation-dependent.
      Parameters:
      serializedData - the serialized data
      Returns:
      the boolean

    • addWarp

      boolean addWarp(WarpData warpData)
      Add warp boolean.
      Parameters:
      warpData - the warp data
      Returns:
      the boolean

    • deleteWarp

      boolean deleteWarp(String name)
      Delete warp boolean.
      Parameters:
      name - the name
      Returns:
      the boolean

    • deleteWarp

      boolean deleteWarp(WarpData warpData)
      Delete warp boolean.
      Parameters:
      warpData - the warp data
      Returns:
      the boolean

    • renameWarp

      boolean renameWarp(String oldName, String newName)
      Rename warp boolean.
      Parameters:
      oldName - the old name
      newName - the new name
      Returns:
      the boolean

    • renameWarp

      boolean renameWarp(WarpData warpData, String newName)
      Rename warp boolean.
      Parameters:
      warpData - the warp data
      newName - the new name
      Returns:
      the boolean

    • relocateWarp

      boolean relocateWarp(String name, org.bukkit.Location newLocation)
      Relocate warp boolean.
      Parameters:
      name - the name
      newLocation - the new location
      Returns:
      the boolean

    • relocateWarp

      boolean relocateWarp(WarpData warpData, org.bukkit.Location newLocation)
      Relocate warp boolean.
      Parameters:
      warpData - the warp data
      newLocation - the new location
      Returns:
      the boolean

    • setWarpIcon

      boolean setWarpIcon(String name, org.bukkit.Material newIcon)
      Sets warp icon.
      Parameters:
      name - the name
      newIcon - the new icon
      Returns:
      the warp icon

    • setWarpIcon

      boolean setWarpIcon(WarpData warpData, org.bukkit.Material newIcon)
      Sets warp icon.
      Parameters:
      warpData - the warp data
      newIcon - the new icon
      Returns:
      the warp icon

    • setWarpLores

      boolean setWarpLores(String serializedData, List<String> newLores)
      Sets warp lores.
      Parameters:
      serializedData - the serialized data
      newLores - the new lores
      Returns:
      the warp lores

    • setWarpLores

      boolean setWarpLores(WarpData warpData, List<String> newLores)
      Sets warp lores.
      Parameters:
      warpData - the warp data
      newLores - the new lores
      Returns:
      the warp lores

    • setWarpPublic

      boolean setWarpPublic(String name, boolean isPublic)
      Sets warp public.
      Parameters:
      name - the name
      isPublic - the is public
      Returns:
      the warp public

    • setWarpPublic

      boolean setWarpPublic(WarpData warpData, boolean isPublic)
      Sets warp public.
      Parameters:
      warpData - the warp data
      isPublic - the is public
      Returns:
      the warp public

    • setDeniedPlayers

      boolean setDeniedPlayers(String name, Set<UUID> deniedPlayers)

    • setDeniedPlayers

      boolean setDeniedPlayers(WarpData warpData, Set<UUID> deniedPlayers)

    • setWarpCost

      boolean setWarpCost(String name, double cost)
      Sets warp cost.
      Parameters:
      name - the name
      cost - the cost
      Returns:
      the warp cost

    • setWarpCost

      boolean setWarpCost(WarpData warpData, double cost)
      Sets warp cost.
      Parameters:
      warpData - the warp data
      cost - the cost
      Returns:
      the warp cost

    • setWarpPermission

      boolean setWarpPermission(String name, String permission)
      Sets warp permission.
      Parameters:
      name - the name
      permission - the permission
      Returns:
      the warp permission

    • setWarpPermission

      boolean setWarpPermission(WarpData warpData, String permission)
      Sets warp permission.
      Parameters:
      warpData - the warp data
      permission - the permission
      Returns:
      the warp permission

    • setWarpExpirationDate

      boolean setWarpExpirationDate(String name, Timestamp expirationDate)
      Sets warp expiration date.
      Parameters:
      name - the name
      expirationDate - the expiration date
      Returns:
      the warp expiration date

    • setWarpExpirationDate

      boolean setWarpExpirationDate(WarpData warpData, Timestamp expirationDate)
      Sets warp expiration date.
      Parameters:
      warpData - the warp data
      expirationDate - the expiration date
      Returns:
      the warp expiration date

    • warpExists

      boolean warpExists(String name)
      Warp exists boolean.
      Parameters:
      name - the name
      Returns:
      the boolean

    • warpExists

      boolean warpExists(WarpData warpData)
      Warp exists boolean.
      Parameters:
      warpData - the warp data
      Returns:
      the boolean

    • getWarp

      WarpData getWarp(String name)
      Get full warp data object by name, or null if not found.
      Parameters:
      name - the name
      Returns:
      the warp

    • getAllWarps

      Map<String,WarpData> getAllWarps()
      Get a map of all warps by name.
      Returns:
      the all warps

    • getWarpNames

      Set<String> getWarpNames()
      Convenience: list only the names of all warps.
      Returns:
      the warp names

    • isExpired

      boolean isExpired(String name)

    • isExpired

      boolean isExpired(WarpData warpData)