Package me.remigio07.chatplugin.api.server.player

Class ServerPlayerManager

java.lang.Object

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

me.remigio07.chatplugin.api.server.player.ServerPlayerManager

All Implemented Interfaces:

ChatPluginManager

public abstract class ServerPlayerManager
extends PlayerManager

Manager that handles ChatPluginServerPlayers and enabled worlds.

Constructor Summary

Constructors

Constructor	Description
ServerPlayerManager()

Method Summary

Modifier and Type	Method	Description
static List<UUID>	getBedrockPlayers()	Gets the online Bedrock players' UUIDs.
List<String>	getEnabledWorlds()	Gets the list of the enabled worlds.
static ServerPlayerManager	getInstance()	Gets this manager's instance.
ChatPluginServerPlayer	getPlayer(String name, boolean checkPattern, boolean ignoreCase)	Deprecated. Names should not be used to identify players.
ChatPluginServerPlayer	getPlayer(UUID uuid)	Gets a player from getPlayers() by their UUID.
static Long	getPlayerLoginTime(UUID player)	Gets an online player's login time.
Map<UUID,ChatPluginServerPlayer>	getPlayers()	Gets the loaded ChatPluginServerPlayers' map.
List<ChatPluginServerPlayer>	getPlayers(InetAddress ipAddress)	Gets the list of loaded ChatPluginServerPlayers with the specified IP address.
static Map<UUID,Long>	getPlayersLoginTimes()	Gets the online players' login times.
static Map<UUID,VersionUtils.Version>	getPlayersVersions()	Gets the online players' versions.
static VersionUtils.Version	getPlayerVersion(UUID player)	Gets an online player's version.
int	getStorageCount()	Gets the total amount of players stored in the storage.
static boolean	isBedrockPlayer(UUID player)	Checks if the specified player is connected through a MultiPlatformIntegration.
boolean	isWorldEnabled(String world)	Checks if a world is contained in the enabled worlds' list.
void	load()	Loads (or reloads) this manager.
abstract int	loadPlayer(PlayerAdapter player)	Adds a player to getPlayers().
void	setStorageCount(int storageCount)	Sets the amount of players stored in the storage.
void	unload()	Unloads this manager.
abstract int	unloadPlayer(UUID player)	Removes a player from getPlayers().

Methods inherited from class me.remigio07.chatplugin.api.common.player.PlayerManager

getDisplayedTimeZone, getFloodgateUsernamePrefix, getPlayersIPs, getPlayersNames, getUsernamePattern, isEnabled, isValidUsername, loadOnlinePlayers

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

ServerPlayerManager

public ServerPlayerManager()

Method Details

load

public void load()
          throws ChatPluginManagerException

Description copied from interface: ChatPluginManager

Loads (or reloads) this manager.

Specified by:

load in interface ChatPluginManager

Overrides:

load in class PlayerManager

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

Overrides:

unload in class PlayerManager

getPlayers

public Map<UUID,ChatPluginServerPlayer> getPlayers()

Gets the loaded ChatPluginServerPlayers' map.

Do not modify the returned map.

Specified by:

getPlayers in class PlayerManager

Returns:

Loaded players' map

See Also:

• getPlayers()
• ProxyPlayerManager.getPlayers()

getPlayers

public List<ChatPluginServerPlayer> getPlayers(InetAddress ipAddress)

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

Specified by:

getPlayers in class PlayerManager

Parameters:

ipAddress - IP address to check

Returns:

Loaded players' map

See Also:

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

getPlayer

public ChatPluginServerPlayer getPlayer(UUID uuid)

Gets a player from getPlayers() by their UUID.

Will return null if the player is not loaded.

Specified by:

getPlayer in class PlayerManager

Parameters:

uuid - Player to get

Returns:

Loaded ChatPluginServerPlayer

See Also:

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

getPlayer

@Deprecated
public ChatPluginServerPlayer 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.

Specified by:

getPlayer in class PlayerManager

Parameters:

name - Player to get

checkPattern - Whether to check the name against PlayerManager.getUsernamePattern()

ignoreCase - Whether to ignore case when checking online players

Returns:

Loaded ChatPluginServerPlayer

Throws:

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

See Also:

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

getEnabledWorlds

public List<String> getEnabledWorlds()

Gets the list of the enabled worlds.

Found at: "settings.enabled-worlds" in ConfigurationType.CONFIG

Returns:

List of enabled worlds

See Also:

• isWorldEnabled(String)

isWorldEnabled

public boolean isWorldEnabled(String world)

Checks if a world is contained in the enabled worlds' list.

Note: do not use this method to check if players are loaded. Players may be loaded in disabled worlds and unloaded in enabled worlds. Use getPlayer(UUID) to check whether a player is loaded or not.

Parameters:

world - Name of the world to check

Returns:

Whether the world is enabled

getStorageCount

public int getStorageCount()

Gets the total amount of players stored in the storage.

This value is only used to translate {total_players}.

Returns:

Amount of players

setStorageCount

public void setStorageCount(int storageCount)

Sets the amount of players stored in the storage.

This value is only used to translate {total_players}.

Parameters:

storageCount - Amount of players

getPlayersVersions

public static Map<UUID,VersionUtils.Version> getPlayersVersions()

Gets the online players' versions.

Returns:

Online players' versions

getPlayerVersion

public static VersionUtils.Version getPlayerVersion(UUID player)

Gets an online player's version.

Will return null if they are not online.

Parameters:

player - Player's UUID

Returns:

Player's version

getPlayersLoginTimes

public static Map<UUID,Long> getPlayersLoginTimes()

Gets the online players' login times.

Returns:

Online players' login times

getPlayerLoginTime

public static Long getPlayerLoginTime(UUID player)

Gets an online player's login time.

Will return null if they are not online.

Parameters:

player - Player's UUID

Returns:

Player's login time

getBedrockPlayers

public static List<UUID> getBedrockPlayers()

Gets the online Bedrock players' UUIDs.

Returns:

Online Bedrock players' UUIDs

isBedrockPlayer

public static boolean isBedrockPlayer(UUID player)

Checks if the specified player is connected through a MultiPlatformIntegration.

Parameters:

player - Player's UUID

Returns:

Whether the player is using the BE

getInstance

public static ServerPlayerManager getInstance()

Gets this manager's instance.

Returns:

Manager's instance

loadPlayer

public abstract int loadPlayer(PlayerAdapter player)

Adds a player to getPlayers().

Will do nothing and return 0 if they are already loaded.

Parameters:

player - Player to load

Returns:

Time elapsed, in milliseconds

Throws:

IllegalStateException - If ProxyManager.isEnabled() and this server has not received a PlayerJoin packet from the proxy containing information about the specified player's version

See Also:

• ServerPlayerLoadEvent
• Packets.JoinQuit.playerJoin(String, UUID, int, boolean, boolean, boolean)

unloadPlayer

public abstract int unloadPlayer(UUID player)

Removes a player from getPlayers().

Will do nothing and return 0 if they are not loaded.

Parameters:

player - Player to unload

Returns:

Time elapsed, in milliseconds

See Also:

• ServerPlayerUnloadEvent