Package net.nextinfinity.core.player

Interface PlayerHandler

All Known Implementing Classes:

CorePlayerHandler

public interface PlayerHandler

The PlayerHandler object manages the GamePlayer objects for online Bukkit players.

Method Summary

Modifier and Type	Method	Description
GamePlayer	getPlayer(org.bukkit.entity.Player player)	Obtains the GamePlayer object for the specified Bukkit entity.
GamePlayer	loadPlayer(org.bukkit.entity.Player player)	Loads a GamePlayer object for the specified Bukkit entity.
void	setPlayerClass(java.lang.Class<? extends GamePlayer> playerClass)	Alters the Java class to be used for players, in case a game wishes to use a custom player class.
void	unloadPlayer(org.bukkit.entity.Player player)	Unloads the GamePlayer object for the specified Bukkit entity.

Method Detail

loadPlayer

GamePlayer loadPlayer(org.bukkit.entity.Player player)

Loads a GamePlayer object for the specified Bukkit entity. This should only be called on entity join.

Parameters:

player - the Bukkit entity to load a GamePlayer object for

Returns:

the loaded GamePlayer

unloadPlayer

void unloadPlayer(org.bukkit.entity.Player player)

Unloads the GamePlayer object for the specified Bukkit entity. This should only be called on entity disconnect.

Parameters:

player - the Bukkit entity to unload the GamePlayer object for

getPlayer

GamePlayer getPlayer(org.bukkit.entity.Player player)

Obtains the GamePlayer object for the specified Bukkit entity.

Parameters:

player - the Bukkit entity to obtain the GamePlayer object for

Returns:

the GamePlayer object

setPlayerClass

void setPlayerClass(java.lang.Class<? extends GamePlayer> playerClass)

Alters the Java class to be used for players, in case a game wishes to use a custom player class. The new class must implement GamePlayer. It may be helpful for custom player classes to extend CoreGamePlayer, as this implements all necessary functions.

Parameters:

playerClass - the new Java class to use for players

See Also:

CoreGamePlayer