org.bukkit

Interface OfflinePlayer

All Superinterfaces:

AnimalTamer, ConfigurationSerializable, ServerOperator

All Known Subinterfaces:

Player

public interface OfflinePlayer
extends ServerOperator, AnimalTamer, ConfigurationSerializable

Method Summary

Modifier and Type	Method and Description
default BanEntry	banPlayer(String reason) Permanently Bans this player from the server
default BanEntry	banPlayer(String reason, Date expires) Bans this player from the server
default BanEntry	banPlayer(String reason, Date expires, String source) Bans this player from the server
default BanEntry	banPlayer(String reason, Date expires, String source, boolean kickIfOnline)
default BanEntry	banPlayer(String reason, String source) Permanently Bans this player from the server
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.
long	getFirstPlayed() Gets the first date and time that this player was witnessed on this server.
long	getLastLogin() Gets the last date and time that this player logged into the server.
long	getLastPlayed() Deprecated. The API contract is ambiguous and the implementation may or may not return the correct value given this API ambiguity. It is instead recommended use getLastLogin() or getLastSeen() depending on your needs.
long	getLastSeen() Gets the last date and time that this player was seen on the server.
String	getName() Returns the name of this player
Player	getPlayer() Gets a Player object that this represents, if there is one
UUID	getUniqueId() Returns the UUID of this player
boolean	hasPlayedBefore() Checks if this player has played on this server before.
boolean	isBanned() Checks if this player is banned or not
boolean	isOnline() Checks if this player is currently online
boolean	isWhitelisted() Checks if this player is whitelisted or not
void	setWhitelisted(boolean value) Sets if this player is whitelisted or not

Methods inherited from interface org.bukkit.permissions.ServerOperator

isOp, setOp

Methods inherited from interface org.bukkit.configuration.serialization.ConfigurationSerializable

serialize

Method Detail

isOnline

boolean isOnline()

Checks if this player is currently online

Returns:

true if they are online

getName

@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
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

banPlayer

@NotNull
default BanEntry banPlayer(@Nullable
                                    String reason)

Permanently Bans this player from the server

Parameters:

reason - Reason for Ban

Returns:

Ban Entry

banPlayer

@NotNull
default BanEntry banPlayer(@Nullable
                                    String reason,
                                    @Nullable
                                    String source)

Permanently Bans this player from the server

Parameters:

reason - Reason for Ban

source - Source of the ban, or null for default

Returns:

Ban Entry

banPlayer

@NotNull
default BanEntry banPlayer(@Nullable
                                    String reason,
                                    @Nullable
                                    Date expires)

Bans this player from the server

Parameters:

reason - Reason for Ban

expires - When to expire the ban

Returns:

Ban Entry

banPlayer

@NotNull
default BanEntry banPlayer(@Nullable
                                    String reason,
                                    @Nullable
                                    Date expires,
                                    @Nullable
                                    String source)

Bans this player from the server

Parameters:

reason - Reason for Ban

expires - When to expire the ban

source - Source of the ban or null for default

Returns:

Ban Entry

banPlayer

@NotNull
default BanEntry banPlayer(@Nullable
                                    String reason,
                                    @Nullable
                                    Date expires,
                                    @Nullable
                                    String source,
                                    boolean kickIfOnline)

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
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

@Deprecated
long getLastPlayed()

Deprecated. The API contract is ambiguous and the implementation may or may not return the correct value given this API ambiguity. It is instead recommended use getLastLogin() or getLastSeen() depending on your needs.

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
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.

getLastLogin

long getLastLogin()

Gets the last date and time that this player logged into the 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:

last login time

getLastSeen

long getLastSeen()

Gets the last date and time that this player was seen on the server.

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

Returns:

last seen time