Class PlayerManager

java.lang.Object
de.Keyle.MyPet.api.repository.PlayerManager

public abstract class PlayerManager extends Object
Manages the online MyPetPlayer cache. Tracks which players are known to the MyPet system and provides lookup by UUID, Bukkit Player, or name. The concrete implementation in the plugin module handles persistence (load/save to the repository) and login/ logout lifecycle.

The cache is thread-safe (ConcurrentHashMap), but most mutations should occur on the main/entity thread.

  • Field Details

    • onlinePlayers

      protected final Map<UUID,MyPetPlayer> onlinePlayers
      The online players MyPet is tracking, keyed by Mojang UUID.
  • Constructor Details

    • PlayerManager

      public PlayerManager()
      Creates a manager. MyPet supplies the implementation; addons reach it through the API.
  • Method Details

    • getMyPetPlayer

      public MyPetPlayer getMyPetPlayer(UUID playerUUID)
      Returns the cached MyPetPlayer for the given UUID, or null if the player is not online or not registered.
      Parameters:
      playerUUID - the player's Mojang UUID
      Returns:
      the tracked player, or null if they are not online
    • getMyPetPlayer

      public MyPetPlayer getMyPetPlayer(Player player)
      Returns the cached MyPetPlayer for the given Bukkit player, or null if not registered.
      Parameters:
      player - the Bukkit player
      Returns:
      the tracked player
    • getMyPetPlayer

      public MyPetPlayer getMyPetPlayer(String name)
      Looks up a MyPetPlayer by display name. Returns null if the player is not online or not registered.
      Parameters:
      name - the player's name
      Returns:
      the tracked player, or null if they are not online
    • setOnline

      public void setOnline(MyPetPlayer player)
      Adds a player to the online cache. Called on join after loading.
      Parameters:
      player - the player who came online
    • setOffline

      public abstract void setOffline(MyPetPlayer player)
      Removes a player from the online cache and persists their data.
      Parameters:
      player - the player who went offline
    • createMyPetPlayer

      public abstract MyPetPlayer createMyPetPlayer(Player player)
      Creates a new MyPetPlayer instance for a Bukkit player without persisting it. Used during the first-time registration flow.
      Parameters:
      player - the Bukkit player
      Returns:
      a newly created tracked player
    • isMyPetPlayer

      public boolean isMyPetPlayer(String name)
      Returns true if an online player with this name is registered.
      Parameters:
      name - the player's name
      Returns:
      true if MyPet is tracking that player
    • isMyPetPlayer

      public boolean isMyPetPlayer(Player player)
      Returns true if this Bukkit player is in the online cache.
      Parameters:
      player - the Bukkit player
      Returns:
      true if MyPet is tracking that player
    • getMyPetPlayers

      public MyPetPlayer[] getMyPetPlayers()
      Returns a snapshot array of all currently online MyPetPlayers.
      Returns:
      every player MyPet is currently tracking
    • registerMyPetPlayer

      public abstract MyPetPlayer registerMyPetPlayer(Player player)
      Loads or creates a MyPetPlayer for the given Bukkit player and adds them to the online cache. Called during the login sequence.
      Parameters:
      player - the Bukkit player
      Returns:
      the tracked player, created if this is their first join