Package me.remigio07.chatplugin.api.proxy.player

Class ProxyPlayerManager

java.lang.Object

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

me.remigio07.chatplugin.api.proxy.player.ProxyPlayerManager

All Implemented Interfaces:

ChatPluginManager

public abstract class ProxyPlayerManager
extends PlayerManager

Manager that handles ChatPluginProxyPlayers.

Constructor Summary

Constructors

Constructor	Description
ProxyPlayerManager()

Method Summary

Modifier and Type	Method	Description
static ProxyPlayerManager	getInstance()	Gets this manager's instance.
ChatPluginProxyPlayer	getPlayer(String name, boolean checkPattern, boolean ignoreCase)	Deprecated. Names should not be used to identify players.
ChatPluginProxyPlayer	getPlayer(UUID uuid)	Gets a player from getPlayers() by their UUID.
Map<UUID,ChatPluginProxyPlayer>	getPlayers()	Gets the loaded ChatPluginProxyPlayers' map.
List<ChatPluginProxyPlayer>	getPlayers(InetAddress ipAddress)	Gets the list of loaded ChatPluginProxyPlayers with the specified IP address.
void	load()	Loads (or reloads) this manager.
abstract int	loadPlayer(PlayerAdapter player)	Adds a player to getPlayers().
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

getPlayersIPs, getPlayersNames, getTotalPlayers, isEnabled, 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

ProxyPlayerManager

public ProxyPlayerManager()

Method Details

load

public void load()
          throws ChatPluginManagerException

Description copied from interface: ChatPluginManager

Loads (or reloads) this manager.

Throws:

ChatPluginManagerException - If something goes wrong

unload

public void unload()
            throws ChatPluginManagerException

Description copied from interface: ChatPluginManager

Unloads this manager.

Will do nothing if this method is not overridden.

Throws:

ChatPluginManagerException - If something goes wrong

getPlayers

public Map<UUID,ChatPluginProxyPlayer> getPlayers()

Gets the loaded ChatPluginProxyPlayers' map.

Do not modify the returned map.

Specified by:

getPlayers in class PlayerManager

Returns:

Loaded players' map

See Also:

• ServerPlayerManager.getPlayers()
• getPlayers()

getPlayers

public List<ChatPluginProxyPlayer> getPlayers(InetAddress ipAddress)

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

Specified by:

getPlayers in class PlayerManager

Parameters:

ipAddress - IP address to check

Returns:

Loaded players' map

See Also:

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

getPlayer

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

See Also:

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

getPlayer

@Deprecated
public ChatPluginProxyPlayer 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 Utils.USERNAME_PATTERN

ignoreCase - Whether to ignore case when checking online players

Returns:

Loaded ChatPluginProxyPlayer

Throws:

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

See Also:

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

getInstance

public static ProxyPlayerManager 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

See Also:

• ProxyPlayerLoadEvent

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:

• ProxyPlayerUnloadEvent