Package net.nextinfinity.core.player

Interface GamePlayer

All Known Implementing Classes:

CoreGamePlayer

public interface GamePlayer

The GamePlayer object serves as an interface/wrapper to add CTCore function on top of the Bukkit Player object.
In some cases a method of GamePlayer is merely a wrapper for the Player method. This serves to improve readability of core code.

Method Summary

Modifier and Type	Method	Description
void	clearInventory()	Clears the player's inventory, including their armor.
Arena	getArena()	Gets the Arena object for the arena the player is in.
org.bukkit.entity.Player	getBukkitPlayer()	Gets the Bukkit player object for the player.
GameClass	getGameClass()	Gets the active game class for the player.
Team	getTeam()	Gets the player's team.
boolean	hasClass(GameClass gameClass)	Checks if the player has permission to use a game class.
void	heal()	Heals the player and removes any status effects.
void	initializeClass()	Gives the player the items provided by their active class.
boolean	isInGame()	Gets the in-game status of the player.
boolean	isPlaying()	Gets the playing status of the player.
boolean	isSpectating()	Gets the spectating status of the player.
void	resetTeam()	Resets the team the player is on to a null state.
void	restoreInventory()	Restores the player's inventory to its last stored state.
void	saveInventory()	Stores the player's inventory in its current state.
void	sendMessage(java.lang.String message)	Sends the player a message with the game's prefix.
void	setArena(Arena arena)	Sets the players arena to a specific Arena object.
void	setClass(GameClass gameClass)	Sets the active game class for the player.
void	setFlying(boolean flying)	Sets if the player is flying.
void	setTeam(Team team)	Sets the player's team.
void	teleport(org.bukkit.Location location)	Teleports the player to a location.

Method Detail

setArena

void setArena(Arena arena)

Sets the players arena to a specific Arena object. This signifies that the player is playing in or spectating that arena.

Parameters:

arena - the arena the player is in

getArena

Arena getArena()

Gets the Arena object for the arena the player is in. Returns null if the player is not in an arena.

Returns:

The Arena object for the arena the player is in, if there is one

isInGame

boolean isInGame()

Gets the in-game status of the player. Is equivalent to checking if the player's arena is not null.

Returns:

true if the player is in an arena, false otherwise

isPlaying

boolean isPlaying()

Gets the playing status of the player.

Returns:

true if the player is playing in an arena, false otherwise

isSpectating

boolean isSpectating()

Gets the spectating status of the player.

Returns:

true if the player is spectating an arena, false otherwise

getBukkitPlayer

org.bukkit.entity.Player getBukkitPlayer()

Gets the Bukkit player object for the player.

Returns:

the Bukkit player object for the player

setClass

void setClass(GameClass gameClass)

Sets the active game class for the player. This is the class that will be used when the player is spawned in an arena.

Parameters:

gameClass - the game class to set as active

getGameClass

GameClass getGameClass()

Gets the active game class for the player.

Returns:

the active game class for the player

initializeClass

void initializeClass()

Gives the player the items provided by their active class.

saveInventory

void saveInventory()

Stores the player's inventory in its current state.

restoreInventory

void restoreInventory()

Restores the player's inventory to its last stored state.

hasClass

boolean hasClass(GameClass gameClass)

Checks if the player has permission to use a game class.

Parameters:

gameClass - the class to check permission for

Returns:

true if the player has access, false otherwise

sendMessage

void sendMessage(java.lang.String message)

Sends the player a message with the game's prefix.

Parameters:

message - the content of the message

getTeam

Team getTeam()

Gets the player's team. Returns null if the player is not in-game or if the game is a free-for-all

Returns:

the team the player is on, if there is one

setTeam

void setTeam(Team team)

Sets the player's team.

Parameters:

team - the team to set the player on

resetTeam

void resetTeam()

Resets the team the player is on to a null state.

heal

void heal()

Heals the player and removes any status effects.

teleport

void teleport(org.bukkit.Location location)

Teleports the player to a location.

Parameters:

location - the location to teleport the player to

clearInventory

void clearInventory()

Clears the player's inventory, including their armor.

setFlying

void setFlying(boolean flying)

Sets if the player is flying. If the player is flying, makes sure the player is allowed to fly first.

Parameters:

flying - whether or not the player is flying