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

Class PlayerManager

java.lang.Object

me.remigio07.chatplugin.api.common.player.PlayerManager

All Implemented Interfaces:

ChatPluginManager

Direct Known Subclasses:

ProxyPlayerManager, ServerPlayerManager

public abstract class PlayerManager
extends Object
implements ChatPluginManager

Manager that handles ChatPluginPlayers and OfflinePlayers.

See Also:

• ServerPlayerManager
• ProxyPlayerManager
• PlayerAdapter

Constructor Summary

Constructors

Constructor	Description
PlayerManager()

Method Summary

Modifier and Type	Method	Description
TimeZone	getDisplayedTimeZone()	Gets the time zone displayed to players in messages.
String	getFloodgateUsernamePrefix()	Gets the prefix added in front of Bedrock players' usernames to prevent duplicates.
static PlayerManager	getInstance()	Gets this manager's instance.
abstract ChatPluginPlayer	getPlayer(String name, boolean checkPattern, boolean ignoreCase)	Deprecated. Names should not be used to identify players.
abstract ChatPluginPlayer	getPlayer(UUID uuid)	Gets a player from getPlayers() by their UUID.
abstract Map<UUID,? extends ChatPluginPlayer>	getPlayers()	Gets the loaded ChatPluginPlayers' map.
abstract List<? extends ChatPluginPlayer>	getPlayers(InetAddress ipAddress)	Gets the list of loaded ChatPluginPlayers with the specified IP address.
List<InetAddress>	getPlayersIPs()	Gets the list of loaded players' IP addresses.
List<String>	getPlayersNames()	Gets the list of loaded players' names.
Pattern	getUsernamePattern()	Gets the pattern used to verify valid usernames.
boolean	isEnabled()	Checks if this manager is enabled.
boolean	isValidUsername(String username)	Checks if the specified String is a valid username.
void	load()	Loads (or reloads) this manager.
abstract void	loadOnlinePlayers()	Loads all online players in the network (if run on a proxy) or in an enabled world (if run on a server).
void	unload()	Unloads this manager.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface me.remigio07.chatplugin.api.common.util.manager.ChatPluginManager

checkAvailability, isReloadable, reload

Constructor Details

PlayerManager

public PlayerManager()

Method Details

load

public void load()
          throws ChatPluginManagerException

Description copied from interface: ChatPluginManager

Loads (or reloads) this manager.

Specified by:

load in interface ChatPluginManager

Throws:

ChatPluginManagerException - If something goes wrong

unload

public void unload()

Description copied from interface: ChatPluginManager

Unloads this manager.

Will do nothing if this method is not overridden.

Specified by:

unload in interface ChatPluginManager

isEnabled

public boolean isEnabled()

Description copied from interface: ChatPluginManager

Checks if this manager is enabled.

Specified by:

isEnabled in interface ChatPluginManager

Returns:

Whether this manager is enabled

getPlayersNames

public List<String> getPlayersNames()

Gets the list of loaded players' names.

Returns:

Enabled players' names

See Also:

• getPlayers()

getPlayersIPs

public List<InetAddress> getPlayersIPs()

Gets the list of loaded players' IP addresses.

Returns:

Enabled players' IPs

See Also:

• getPlayers()

getFloodgateUsernamePrefix

public String getFloodgateUsernamePrefix()

Gets the prefix added in front of Bedrock players' usernames to prevent duplicates.

This method retrieves the prefix using Floodgate's MultiPlatformIntegration.getUsernamePrefix() or from "settings.floodgate-username-prefix" in ConfigurationType.CONFIG depending on the current environment.

Returns:

Bedrock players' prefix

getUsernamePattern

public Pattern getUsernamePattern()

Gets the pattern used to verify valid usernames.

This will consider Bedrock players if Floodgate is installed or getFloodgateUsernamePrefix() depending on the current environment.

Returns:

Username's pattern

isValidUsername

public boolean isValidUsername(String username)

Checks if the specified String is a valid username.

Parameters:

username - Username to check

Returns:

Whether the specified username is valid

See Also:

• getUsernamePattern()

getDisplayedTimeZone

public TimeZone getDisplayedTimeZone()

Gets the time zone displayed to players in messages.

Found at: "settings.displayed-time-zone" in ConfigurationType.CONFIG

Returns:

Displayed time zone

getInstance

public static PlayerManager getInstance()

Gets this manager's instance.

Returns:

Manager's instance

getPlayers

public abstract Map<UUID,? extends ChatPluginPlayer> getPlayers()

Gets the loaded ChatPluginPlayers' map.

Do not modify the returned map.

Returns:

Loaded players' map

See Also:

• ServerPlayerManager.getPlayers()
• ProxyPlayerManager.getPlayers()

getPlayers

public abstract List<? extends ChatPluginPlayer> getPlayers(InetAddress ipAddress)

Gets the list of loaded ChatPluginPlayers with the specified IP address.

Parameters:

ipAddress - IP address to check

Returns:

Loaded players' map

See Also:

• ServerPlayerManager.getPlayers(InetAddress)
• ProxyPlayerManager.getPlayers(InetAddress)

getPlayer

public abstract ChatPluginPlayer getPlayer(UUID uuid)

Gets a player from getPlayers() by their UUID.

Will return null if the player is not loaded.

Parameters:

uuid - Player to get

Returns:

Loaded ChatPluginPlayer

See Also:

• ServerPlayerManager.getPlayer(UUID)
• ProxyPlayerManager.getPlayer(UUID)

getPlayer

@Deprecated
public abstract ChatPluginPlayer getPlayer(String name,
 boolean checkPattern,
 boolean ignoreCase)

Deprecated.

Names should not be used to identify players. Use getPlayer(UUID) instead.

Gets a player from getPlayers() by their name.

Will return null if the player is not loaded.

Parameters:

name - Player to get

checkPattern - Whether to check the name against getUsernamePattern()

ignoreCase - Whether to ignore case when checking online players

Returns:

Loaded ChatPluginPlayer

Throws:

IllegalArgumentException - If checkPattern and specified name !isValidUsername(String)

See Also:

• ServerPlayerManager.getPlayer(String, boolean, boolean)
• ProxyPlayerManager.getPlayer(String, boolean, boolean)

loadOnlinePlayers

public abstract void loadOnlinePlayers()

Loads all online players in the network (if run on a proxy) or in an enabled world (if run on a server).