Package com.github.rumsfield.konquest.api.manager

Interface KonquestPlaceholderManager

public interface KonquestPlaceholderManager
A manager for the Konquest placeholder expansion.

Konquest services PlaceholderAPI requests with these methods. When given an invalid input argument, the result will be an empty string "". Some requester methods are cached, and will only update their return value for the given input argument based on the Konquest configuration's minimum update time.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getBarbarian(org.bukkit.entity.Player player)
    Gets the player's current barbarian status.
    String
    getChat(org.bukkit.entity.Player player)
    Gets the status of the player's chat mode.
    String
    getClaimed(org.bukkit.entity.Player player)
    Gets the status of the chunk where the player is.
    String
    getCombat(org.bukkit.entity.Player player)
    Gets the status of the player's combat tag.
    String
    getCombatTag(org.bukkit.entity.Player player)
    Gets the combat tag string from the Konquest configuration.
    String
    getExile(org.bukkit.entity.Player player)
    Gets the player's current exile kingdom name.
    String
    getKingdom(org.bukkit.entity.Player player)
    Gets the player's current kingdom name.
    String
    getKingdomFavor(String name)
    Gets the total amount of favor owned by players in the given kingdom name.
    String
    getKingdomLand(String name)
    Gets the total number of land chunks in the given kingdom name.
    String
    getKingdomOnline(String name)
    Gets the current number of online players in the given kingdom name.
    String
    getKingdomPlayers(String name)
    Gets the total number of players in the given kingdom name.
    String
    getKingdomScore(String name)
    Gets the kingdom score of the given kingdom name.
    String
    getKingdomTowns(String name)
    Gets the total number of towns in the given kingdom name.
    String
    getLand(org.bukkit.entity.Player player)
    Gets the name of the territory that the player is currently in.
    String
    getLordships(org.bukkit.entity.Player player)
    Gets the number of towns in which the player is a lord.
    String
    getPrefix(org.bukkit.entity.Player player)
    Gets the current prefix of the player.
    String
    getRelation(org.bukkit.entity.Player playerOne, org.bukkit.entity.Player playerTwo)
    Gets the relationship type between the two players.
    String
    getRelationPrimaryColor(org.bukkit.entity.Player playerOne, org.bukkit.entity.Player playerTwo)
    Gets the primary relationship color between the two players.
    String
    getRelationSecondaryColor(org.bukkit.entity.Player playerOne, org.bukkit.entity.Player playerTwo)
    Gets the secondary relationship color between the two players.
    String
    getResidencies(org.bukkit.entity.Player player)
    Gets the number of towns in which the player is a resident, knight or lord.
    String
    getScore(org.bukkit.entity.Player player)
    Gets the current score of the player.
    String
    getTerritory(org.bukkit.entity.Player player)
    Gets the type of territory that the player is currently in.
    String
    getTopLand(int rank)
    Gets the kingdom name and total land, separated by a space, in the given rank of the leaderboard.
    String
    getTopScore(int rank)
    Gets the kingdom name and score value, separated by a space, in the given rank of the leaderboard.
    String
    getTopTown(int rank)
    Gets the kingdom name and number of towns, separated by a space, in the given rank of the leaderboard.
    String
    getTownsAll(org.bukkit.entity.Player player)
    Gets a comma-separated list of all towns in which the player is resident, knight or lord.
    String
    getTownsKnight(org.bukkit.entity.Player player)
    Gets a comma-separated list of the towns in which the player is a knight.
    String
    getTownsLord(org.bukkit.entity.Player player)
    Gets a comma-separated list of the towns in which the player is a lord.
    String
    getTownsResident(org.bukkit.entity.Player player)
    Gets a comma-separated list of the towns in which the player is a resident.

  • Method Details

    • getKingdom

      String getKingdom(org.bukkit.entity.Player player)
      Gets the player's current kingdom name.
      Parameters:
      player - The player
      Returns:
      The kingdom name, or an empty string when player is invalid

    • getExile

      String getExile(org.bukkit.entity.Player player)
      Gets the player's current exile kingdom name. This is the previously joined kingdom, or barbarians when the player is new.
      Parameters:
      player - The player
      Returns:
      The exile kingdom name, or an empty string when player is invalid

    • getBarbarian

      String getBarbarian(org.bukkit.entity.Player player)
      Gets the player's current barbarian status.
      Parameters:
      player - The player
      Returns:
      "True" if the player is barbarian, else "False", or an empty string when player is invalid

    • getTownsLord

      String getTownsLord(org.bukkit.entity.Player player)
      Gets a comma-separated list of the towns in which the player is a lord.
      Parameters:
      player - The player
      Returns:
      The list of town names, or an empty string when player is invalid

    • getTownsKnight

      String getTownsKnight(org.bukkit.entity.Player player)
      Gets a comma-separated list of the towns in which the player is a knight.
      Parameters:
      player - The player
      Returns:
      The list of town names, or an empty string when player is invalid

    • getTownsResident

      String getTownsResident(org.bukkit.entity.Player player)
      Gets a comma-separated list of the towns in which the player is a resident.
      Parameters:
      player - The player
      Returns:
      The list of town names, or an empty string when player is invalid

    • getTownsAll

      String getTownsAll(org.bukkit.entity.Player player)
      Gets a comma-separated list of all towns in which the player is resident, knight or lord.
      Parameters:
      player - The player
      Returns:
      The list of town names, or an empty string when player is invalid

    • getTerritory

      String getTerritory(org.bukkit.entity.Player player)
      Gets the type of territory that the player is currently in. This is the language file definition mapped to the KonquestTerritoryType enum.
      Parameters:
      player - The player
      Returns:
      The territory type, or an empty string when player is invalid

    • getLand

      String getLand(org.bukkit.entity.Player player)
      Gets the name of the territory that the player is currently in.
      Parameters:
      player - The player
      Returns:
      The territory name, or an empty string when player is invalid

    • getClaimed

      String getClaimed(org.bukkit.entity.Player player)
      Gets the status of the chunk where the player is.
      Parameters:
      player - The player
      Returns:
      "True" if the chunk is claimed, else "False", or an empty string when player is invalid

    • getScore

      String getScore(org.bukkit.entity.Player player)
      Gets the current score of the player.
      Parameters:
      player - The player
      Returns:
      The score value, or an empty string when player is invalid

    • getPrefix

      String getPrefix(org.bukkit.entity.Player player)
      Gets the current prefix of the player.
      Parameters:
      player - The player
      Returns:
      The prefix title, or an empty string when player is invalid

    • getLordships

      String getLordships(org.bukkit.entity.Player player)
      Gets the number of towns in which the player is a lord.
      Parameters:
      player - The player
      Returns:
      The number of towns, or an empty string when player is invalid

    • getResidencies

      String getResidencies(org.bukkit.entity.Player player)
      Gets the number of towns in which the player is a resident, knight or lord.
      Parameters:
      player - The player
      Returns:
      The number of towns, or an empty string when player is invalid

    • getChat

      String getChat(org.bukkit.entity.Player player)
      Gets the status of the player's chat mode.
      Parameters:
      player - The player
      Returns:
      "True" if the player is in global chat, else "False", or an empty string when player is invalid

    • getCombat

      String getCombat(org.bukkit.entity.Player player)
      Gets the status of the player's combat tag.
      Parameters:
      player - The player
      Returns:
      "True" if the player is combat tagged, else "False", or an empty string when player is invalid

    • getCombatTag

      String getCombatTag(org.bukkit.entity.Player player)
      Gets the combat tag string from the Konquest configuration.
      Parameters:
      player - The player
      Returns:
      The combat tag if the player is combat tagged, else an empty string, or an empty string when player is invalid

    • getRelation

      String getRelation(org.bukkit.entity.Player playerOne, org.bukkit.entity.Player playerTwo)
      Gets the relationship type between the two players. This is the language file definition of the following types:

      Friendly
      Enemy
      Barbarian
      Armistice

      Parameters:
      playerOne - The first player who is making the request
      playerTwo - The second player who is the context of the request
      Returns:
      The relationship between the two players, or an empty string when either player is invalid

    • getRelationPrimaryColor

      String getRelationPrimaryColor(org.bukkit.entity.Player playerOne, org.bukkit.entity.Player playerTwo)
      Gets the primary relationship color between the two players. These colors are defined in the Konquest configuration.
      Parameters:
      playerOne - The first player who is making the request
      playerTwo - The second player who is the context of the request
      Returns:
      The relationship color between the two players, or an empty string when either player is invalid

    • getRelationSecondaryColor

      String getRelationSecondaryColor(org.bukkit.entity.Player playerOne, org.bukkit.entity.Player playerTwo)
      Gets the secondary relationship color between the two players. These colors are defined in the Konquest configuration.
      Parameters:
      playerOne - The first player who is making the request
      playerTwo - The second player who is the context of the request
      Returns:
      The relationship color between the two players, or an empty string when either player is invalid

    • getTopScore

      String getTopScore(int rank)
      Gets the kingdom name and score value, separated by a space, in the given rank of the leaderboard. This method is cached.
      Parameters:
      rank - The kingdom rank, between 1 and the total number of kingdoms.
      Returns:
      The kingdom score value, or "---" when the rank is invalid.

    • getTopTown

      String getTopTown(int rank)
      Gets the kingdom name and number of towns, separated by a space, in the given rank of the leaderboard. This method is cached.
      Parameters:
      rank - The kingdom rank, between 1 and the total number of kingdoms.
      Returns:
      The number of towns, or "---" when the rank is invalid.

    • getTopLand

      String getTopLand(int rank)
      Gets the kingdom name and total land, separated by a space, in the given rank of the leaderboard. This method is cached.
      Parameters:
      rank - The kingdom rank, between 1 and the total number of kingdoms.
      Returns:
      The total number of land chunks, or "---" when the rank is invalid.

    • getKingdomPlayers

      String getKingdomPlayers(String name)
      Gets the total number of players in the given kingdom name. This method is cached.
      Parameters:
      name - The kingdom name
      Returns:
      The number of players, or an empty string when the kingdom name is invalid

    • getKingdomOnline

      String getKingdomOnline(String name)
      Gets the current number of online players in the given kingdom name. This method is cached.
      Parameters:
      name - The kingdom name
      Returns:
      The number of online players, or an empty string when the kingdom name is invalid

    • getKingdomTowns

      String getKingdomTowns(String name)
      Gets the total number of towns in the given kingdom name. This method is cached.
      Parameters:
      name - The kingdom name
      Returns:
      The number of towns, or an empty string when the kingdom name is invalid

    • getKingdomLand

      String getKingdomLand(String name)
      Gets the total number of land chunks in the given kingdom name. This method is cached.
      Parameters:
      name - The kingdom name
      Returns:
      The number of land chunks, or an empty string when the kingdom name is invalid

    • getKingdomFavor

      String getKingdomFavor(String name)
      Gets the total amount of favor owned by players in the given kingdom name. This method is cached.
      Parameters:
      name - The kingdom name
      Returns:
      The amount of favor, or an empty string when the kingdom name is invalid

    • getKingdomScore

      String getKingdomScore(String name)
      Gets the kingdom score of the given kingdom name. This method is cached.
      Parameters:
      name - The kingdom name
      Returns:
      The kingdom score, or an empty string when the kingdom name is invalid