Package konquest.api.model

Interface KonquestTerritory

All Known Subinterfaces:
KonquestCamp, KonquestCapital, KonquestRuin, KonquestTown
public interface KonquestTerritory
The base interface for any territory.
Author:
Rumsfield

  • Method Summary

    Modifier and Type
    Method
    Description
    org.bukkit.Location
    getCenterLoc()
    Gets the center location of this territory.
    HashSet<Point>
    getChunkPoints()
    Gets the set of all land chunks claimed by this territory, as points.
    KonquestKingdom
    getKingdom()
    Gets the territory's kingdom.
    String
    getName()
    Gets the name of this territory.
    org.bukkit.Location
    getSpawnLoc()
    Gets the spawn location of this territory.
    KonquestTerritoryType
    getTerritoryType()
    Gets the territory type of this territory.
    org.bukkit.World
    getWorld()
    Gets the world of this territory.
    boolean
    isLocAdjacent(org.bukkit.Location loc)
    Checks whether the given location is outside of this territory but adjacent.
    boolean
    isLocInside(org.bukkit.Location loc)
    Checks whether the given location is inside of this territory.

  • Method Details

    • isLocInside

      boolean isLocInside(org.bukkit.Location loc)
      Checks whether the given location is inside of this territory.
      Parameters:
      loc - The location to check
      Returns:
      True when the location is inside, else false

    • isLocAdjacent

      boolean isLocAdjacent(org.bukkit.Location loc)
      Checks whether the given location is outside of this territory but adjacent. Adjacent here means bordering the 4 main cardinal directions: north, east south, west.
      Parameters:
      loc - The location to check
      Returns:
      True when the location is directly adjacent to this territory, else false

    • getCenterLoc

      org.bukkit.Location getCenterLoc()
      Gets the center location of this territory.
      Returns:
      The center location

    • getWorld

      org.bukkit.World getWorld()
      Gets the world of this territory.
      Returns:
      The territory's world

    • getSpawnLoc

      org.bukkit.Location getSpawnLoc()
      Gets the spawn location of this territory. Players who travel here will be teleported to this location.
      Returns:
      The spawn location

    • getName

      String getName()
      Gets the name of this territory.
      Returns:
      The name

    • getKingdom

      KonquestKingdom getKingdom()
      Gets the territory's kingdom.
      Returns:
      The kingdom object

    • getTerritoryType

      KonquestTerritoryType getTerritoryType()
      Gets the territory type of this territory. The type is an enum that's a convenience for determining sub-interfaces, like whether this territory is a town or a ruin.
      Returns:
      The territory type

    • getChunkPoints

      HashSet<Point> getChunkPoints()
      Gets the set of all land chunks claimed by this territory, as points. It is more efficient to work with points than Bukkit's Chunk objects.
      Returns:
      The set of claimed points