Package com.github.rumsfield.konquest.api.model

Interface KonquestMonument

public interface KonquestMonument
A monument structure within a town.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getBaseY()
    Gets the bottom Y coordinate of this monument in the world.
    int
    getCriticalHits()
    Gets the number of critical hits that this monument has.
    int
    getHeight()
    Gets the height in blocks of this monument.
    org.bukkit.Location
    getTravelPoint()
    Gets the travel location within the monument.
    boolean
    isLocInside(org.bukkit.Location loc)
    Checks whether the given location is inside of this monument.
    boolean
    isValid()
    Checks whether this monument is valid.

  • Method Details

    • isValid

      boolean isValid()
      Checks whether this monument is valid. A monument is valid when it is copied from a valid monument template.
      Returns:
      True when the monument is valid, else false

    • getTravelPoint

      org.bukkit.Location getTravelPoint()
      Gets the travel location within the monument. Players that travel to the town with this monument will be teleported here.
      Returns:
      The travel location

    • getBaseY

      int getBaseY()
      Gets the bottom Y coordinate of this monument in the world. Defaults to the Y value of the town's center location.
      Returns:
      The Y coordinate of the base of this monument

    • getHeight

      int getHeight()
      Gets the height in blocks of this monument.
      Returns:
      The height

    • isLocInside

      boolean isLocInside(org.bukkit.Location loc)
      Checks whether the given location is inside of this monument. A monument occupies only a portion of the Y axis within a chunk, so this method is useful to determine whether a location is actually inside the monument structure.
      Parameters:
      loc - The location to check
      Returns:
      True when the location is inside the monument, else false

    • getCriticalHits

      int getCriticalHits()
      Gets the number of critical hits that this monument has. Each critical hit represents a broken critical block inside the monument structure. When there are as many critical hits as max, the town is captured. When the town is no longer under attack, the monument will regenerate and clear the critical hits.
      Returns:
      The number of critical hits