org.cloudburstmc.server.player

Interface IPlayer

All Superinterfaces:

Metadatable, ServerOperator

All Known Implementing Classes:

OfflinePlayer, Player

public interface IPlayer
extends ServerOperator, Metadatable

Represents the data for a player, whether they are online or offline.

Method Summary

Modifier and Type	Method and Description
OptionalLong	getFirstPlayed() Returns the time this player first played on this server.
OptionalLong	getLastPlayed() Returns the time this player last joined in this server.
String	getName() Returns the name of this player.
Player	getPlayer() Returns a Player object that this represents.
Server	getServer() Returns the Server object carrying this player.
UUID	getServerId()
boolean	hasPlayedBefore() Checks if the player has played on this server before.
boolean	isBanned() Checks if this player is banned.
boolean	isOnline() Checks if this player is currently online.
boolean	isWhitelisted() Checks if this player is whitelisted.
void	setBanned(boolean value) Sets this player to be banned or to be pardoned.
void	setWhitelisted(boolean value) Adds or removes this player from the whitelist.

Methods inherited from interface org.cloudburstmc.server.permission.ServerOperator

isOp, setOp

Methods inherited from interface org.cloudburstmc.server.metadata.Metadatable

getMetadata, hasMetadata, removeMetadata, setMetadata

Method Detail

isOnline

boolean isOnline()

Checks if this player is currently online.

Returns:

true if they are online

getName

String getName()

Returns the name of this player.

Returns:

Player name

getServerId

UUID getServerId()

isBanned

boolean isBanned()

Checks if this player is banned.

Returns:

true if banned

setBanned

void setBanned(boolean value)

Sets this player to be banned or to be pardoned.

Parameters:

value - true if banned

isWhitelisted

boolean isWhitelisted()

Checks if this player is whitelisted.

Returns:

true if whitelisted

setWhitelisted

void setWhitelisted(boolean value)

Adds or removes this player from the whitelist.

Parameters:

value - true if whitelisted

getPlayer

Player getPlayer()

Returns a Player object that this represents. If the player is online, this will return that player. Otherwise, it will return null.

Returns:

Player

getServer

Server getServer()

Returns the Server object carrying this player.

Returns:

The server instance

getFirstPlayed

OptionalLong getFirstPlayed()

Returns the time this player first played 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:

An optional with the time this player first played on this server

getLastPlayed

OptionalLong getLastPlayed()

Returns the time this player last joined in 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:

An optional with the time this player last played on this server

hasPlayedBefore

boolean hasPlayedBefore()

Checks if the player has played on this server before.

Returns:

true if this player has played before