MGPlayer (MGLib 0.3.1-SNAPSHOT API)

java.lang.Object
- net.amigocraft.mglib.api.MGPlayer

All Implemented Interfaces:

Metadatable
```
public class MGPlayer
extends java.lang.Object
implements Metadatable
```
Represents a player participating in a minigame.

Since:

0.1.0

Constructor Summary

Constructors
Constructor and Description

MGPlayer(java.lang.String plugin, java.lang.String name, java.lang.String arena)
Creates a new MGPlayer instance.

Constructors
Constructor and Description
`MGPlayer(java.lang.String plugin, java.lang.String name, java.lang.String arena)` Creates a new MGPlayer instance.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`JoinResult`	`addToRound(java.lang.String round)` Adds this `MGPlayer` to the given `round`.
`org.bukkit.entity.Player`	`b()` Deprecated. Encourages poor coding practice; please use `Bukkit.getPlayer(String)`
`boolean`	`equals(java.lang.Object p)`
`java.util.HashMap<java.lang.String,java.lang.Object>`	`getAllMetadata()` Retrieves a `HashMap` representing this object's complete metadata.
`java.lang.String`	`getArena()` Gets the arena associated with this `MGPlayer`.
`org.bukkit.entity.Player`	`getBukkitPlayer()` Deprecated. Use `Bukkit.getPlayer(String)`
`java.lang.Object`	`getMetadata(java.lang.String key)` Retrieves a given value from this object's metadata by its key.
`Minigame`	`getMinigame()` Gets the MGLib API instance registered by the minigame plugin associated with this `MGPlayer`.
`java.lang.String`	`getName()` Gets the username of this `MGPlayer`.
`java.lang.String`	`getPlugin()` Gets the minigame plugin associated with this `MGPlayer`.
`java.lang.String`	`getPrefix()` Retrieves the prefix of this player (used on lobby signs).
`GameMode`	`getPrevGameMode()` Gets the gamemode MGLib will impose upon the player upon round exit.
`Round`	`getRound()` Gets the `Round` associated with this player.
`java.lang.String`	`getTeam()` Retrieves the name of the team this player is on, or null if they are not on a team.
`int`	`hashCode()`
`boolean`	`hasMetadata(java.lang.String key)` Checks whether a given key is present in this object's metadata.
`boolean`	`isFrozen()` Retrieves whether the player is frozen.
`boolean`	`isSpectating()` Gets whether this player is spectating their round, as opposed to participating in it.
`void`	`removeFromRound()` Removes this `MGPlayer` from the round they are currently in.
`void`	`removeFromRound(org.bukkit.Location location)` Deprecated. Use `removeFromRound(Location3D)`
`void`	`removeFromRound(Location3D location)` Removes this `MGPlayer` from the round they are currently in.
`void`	`removeMetadata(java.lang.String key)` Removes the given key from this object's metadata.
`void`	`reset()` Resets the `Bukkit player` after they've left a round.
`void`	`reset(org.bukkit.Location location)` Deprecated. Use `reset(Location3D)`
`void`	`reset(Location3D location)` Resets the `Bukkit player` after they've left a round.
`void`	`setArena(java.lang.String arena)` Sets the arena of this `MGPlayer`.
`void`	`setFrozen(boolean frozen)` Cleanly freezes or unfreezes the player.
`void`	`setMetadata(java.lang.String key, java.lang.Object value)` Adds a key-value pair to this object's metadata.
`void`	`setPrefix(java.lang.String prefix)` Sets the prefix of this player (used on lobby signs).
`void`	`setPrevGameMode(GameMode gameMode)` Sets the gamemode MGLib will impose upon the player upon round exit.
`void`	`setPrevGameMode(org.bukkit.GameMode gameMode)` Deprecated. Use `setPrevGameMode(GameMode)`
`void`	`setSpectating(boolean spectating)` Sets whether this player is spectating or not.
`void`	`setTeam(java.lang.String team)` Sets the name of the team this player is on.
`void`	`spawnIn()` Respawns the player at a random or sequential spawn, depending on your configuration.
`void`	`spawnIn(int spawn)` Respawns the player at the given spawn.

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

- Constructor Detail
  - MGPlayer
```
public MGPlayer(java.lang.String plugin,
                java.lang.String name,
                java.lang.String arena)
```
    Creates a new MGPlayer instance.
    
    Parameters:
    
    plugin - the plugin to associate the MGPlayer with
    
    name - the username of the player
    
    arena - the arena of the player
    
    Since:
    
    0.1.0
- Method Detail
  - getPlugin
```
public java.lang.String getPlugin()
```
    Gets the minigame plugin associated with this MGPlayer.
    
    Returns:
    
    the minigame plugin associated with this MGPlayer
    
    Since:
    
    0.1.0
  - getMinigame
```
public Minigame getMinigame()
```
    Gets the MGLib API instance registered by the minigame plugin associated with this MGPlayer.
    
    Returns:
    
    the MGLib API instance registered by the minigame plugin associated with this MGPlayer
    
    Since:
    
    0.1.0
  - getName
```
public java.lang.String getName()
```
    Gets the username of this MGPlayer.
    
    Returns:
    
    the username of this MGPlayer
    
    Since:
    
    0.1.0
  - getArena
```
public java.lang.String getArena()
```
    Gets the arena associated with this MGPlayer.
    
    Returns:
    
    the arena associated with this MGPlayer
    
    Since:
    
    0.1.0
  - getPrefix
```
public java.lang.String getPrefix()
```
    Retrieves the prefix of this player (used on lobby signs).
    
    Returns:
    
    the prefix of this player
    
    Since:
    
    0.1.0
  - getTeam
```
public java.lang.String getTeam()
```
    Retrieves the name of the team this player is on, or null if they are not on a team.
    
    Returns:
    
    the name of the team this player is on, or null if they are not on a team
    
    Since:
    
    0.3.0
  - setTeam
```
public void setTeam(java.lang.String team)
```
    Sets the name of the team this player is on.
    
    Parameters:
    
    team - the name of the team this player is on. Set to null for no team.
    
    Since:
    
    0.3.0
  - setArena
```
public void setArena(java.lang.String arena)
```
    Sets the arena of this MGPlayer. Please do not call this method unless you understand the implications of doing so.
    
    Parameters:
    
    arena - the new arena of this MGPlayer
    
    Since:
    
    0.1.0
  - getRound
```
public Round getRound()
```
    Gets the Round associated with this player.
    
    Returns:
    
    the Round associated with this player
    
    Since:
    
    0.1.0
  - isSpectating
```
public boolean isSpectating()
```
    Gets whether this player is spectating their round, as opposed to participating in it.
    
    Returns:
    
    whether this player is spectating their round (can return true even if Entity.isDead() returns false).
    
    Since:
    
    0.1.0
  - setSpectating
```
public void setSpectating(boolean spectating)
```
    Sets whether this player is spectating or not.
    
    Parameters:
    
    spectating - whether the player is spectating
    
    Since:
    
    0.1.0
  - setPrefix
```
public void setPrefix(java.lang.String prefix)
```
    Sets the prefix of this player (used on lobby signs).
    
    Parameters:
    
    prefix - the new prefix of this player
    
    Since:
    
    0.1.0
  - addToRound
```
public JoinResult addToRound(java.lang.String round)
                      throws PlayerOfflineException,
                             PlayerPresentException,
                             RoundFullException
```
    Adds this MGPlayer to the given round.
    
    Parameters:
    
    round - the name of the round to add the player to
    
    Returns:
    
    the result of this player being added to the round
    
    Throws:
    
    PlayerOfflineException - if the player is not online
    
    PlayerPresentException - if the player is already in a round
    
    RoundFullException - if the round is full
    
    Since:
    
    0.1.0
  - removeFromRound
```
public void removeFromRound(Location3D location)
                     throws NoSuchPlayerException,
                            PlayerOfflineException
```
    Removes this MGPlayer from the round they are currently in.
    
    Parameters:
    
    location - the location to teleport this player to. Please omit it if you wish to teleport them to the round's default exit point.
    
    Throws:
    
    NoSuchPlayerException - if the given player is not in a round
    
    PlayerOfflineException - if the given player is not online
    
    Since:
    
    0.3.1
  - removeFromRound
```
@Deprecated
public void removeFromRound(org.bukkit.Location location)
                                  throws NoSuchPlayerException,
                                         PlayerOfflineException
```
    Deprecated. Use removeFromRound(Location3D)
    
    Removes this MGPlayer from the round they are currently in.
    
    Parameters:
    
    location - the location to teleport this player to. Please omit it if you wish to teleport them to the round's default exit point.
    
    Throws:
    
    NoSuchPlayerException - if the given player is not in a round
    
    PlayerOfflineException - if the given player is not online
    
    Since:
    
    0.1.0
  - removeFromRound
```
public void removeFromRound()
                     throws NoSuchPlayerException,
                            PlayerOfflineException
```
    Removes this MGPlayer from the round they are currently in.
    
    Throws:
    
    NoSuchPlayerException - if the player is not in a round
    
    PlayerOfflineException - if the player is not online
    
    Since:
    
    0.1.0
  - reset
```
public void reset(Location3D location)
```
    Resets the Bukkit player after they've left a round.
    
    Parameters:
    
    location - the location to teleport the player to, or null to skip teleportation
    
    Since:
    
    0.1.0
  - reset
```
@Deprecated
public void reset(org.bukkit.Location location)
```
    Deprecated. Use reset(Location3D)
    
    Resets the Bukkit player after they've left a round.
    
    Parameters:
    
    location - the location to teleport the player to, or null to skip teleportation
    
    Since:
    
    0.1.0
  - reset
```
public void reset()
           throws PlayerOfflineException
```
    Resets the Bukkit player after they've left a round.
    
    Throws:
    
    PlayerOfflineException - if the player is offline
    
    Since:
    
    0.1.0
  - getPrevGameMode
```
public GameMode getPrevGameMode()
```
    Gets the gamemode MGLib will impose upon the player upon round exit.
    This method typically should not be called from outside the library.
    
    Returns:
    
    the gamemode MGLib will impose upon the player upon round exit.
    
    Since:
    
    0.1.0
  - setPrevGameMode
```
public void setPrevGameMode(GameMode gameMode)
```
    Sets the gamemode MGLib will impose upon the player upon round exit.
    This method typically should not be called from outside the library.
    
    Parameters:
    
    gameMode - the gamemode MGLib will impose upon the player upon round exit.
    
    Since:
    
    0.3.1
  - setPrevGameMode
```
@Deprecated
public void setPrevGameMode(org.bukkit.GameMode gameMode)
```
    Deprecated. Use setPrevGameMode(GameMode)
    
    Sets the gamemode MGLib will impose upon the player upon round exit.
    This method typically should not be called from outside the library.
    
    Parameters:
    
    gameMode - the gamemode MGLib will impose upon the player upon round exit.
    
    Since:
    
    0.1.0
  - getBukkitPlayer
```
@Deprecated
public org.bukkit.entity.Player getBukkitPlayer()
```
    Deprecated. Use Bukkit.getPlayer(String)
    
    Retrieves the Player object for this MGPlayer.
    
    Returns:
    
    the Player object for this MGPlayer
    
    Since:
    
    0.2.0
  - b
```
@Deprecated
public org.bukkit.entity.Player b()
```
    Deprecated. Encourages poor coding practice; please use Bukkit.getPlayer(String)
    
    Convenience method for getBukkitPlayer(). Use this only if aesthetic ambiguity is not a point of concern.
    
    Returns:
    
    the Player object for this MGPlayer
    
    Since:
    
    0.3.0
  - isFrozen
```
public boolean isFrozen()
```
    Retrieves whether the player is frozen.
    
    Returns:
    
    whether the player is frozen
    
    Since:
    
    0.3.0
  - setFrozen
```
public void setFrozen(boolean frozen)
```
    Cleanly freezes or unfreezes the player. The library will automatically revert the player to their previous speed when unfrozen and let it go, let it go!
    
    Parameters:
    
    frozen - whether the player should be frozen
    
    Since:
    
    0.3.0
  - spawnIn
```
public void spawnIn(int spawn)
```
    Respawns the player at the given spawn.
    
    Parameters:
    
    spawn - the index of the spawn to send the player to
    
    Since:
    
    0.3.0
  - spawnIn
```
public void spawnIn()
```
    Respawns the player at a random or sequential spawn, depending on your configuration.
    
    Since:
    
    0.3.0
  - equals
```
public boolean equals(java.lang.Object p)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getMetadata
```
public java.lang.Object getMetadata(java.lang.String key)
```
    Description copied from interface: Metadatable
    
    Retrieves a given value from this object's metadata by its key.
    
    Specified by:
    
    getMetadata in interface Metadatable
    
    Parameters:
    
    key - the key to retrieve.
    
    Returns:
    
    the key's mapped value, or null if it is not mapped.
  - setMetadata
```
public void setMetadata(java.lang.String key,
                        java.lang.Object value)
```
    Description copied from interface: Metadatable
    
    Adds a key-value pair to this object's metadata.
    Note: This method consists of a single call to HashMap.put(Object, Object), so existing keys will be overwritten.
    
    Specified by:
    
    setMetadata in interface Metadatable
    
    Parameters:
    
    key - the key to store in the round's metadata.
    
    value - the value to assign to the given key.
  - removeMetadata
```
public void removeMetadata(java.lang.String key)
```
    Description copied from interface: Metadatable
    
    Removes the given key from this object's metadata.
    
    Specified by:
    
    removeMetadata in interface Metadatable
    
    Parameters:
    
    key - the key to remove from this object's metadata.
  - hasMetadata
```
public boolean hasMetadata(java.lang.String key)
```
    Description copied from interface: Metadatable
    
    Checks whether a given key is present in this object's metadata.
    
    Specified by:
    
    hasMetadata in interface Metadatable
    
    Parameters:
    
    key - the key to test for.
    
    Returns:
    
    whether the key is present in this object's metadata.
  - getAllMetadata
```
public java.util.HashMap<java.lang.String,java.lang.Object> getAllMetadata()
```
    Description copied from interface: Metadatable
    
    Retrieves a HashMap representing this object's complete metadata.
    
    Specified by:
    
    getAllMetadata in interface Metadatable
    
    Returns:
    
    this object's metadata in the form of a HashMap.

Class MGPlayer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MGPlayer

Method Detail

getPlugin

getMinigame

getName

getArena

getPrefix

getTeam

setTeam

setArena

getRound

isSpectating

setSpectating

setPrefix

addToRound

removeFromRound

removeFromRound

removeFromRound

reset

reset

reset

getPrevGameMode

setPrevGameMode

setPrevGameMode

getBukkitPlayer

b

isFrozen

setFrozen

spawnIn

spawnIn

equals

hashCode

getMetadata

setMetadata

removeMetadata

hasMetadata

getAllMetadata