CoreGamePlayer (core 1.0.2 API)

java.lang.Object
- net.nextinfinity.core.player.impl.CoreGamePlayer

All Implemented Interfaces:: GamePlayer

public class CoreGamePlayer
extends java.lang.Object
implements GamePlayer

Constructor Summary

Constructors
Constructor Description

CoreGamePlayer(org.bukkit.entity.Player player, Game game)

Constructors
Constructor	Description
`CoreGamePlayer(org.bukkit.entity.Player player, Game game)`

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CoreGamePlayer
```
public CoreGamePlayer(org.bukkit.entity.Player player,
                      Game game)
```
- Method Detail
  - setArena
```
public void setArena(Arena arena)
```
    Description copied from interface: GamePlayer
    
    Sets the players arena to a specific Arena object. This signifies that the player is playing in or spectating that arena.
    
    Specified by:
    
    setArena in interface GamePlayer
    
    Parameters:
    
    arena - the arena the player is in
  - getArena
```
public Arena getArena()
```
    Description copied from interface: GamePlayer
    
    Gets the Arena object for the arena the player is in. Returns null if the player is not in an arena.
    
    Specified by:
    
    getArena in interface GamePlayer
    
    Returns:
    
    The Arena object for the arena the player is in, if there is one
  - isInGame
```
public boolean isInGame()
```
    Description copied from interface: GamePlayer
    
    Gets the in-game status of the player. Is equivalent to checking if the player's arena is not null.
    
    Specified by:
    
    isInGame in interface GamePlayer
    
    Returns:
    
    true if the player is in an arena, false otherwise
  - isPlaying
```
public boolean isPlaying()
```
    Description copied from interface: GamePlayer
    
    Gets the playing status of the player.
    
    Specified by:
    
    isPlaying in interface GamePlayer
    
    Returns:
    
    true if the player is playing in an arena, false otherwise
  - isSpectating
```
public boolean isSpectating()
```
    Description copied from interface: GamePlayer
    
    Gets the spectating status of the player.
    
    Specified by:
    
    isSpectating in interface GamePlayer
    
    Returns:
    
    true if the player is spectating an arena, false otherwise
  - getBukkitPlayer
```
public org.bukkit.entity.Player getBukkitPlayer()
```
    Description copied from interface: GamePlayer
    
    Gets the Bukkit player object for the player.
    
    Specified by:
    
    getBukkitPlayer in interface GamePlayer
    
    Returns:
    
    the Bukkit player object for the player
  - setClass
```
public void setClass(GameClass gameClass)
```
    Description copied from interface: GamePlayer
    
    Sets the active game class for the player. This is the class that will be used when the player is spawned in an arena.
    
    Specified by:
    
    setClass in interface GamePlayer
    
    Parameters:
    
    gameClass - the game class to set as active
  - getGameClass
```
public GameClass getGameClass()
```
    Description copied from interface: GamePlayer
    
    Gets the active game class for the player.
    
    Specified by:
    
    getGameClass in interface GamePlayer
    
    Returns:
    
    the active game class for the player
  - initializeClass
```
public void initializeClass()
```
    Description copied from interface: GamePlayer
    
    Gives the player the items provided by their active class.
    
    Specified by:
    
    initializeClass in interface GamePlayer
  - saveInventory
```
public void saveInventory()
```
    Description copied from interface: GamePlayer
    
    Stores the player's inventory in its current state.
    
    Specified by:
    
    saveInventory in interface GamePlayer
  - restoreInventory
```
public void restoreInventory()
```
    Description copied from interface: GamePlayer
    
    Restores the player's inventory to its last stored state.
    
    Specified by:
    
    restoreInventory in interface GamePlayer
  - hasClass
```
public boolean hasClass(GameClass gameClass)
```
    Description copied from interface: GamePlayer
    
    Checks if the player has permission to use a game class.
    
    Specified by:
    
    hasClass in interface GamePlayer
    
    Parameters:
    
    gameClass - the class to check permission for
    
    Returns:
    
    true if the player has access, false otherwise
  - sendMessage
```
public void sendMessage(java.lang.String message)
```
    Description copied from interface: GamePlayer
    
    Sends the player a message with the game's prefix.
    
    Specified by:
    
    sendMessage in interface GamePlayer
    
    Parameters:
    
    message - the content of the message
  - getTeam
```
public Team getTeam()
```
    Description copied from interface: GamePlayer
    
    Gets the player's team. Returns null if the player is not in-game or if the game is a free-for-all
    
    Specified by:
    
    getTeam in interface GamePlayer
    
    Returns:
    
    the team the player is on, if there is one
  - setTeam
```
public void setTeam(Team team)
```
    Description copied from interface: GamePlayer
    
    Sets the player's team.
    
    Specified by:
    
    setTeam in interface GamePlayer
    
    Parameters:
    
    team - the team to set the player on
  - resetTeam
```
public void resetTeam()
```
    Description copied from interface: GamePlayer
    
    Resets the team the player is on to a null state.
    
    Specified by:
    
    resetTeam in interface GamePlayer
  - teleport
```
public void teleport(org.bukkit.Location location)
```
    Description copied from interface: GamePlayer
    
    Teleports the player to a location.
    
    Specified by:
    
    teleport in interface GamePlayer
    
    Parameters:
    
    location - the location to teleport the player to
  - heal
```
public void heal()
```
    Description copied from interface: GamePlayer
    
    Heals the player and removes any status effects.
    
    Specified by:
    
    heal in interface GamePlayer
  - clearInventory
```
public void clearInventory()
```
    Description copied from interface: GamePlayer
    
    Clears the player's inventory, including their armor.
    
    Specified by:
    
    clearInventory in interface GamePlayer
  - setFlying
```
public void setFlying(boolean flying)
```
    Description copied from interface: GamePlayer
    
    Sets if the player is flying. If the player is flying, makes sure the player is allowed to fly first.
    
    Specified by:
    
    setFlying in interface GamePlayer
    
    Parameters:
    
    flying - whether or not the player is flying

Class CoreGamePlayer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CoreGamePlayer

Method Detail

setArena

getArena

isInGame

isPlaying

isSpectating

getBukkitPlayer

setClass

getGameClass

initializeClass

saveInventory

restoreInventory

hasClass

sendMessage

getTeam

setTeam

resetTeam

teleport

heal

clearInventory

setFlying