Package org.bukkit

Interface OfflinePlayer

    • Method Detail

      • isOnline

        boolean isOnline()
        Checks if this player is currently online
        Returns:
        true if they are online

      • getName

        @Nullable
@Nullable String getName()
        Returns the name of this player

        Names are no longer unique past a single game session. For persistent storage it is recommended that you use getUniqueId() instead.

        Specified by:
        getName in interface AnimalTamer
        Returns:
        Player name or null if we have not seen a name for this player yet

      • getUniqueId

        @NotNull
@NotNull UUID getUniqueId()
        Returns the UUID of this player
        Specified by:
        getUniqueId in interface AnimalTamer
        Returns:
        Player UUID

      • isBanned

        boolean isBanned()
        Checks if this player is banned or not
        Returns:
        true if banned, otherwise false

      • isWhitelisted

        boolean isWhitelisted()
        Checks if this player is whitelisted or not
        Returns:
        true if whitelisted

      • setWhitelisted

        void setWhitelisted​(boolean value)
        Sets if this player is whitelisted or not
        Parameters:
        value - true if whitelisted

      • getPlayer

        @Nullable
@Nullable Player getPlayer()
        Gets a Player object that this represents, if there is one

        If the player is online, this will return that player. Otherwise, it will return null.

        Returns:
        Online player

      • getFirstPlayed

        long getFirstPlayed()
        Gets the first date and time that this player was witnessed on this server.

        If the player has never played before, this will return 0. Otherwise, it will be the amount of milliseconds since midnight, January 1, 1970 UTC.

        Returns:
        Date of first log-in for this player, or 0

      • getLastPlayed

        long getLastPlayed()
        Gets the last date and time that this player was witnessed on this server.

        If the player has never played before, this will return 0. Otherwise, it will be the amount of milliseconds since midnight, January 1, 1970 UTC.

        Returns:
        Date of last log-in for this player, or 0

      • hasPlayedBefore

        boolean hasPlayedBefore()
        Checks if this player has played on this server before.
        Returns:
        True if the player has played before, otherwise false

      • getBedSpawnLocation

        @Nullable
@Nullable Location getBedSpawnLocation()
        Gets the Location where the player will spawn at their bed, null if they have not slept in one or their current bed spawn is invalid.
        Returns:
        Bed Spawn Location if bed exists, otherwise null.

      • incrementStatistic

        void incrementStatistic​(@NotNull
                        @NotNull Statistic statistic)
                 throws IllegalArgumentException
        Increments the given statistic for this player.

        This is equivalent to the following code: incrementStatistic(Statistic, 1)

        Parameters:
        statistic - Statistic to increment
        Throws:
        IllegalArgumentException - if statistic is null
        IllegalArgumentException - if the statistic requires an additional parameter

      • decrementStatistic

        void decrementStatistic​(@NotNull
                        @NotNull Statistic statistic)
                 throws IllegalArgumentException
        Decrements the given statistic for this player.

        This is equivalent to the following code: decrementStatistic(Statistic, 1)

        Parameters:
        statistic - Statistic to decrement
        Throws:
        IllegalArgumentException - if statistic is null
        IllegalArgumentException - if the statistic requires an additional parameter

      • incrementStatistic

        void incrementStatistic​(@NotNull
                        @NotNull Statistic statistic,
                        @NotNull
                        @NotNull Material material)
                 throws IllegalArgumentException
        Increments the given statistic for this player for the given material.

        This is equivalent to the following code: incrementStatistic(Statistic, Material, 1)

        Parameters:
        statistic - Statistic to increment
        material - Material to offset the statistic with
        Throws:
        IllegalArgumentException - if statistic is null
        IllegalArgumentException - if material is null
        IllegalArgumentException - if the given parameter is not valid for the statistic

      • decrementStatistic

        void decrementStatistic​(@NotNull
                        @NotNull Statistic statistic,
                        @NotNull
                        @NotNull Material material)
                 throws IllegalArgumentException
        Decrements the given statistic for this player for the given material.

        This is equivalent to the following code: decrementStatistic(Statistic, Material, 1)

        Parameters:
        statistic - Statistic to decrement
        material - Material to offset the statistic with
        Throws:
        IllegalArgumentException - if statistic is null
        IllegalArgumentException - if material is null
        IllegalArgumentException - if the given parameter is not valid for the statistic

      • incrementStatistic

        void incrementStatistic​(@NotNull
                        @NotNull Statistic statistic,
                        @NotNull
                        @NotNull EntityType entityType)
                 throws IllegalArgumentException
        Increments the given statistic for this player for the given entity.

        This is equivalent to the following code: incrementStatistic(Statistic, EntityType, 1)

        Parameters:
        statistic - Statistic to increment
        entityType - EntityType to offset the statistic with
        Throws:
        IllegalArgumentException - if statistic is null
        IllegalArgumentException - if entityType is null
        IllegalArgumentException - if the given parameter is not valid for the statistic

      • decrementStatistic

        void decrementStatistic​(@NotNull
                        @NotNull Statistic statistic,
                        @NotNull
                        @NotNull EntityType entityType)
                 throws IllegalArgumentException
        Decrements the given statistic for this player for the given entity.

        This is equivalent to the following code: decrementStatistic(Statistic, EntityType, 1)

        Parameters:
        statistic - Statistic to decrement
        entityType - EntityType to offset the statistic with
        Throws:
        IllegalArgumentException - if statistic is null
        IllegalArgumentException - if entityType is null
        IllegalArgumentException - if the given parameter is not valid for the statistic

      • decrementStatistic

        void decrementStatistic​(@NotNull
                        @NotNull Statistic statistic,
                        @NotNull
                        @NotNull EntityType entityType,
                        int amount)
        Decrements the given statistic for this player for the given entity.
        Parameters:
        statistic - Statistic to decrement
        entityType - EntityType to offset the statistic with
        amount - Amount to decrement this statistic by
        Throws:
        IllegalArgumentException - if statistic is null
        IllegalArgumentException - if entityType is null
        IllegalArgumentException - if amount is negative
        IllegalArgumentException - if the given parameter is not valid for the statistic