Package org.tan.api.getters

Interface TanLandmarkManager

public interface TanLandmarkManager
The TanLandmarkManager interface provides methods for accessing and managing landmarks within the application. It allows retrieval of landmarks by their names or UUIDs, and provides a collection of all landmarks. Additionally, it supports the creation of new landmarks using coordinates or locations. This interface is essential for handling landmark-related operations and ensuring proper management of landmark data.

  • Method Summary

    Modifier and Type
    Method
    Description
    TanLandmark
    createLandmark(double x, double y, double z, String worldName)
    Create a new landmark
    The landmark will be saved to the configuration and can be accessible from the API
    TanLandmark
    createLandmark(double x, double y, double z, UUID worldUUID)
    Create a new landmark
    The landmark will be saved to the configuration and can be accessible from the API
    TanLandmark
    createLandmark(org.bukkit.Location location)
    Create a new landmark
    The landmark will be saved to the configuration and can be accessible from the API
    Optional<TanLandmark>
    getLandmark(String name)
    Get a landmark by name
    It is recommended to use the UUID instead of the name in case duplicate names are allowed in the configuration
    TanLandmark
    getLandmark(UUID id)
    Get a landmark by UUID
    Collection<TanLandmark>
    getLandmarks()
    Get all landmarks

  • Method Details

    • getLandmarks

      Collection<TanLandmark> getLandmarks()
      Get all landmarks
      Returns:
      a Collection of all TanLandmark

    • getLandmark

      Optional<TanLandmark> getLandmark(String name)
      Get a landmark by name
      It is recommended to use the UUID instead of the name in case duplicate names are allowed in the configuration
      Parameters:
      name - the name of the landmark
      Returns:
      the TanLandmark with the specified name, or Optional.empty() if not found.

    • getLandmark

      TanLandmark getLandmark(UUID id)
      Get a landmark by UUID
      Parameters:
      id - the UUID of the landmark
      Returns:
      the TanLandmark with the specified UUID, or Optional.empty() if not found.

    • createLandmark

      TanLandmark createLandmark(double x, double y, double z, UUID worldUUID)
      Create a new landmark
      The landmark will be saved to the configuration and can be accessible from the API
      Parameters:
      x - the x coordinate
      y - the y coordinate
      z - the z coordinate
      worldUUID - the UUID of the world
      Returns:
      the created TanLandmark

    • createLandmark

      TanLandmark createLandmark(double x, double y, double z, String worldName)
      Create a new landmark
      The landmark will be saved to the configuration and can be accessible from the API
      Parameters:
      x - the x coordinate
      y - the y coordinate
      z - the z coordinate
      worldName - the name of the world
      Returns:
      the created TanLandmark

    • createLandmark

      TanLandmark createLandmark(org.bukkit.Location location)
      Create a new landmark
      The landmark will be saved to the configuration and can be accessible from the API
      Parameters:
      location - the location of the landmark
      Returns:
      the created TanLandmark