Interface IPlayerManager

  • All Superinterfaces:
    IManager
    All Known Implementing Classes:
    PlayerManager

    public interface IPlayerManager
    extends IManager
    Manage all your players (AbstractPlayer) on the server. It is a singleton pattern class, which can be called anywhere. But it's better that you use the PlayerApi interface for easy management.
    Author:
    kong
    • Method Detail

      • count

        int count()
        Returns:
        the number of all current players' instance (include NPC or BOT)
      • countPlayers

        int countPlayers()
        Returns:
        the number of all current players that have connections (without NPC or BOT)
      • gets

        java.util.Map<java.lang.String,​AbstractPlayer> gets()
        Returns:
        all current players
      • clear

        void clear()
        Remove all players.
      • contain

        boolean contain​(java.lang.String name)
        Determine if the player has existed or not.
        Parameters:
        name - the player's name (unique ID)
        Returns:
        true if the player has existed, false otherwise
      • get

        AbstractPlayer get​(java.lang.String name)
        Retrieve a player by the player's name.
        Parameters:
        name - the player's name (unique ID)
        Returns:
        the player's instance if that player has existed, null otherwise
      • add

        void add​(AbstractPlayer player,
                 Connection connection)
        Add a new player to your server (this player was upgraded from one connection).
        Parameters:
        player - that is created from your server, see: AbstractPlayer
        connection - the main corresponding connection, see: Connection
      • add

        void add​(AbstractPlayer player)
        Add a new player to your server (this player is known as one NCP or a BOT) without a attached connection.
        Parameters:
        player - that is created from your server, see: AbstractPlayer
      • removeAllConnections

        void removeAllConnections​(AbstractPlayer player)
        When a player is disconnected, all the related connections need to be deleted too.
        Parameters:
        player - the corresponding player, see AbstractPlayer
      • clean

        void clean​(AbstractPlayer player)
        Make sure one player is removed from this management (as well as your server). It is used when you don't want your player can re-connect with any interruption's reason.
        Parameters:
        player - that is removed, see AbstractPlayer