Package net.godlycow.org.essc.api.home

Interface Home

public interface Home
A player's home. Read only, get them from HomeManager. Coords are stored raw so they stay valid if the world is unloaded, use toLocation(Server) to turn them into a real location.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getCreatedAt()
    Gets when the home was created, in millis.
    String
    getName()
    Gets the home name.
    UUID
    getOwner()
    Gets the owner.
    float
    getPitch()
    Gets the pitch.
    String
    getWorldName()
    Gets the world name.
    double
    getX()
    Gets the X coord.
    double
    getY()
    Gets the Y coord.
    float
    getYaw()
    Gets the yaw.
    double
    getZ()
    Gets the Z coord.
    org.bukkit.Location
    toLocation(org.bukkit.Server server)
    Turns the stored coords into a real location.

  • Method Details

    • getOwner

      UUID getOwner()
      Gets the owner.
      Returns:
      the owner UUID

    • getName

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

    • getWorldName

      String getWorldName()
      Gets the world name.
      Returns:
      the world name

    • getX

      double getX()
      Gets the X coord.
      Returns:
      x

    • getY

      double getY()
      Gets the Y coord.
      Returns:
      y

    • getZ

      double getZ()
      Gets the Z coord.
      Returns:
      z

    • getYaw

      float getYaw()
      Gets the yaw.
      Returns:
      yaw

    • getPitch

      float getPitch()
      Gets the pitch.
      Returns:
      pitch

    • getCreatedAt

      long getCreatedAt()
      Gets when the home was created, in millis.
      Returns:
      creation time in millis

    • toLocation

      org.bukkit.Location toLocation(org.bukkit.Server server)
      Turns the stored coords into a real location.
      Parameters:
      server - the server to resolve the world
      Returns:
      the location, or null if the world is not loaded