Package me.remigio07.chatplugin.api.common.player

Class OfflinePlayer

java.lang.Object

me.remigio07.chatplugin.api.common.player.OfflinePlayer

Direct Known Subclasses:

ChatPluginProxyPlayer, ChatPluginServerPlayer

public class OfflinePlayer
extends Object

Represents an offline player.

This object contains just two values: a UUID and a name. You can manually create offline players to interact with the plugin's code (for example with the punishment system) from an online player or just a UUID and a name. They may also be used to interact with the storage.

Note: "offline player" here has nothing to do with non-paid accounts, it simply indicates a player who may or may not be online at the moment.

See Also:

• ChatPluginPlayer
• PlayerAdapter

Constructor Summary

Constructors

Constructor	Description
OfflinePlayer(UUID uuid, String name)	Constructs an offline player using given UUID and name.
OfflinePlayer(PlayerAdapter player)	Constructs an offline player using a PlayerAdapter's UUID and name.
OfflinePlayer(CommandSenderAdapter sender)	Constructs an offline player using a CommandSenderAdapter's UUID and name.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Checks if another object is an instance of OfflinePlayer and if this player's getUUID() (if running on online mode) or getName() (if running on offline mode) value is equal to the other object's one.
static CompletableFuture<OfflinePlayer>	get(String name)	Gets an offline player, possibly from storage, based on the input: a name starting with PlayerManager.getFloodgateUsernamePrefix() for a Bedrock account any other name while ChatPlugin.isOnlineMode() for a paid Java account any other name while !ChatPlugin.isOnlineMode() for a non-paid Java account
static CompletableFuture<OfflinePlayer>	get(UUID uuid)	Gets an offline player, possibly from storage, based on the input: UUIDv0 for a Bedrock account UUIDv3 for a non-paid Java account UUIDv4 for a paid Java account
InetAddress	getIPAddress()	Gets this player's IP address.
String	getName()	Gets this player's name.
UUID	getUUID()	Gets this player's UUID.
int	hashCode()	Gets this player's hash code.
boolean	hasPermission(String permission)	Checks if this player has the specified permission.
boolean	hasPlayedBefore()	Checks if this player is contained in the DataContainer.PLAYERS data container using StorageConnector.isPlayerStored(OfflinePlayer).
boolean	isLoaded()	Checks if this player is loaded.
boolean	isOnline()	Checks if this player is online.
boolean	isPaidAccount()	Checks if this player corresponds to a paid Java or Bedrock account.
PlayerAdapter	toAdapter()	Gets this player's corresponding PlayerAdapter object.
ChatPluginProxyPlayer	toProxyPlayer()	Gets this player's corresponding ChatPluginProxyPlayer object.
ChatPluginServerPlayer	toServerPlayer()	Gets this player's corresponding ChatPluginServerPlayer object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OfflinePlayer

public OfflinePlayer(PlayerAdapter player)

Constructs an offline player using a PlayerAdapter's UUID and name.

Parameters:

player - Online player

OfflinePlayer

public OfflinePlayer(CommandSenderAdapter sender)

Constructs an offline player using a CommandSenderAdapter's UUID and name.

Parameters:

sender - Command sender

OfflinePlayer

public OfflinePlayer(UUID uuid,
 String name)

Constructs an offline player using given UUID and name.

Note: this constructor is not checked and you should use it only if you are sure that the specified UUID and name correspond to an existing account.

Parameters:

uuid - Player's UUID

name - Player's name

Method Details

isPaidAccount

public boolean isPaidAccount()

Checks if this player corresponds to a paid Java or Bedrock account.

Returns:

Whether this is a paid account

equals

public boolean equals(Object obj)

Checks if another object is an instance of OfflinePlayer and if this player's getUUID() (if running on online mode) or getName() (if running on offline mode) value is equal to the other object's one.

Overrides:

equals in class Object

Parameters:

obj - Object to compare

Returns:

Whether the two objects are equal

Throws:

IllegalStateException - If ChatPlugin.isOnlineMode() cannot be run yet

hashCode

public int hashCode()

Gets this player's hash code.

Will return getUUID()'s (if running on online mode) or getName()'s (if running on offline mode) hash code or -1 if the name is null.

Overrides:

hashCode in class Object

Returns:

Player's hash code

Throws:

IllegalStateException - If ChatPlugin.isOnlineMode() cannot be run yet

getUUID

public UUID getUUID()

Gets this player's UUID.

Returns:

Player's UUID

getName

public String getName()

Gets this player's name.

Returns:

Player's name

getIPAddress

public InetAddress getIPAddress()

Gets this player's IP address.

Will grab it from the storage if they are offline, but it will return null if they have never joined the server before.

Note: BungeeCord supports connections via Unix domain sockets. If this method is called on a player connected through a Unix domain socket, "127.0.0.1" is returned.

Returns:

Player's IP address

isOnline

public boolean isOnline()

Checks if this player is online.

Returns:

Whether this player is online

isLoaded

public boolean isLoaded()

Checks if this player is loaded.

Returns:

Whether this player is loaded

See Also:

• PlayerManager

hasPlayedBefore

public boolean hasPlayedBefore()

Checks if this player is contained in the DataContainer.PLAYERS data container using StorageConnector.isPlayerStored(OfflinePlayer).

Returns:

Whether this player has played before

hasPermission

public boolean hasPermission(String permission)

Checks if this player has the specified permission.

Will always return false unless isOnline() or a PermissionIntegration is enabled: in those cases, it will be actually checked.

Note: this method might take some time to be executed: async calls are recommended.

Parameters:

permission - Permission to check

Returns:

Whether this player has the permission

toAdapter

public PlayerAdapter toAdapter()

Gets this player's corresponding PlayerAdapter object.

Will return null if !isOnline().

Returns:

Corresponding PlayerAdapter

toServerPlayer

public ChatPluginServerPlayer toServerPlayer()

Gets this player's corresponding ChatPluginServerPlayer object.

Will return null if !isLoaded().

Returns:

Corresponding ChatPluginServerPlayer

Throws:

UnsupportedOperationException - If Environment.isProxy()

toProxyPlayer

public ChatPluginProxyPlayer toProxyPlayer()

Gets this player's corresponding ChatPluginProxyPlayer object.

Will return null if !isLoaded().

Returns:

Corresponding ChatPluginProxyPlayer

Throws:

UnsupportedOperationException - If !Environment.isProxy()

get

public static CompletableFuture<OfflinePlayer> get(String name)

Gets an offline player, possibly from storage, based on the input:

• a name starting with PlayerManager.getFloodgateUsernamePrefix() for a Bedrock account
• any other name while ChatPlugin.isOnlineMode() for a paid Java account
• any other name while !ChatPlugin.isOnlineMode() for a non-paid Java account

The future is instantly completed and will not throw any exception if:

• a player with the specified name is online
• specified name is not a Bedrock username and !ChatPlugin.isOnlineMode()

The future throws:

• SQLException if the storage lookup fails and StorageMethod.isDatabase()
• InterruptedException if the future is suddenly interrupted
• NoSuchElementException if the name does not belong to a paid Java (if ChatPlugin.isOnlineMode()) or Bedrock account
• IOException if a connection or JSON error occurs while fetching

Parameters:

name - Player's name, case insensitive

Returns:

New offline player

Throws:

IllegalArgumentException - If specified name !PlayerManager.isValidUsername(String)

get

public static CompletableFuture<OfflinePlayer> get(UUID uuid)

Gets an offline player, possibly from storage, based on the input:

• UUIDv0 for a Bedrock account
• UUIDv3 for a non-paid Java account
• UUIDv4 for a paid Java account

The future throws:

• UnsupportedOperationException if UUID.version() == 3 and no name is stored for the specified UUID
• SQLException if the storage lookup fails and StorageMethod.isDatabase()
• InterruptedException if the future is suddenly interrupted
• NoSuchElementException if UUID.version() != 3 and it does not belong to a paid Java or Bedrock account
• IOException if a connection or JSON error occurs while fetching

Parameters:

uuid - Player's UUID

Returns:

New offline player

Throws:

IllegalArgumentException - If UUID.version() is not 0, 3 or 4