Package konquest.api.manager

Interface KonquestPlayerManager

public interface KonquestPlayerManager
A manager for players in Konquest.
Author:
Rumsfield

  • Method Details

    • getPlayer

      KonquestPlayer getPlayer(org.bukkit.entity.Player bukkitPlayer)
      Gets a Konquest player object from the given Bukkit Player.
      Parameters:
      bukkitPlayer - The player to look up
      Returns:
      The Konquest player if one exists, else null

    • isOnlinePlayer

      boolean isOnlinePlayer(org.bukkit.entity.Player bukkitPlayer)
      Checks whether a player is currently online and represented in Konquest.
      Parameters:
      bukkitPlayer - The player to check
      Returns:
      True when the player is online and has a KonquestPlayer object, else false

    • getOfflinePlayer

      KonquestOfflinePlayer getOfflinePlayer(org.bukkit.OfflinePlayer offlineBukkitPlayer)
      Gets a Konquest offline player object from the given Bukkit OfflinePlayer.
      Parameters:
      offlineBukkitPlayer - The offline player to look up
      Returns:
      The Konquest offline player if one exists, else null

    • isOfflinePlayer

      boolean isOfflinePlayer(org.bukkit.OfflinePlayer offlineBukkitPlayer)
      Checks whether a player exists and is represented in Konquest. This can be used to check if a player has ever joined the server and is present in the Konquest player database.
      Parameters:
      offlineBukkitPlayer - The player to check
      Returns:
      True when the player exists and has a KonquestOfflinePlayer object, else false

    • isPlayerNameExist

      boolean isPlayerNameExist(String name)
      Checks whether a player name exists and is represented in Konquest.
      Parameters:
      name - The player's name
      Returns:
      True if there is a player with a matching name in the Konquest player database, else false

    • getPlayerFromName

      KonquestPlayer getPlayerFromName(String displayName)
      Gets a Konquest player object from the given name.
      Parameters:
      displayName - The player name to look up
      Returns:
      The Konquest player if one exists, else null

    • getOfflinePlayerFromName

      KonquestOfflinePlayer getOfflinePlayerFromName(String displayName)
      Gets a Konquest offline player object from the given name.
      Parameters:
      displayName - The player name to look up
      Returns:
      The Konquest offline player if one exists, else null

    • getPlayerFromID

      KonquestPlayer getPlayerFromID(UUID id)
      Gets a Konquest player object from the given UUID.
      Parameters:
      id - The player UUID to look up
      Returns:
      The Konquest player if one exists, else null

    • getOfflinePlayerFromID

      KonquestOfflinePlayer getOfflinePlayerFromID(UUID id)
      Gets a Konquest offline player object from the given UUID.
      Parameters:
      id - The player UUID to look up
      Returns:
      The Konquest offline player if one exists, else null

    • getAllOfflinePlayers

      Collection<org.bukkit.OfflinePlayer> getAllOfflinePlayers()
      Gets all of Bukkit's OfflinePlayers from the Konquest player database. This is a collection of every player that has joined the server.
      Returns:
      The collection of players

    • getAllKonquestOfflinePlayers

      Collection<? extends KonquestOfflinePlayer> getAllKonquestOfflinePlayers()
      Gets all of Konquest's OfflinePlayers from the Konquest player database. This is a collection of every player that has joined the server.
      Returns:
      The collection of players

    • getPlayersInKingdom

      ArrayList<? extends KonquestPlayer> getPlayersInKingdom(String kingdomName)
      Gets the players currently online that are members of the given kingdom name.
      Parameters:
      kingdomName - The kingdom name, ignoring case
      Returns:
      The list of online players in the given kingdom

    • getPlayersInKingdom

      ArrayList<? extends KonquestPlayer> getPlayersInKingdom(KonquestKingdom kingdom)
      Gets the players currently online that are members of the given kingdom object.
      Parameters:
      kingdom - The kingdom instance
      Returns:
      The list of online players in the given kingdom

    • getBukkitPlayersInKingdom

      Collection<org.bukkit.entity.Player> getBukkitPlayersInKingdom(String kingdomName)
      Gets the Bukkit players currently online that are members of the given kingdom name.
      Parameters:
      kingdomName - The kingdom name, ignoring case
      Returns:
      The list of online players in the given kingdom

    • getBukkitPlayersInKingdom

      Collection<org.bukkit.entity.Player> getBukkitPlayersInKingdom(KonquestKingdom kingdom)
      Gets the Bukkit players currently online that are members of the given kingdom object.
      Parameters:
      kingdom - The kingdom instance
      Returns:
      The list of online players in the given kingdom

    • getPlayerNamesInKingdom

      ArrayList<String> getPlayerNamesInKingdom(String kingdomName)
      Gets the names of players currently online that are members of the given kingdom name. This is a convenience method.
      Parameters:
      kingdomName - The kingdom name, ignoring case
      Returns:
      The list of player names in the given kingdom

    • getAllPlayersInKingdom

      ArrayList<? extends KonquestOfflinePlayer> getAllPlayersInKingdom(String kingdomName)
      Gets all of the players that are members of the given kingdom name.
      Parameters:
      kingdomName - The kingdom name, ignoring case
      Returns:
      The list of players in the given kingdom

    • getAllPlayersInKingdom

      ArrayList<? extends KonquestOfflinePlayer> getAllPlayersInKingdom(KonquestKingdom kingdom)
      Gets all of the players that are members of the given kingdom object.
      Parameters:
      kingdom - The kingdom instance
      Returns:
      The list of players in the given kingdom

    • getAllBukkitPlayersInKingdom

      Collection<org.bukkit.OfflinePlayer> getAllBukkitPlayersInKingdom(String kingdomName)
      Gets all of the Bukkit players that are members of the given kingdom name.
      Parameters:
      kingdomName - The kingdom name, ignoring case
      Returns:
      The list of players in the given kingdom

    • getAllBukkitPlayersInKingdom

      Collection<org.bukkit.OfflinePlayer> getAllBukkitPlayersInKingdom(KonquestKingdom kingdom)
      Gets all of the Bukkit players that are members of the given kingdom object.
      Parameters:
      kingdom - The kingdom instance
      Returns:
      The list of players in the given kingdom

    • getPlayersOnline

      Collection<? extends KonquestPlayer> getPlayersOnline()
      Gets all of Konquest's players that are currently online.
      Returns:
      The collection of players

    • getBukkitPlayersOnline

      Collection<org.bukkit.entity.Player> getBukkitPlayersOnline()
      Gets all Bukkit players that are currently online.
      Returns:
      The collection of players