Package org.tan.api.interfaces

Interface TanPlayer

public interface TanPlayer

  • Method Details

    • getNameStored

      String getNameStored()
      Get the player name stored in the configuration. It is used to identify the player in menus and messages.
      Returns:
      The name stored in the configuration.

    • setNameStored

      void setNameStored(String name)
      Set the player name stored in the configuration.
      Parameters:
      name - The new name of the player.

    • getUUID

      UUID getUUID()
      Get the player UUID.
      Returns:
      The UUID of the player.

    • hasTown

      boolean hasTown()
      Returns:
      True if the player is part of a town, false otherwise.

    • getTown

      Optional<TanTown> getTown()
      Get the town the player is part of.
      Returns:
      The town the player is part of or Optional.empty() if the player is not part of a town.

    • hasRegion

      boolean hasRegion()
      Returns:
      True if the player is part of a region, false otherwise.

    • getRegion

      TanRegion getRegion()
      Get the region the player is part of.
      Returns:
      The region the player is part of or Optional.empty() if the player is not part of a region.

    • getPropertiesOwned

      Collection<TanProperty> getPropertiesOwned()
      Returns:
      A collection of all the properties owned by the player.

    • getPropertiesRented

      Collection<TanProperty> getPropertiesRented()
      Returns:
      A collection of all the properties rented by the player.

    • getPropertiesForSale

      Collection<TanProperty> getPropertiesForSale()
      Returns:
      A collection of all the properties owned by the player for sale.