Package net.godlycow.org.essc.api.warp

Interface Warp

public interface Warp
A server warp. Get them from WarpManager. Setters only change the object, call WarpManager.updateWarp(Warp) to save.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCategory()
    Gets the category, null if none.
    double
    getCost()
    Gets the cost per use, 0 means free.
    String
    getDescription()
    Gets the description shown in lists and GUIs.
    org.bukkit.Location
    getLocation()
    Gets the warp location.
    String
    getName()
    Gets the warp name.
    String
    getPermission()
    Gets the permission needed to use it, null if open to all.
    boolean
    isHidden()
    Checks if the warp is hidden from public lists.
    void
    setCategory(String category)
    Sets the category, null to clear.
    void
    setCost(double cost)
    Sets the cost per use.
    void
    setDescription(String description)
    Sets the description.
    void
    setHidden(boolean hidden)
    Hides or unhides the warp.
    void
    setLocation(org.bukkit.Location location)
    Sets the warp location.
    void
    setPermission(String permission)
    Sets the permission, null to clear.

  • Method Details

    • getName

      String getName()
      Gets the warp name.
      Returns:
      the warp name

    • getLocation

      org.bukkit.Location getLocation()
      Gets the warp location.
      Returns:
      the location

    • setLocation

      void setLocation(org.bukkit.Location location)
      Sets the warp location.
      Parameters:
      location - the new location

    • getPermission

      String getPermission()
      Gets the permission needed to use it, null if open to all.
      Returns:
      the permission, or null

    • setPermission

      void setPermission(String permission)
      Sets the permission, null to clear.
      Parameters:
      permission - the permission, or null

    • getCost

      double getCost()
      Gets the cost per use, 0 means free.
      Returns:
      the cost

    • setCost

      void setCost(double cost)
      Sets the cost per use.
      Parameters:
      cost - the new cost

    • isHidden

      boolean isHidden()
      Checks if the warp is hidden from public lists.
      Returns:
      true if hidden

    • setHidden

      void setHidden(boolean hidden)
      Hides or unhides the warp.
      Parameters:
      hidden - true to hide

    • getDescription

      String getDescription()
      Gets the description shown in lists and GUIs.
      Returns:
      the description

    • setDescription

      void setDescription(String description)
      Sets the description.
      Parameters:
      description - the new description

    • getCategory

      String getCategory()
      Gets the category, null if none.
      Returns:
      the category, or null

    • setCategory

      void setCategory(String category)
      Sets the category, null to clear.
      Parameters:
      category - the new category, or null