Player

uk.co.electronstudio.retrowar.Player

```
public class Player
```
Represents a player who has joined the game

Constructor Summary

Constructors
Constructor and Description
`Player(InputDevice input, java.lang.String name, com.badlogic.gdx.graphics.Color color, com.badlogic.gdx.graphics.Color color2)` Represents a player who has joined the game

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Player other)` Compares players to see who has highest score
`com.badlogic.gdx.graphics.Color`	`getColor()` A custom colour chosen by player in options
`com.badlogic.gdx.graphics.Color`	`getColor2()`
`int`	`getDeaths()` If your game tracks lives, you can store how many times the player has died here (rather than lives remaining)
`float`	`getHealthLost()` If your game tracks health, you can store how much health the player has lost here (rather than storing the remaining health)
`InputDevice`	`getInput()` The keyboard/controller etc he is using
`int`	`getMetaScore()` When game is part of a multi-round tournment this represents the overall score in the tournament
`java.lang.String`	`getName()` The name to display for this player.
`int`	`getScore()` If your game keeps score you can store it here
`float`	`getStartingHealth()` How much health the player started with
`java.lang.String`	`healthDisplayString(float startingHealth)`
`void`	`incMetaScore(int i)`
`boolean`	`isOutOfLives(int lives)` Gameover, man, gameover.
`java.lang.String`	`livesDisplayString(int startingLives)`
`void`	`reset()` Resets score, lives and health for a new round
`void`	`setDeaths(int p)` If your game tracks lives, you can store how many times the player has died here (rather than lives remaining)
`void`	`setHealthLost(float p)` If your game tracks health, you can store how much health the player has lost here (rather than storing the remaining health)
`void`	`setScore(int p)` If your game keeps score you can store it here
`void`	`setStartingHealth(float p)` How much health the player started with

- Constructor Detail
  - Player
```
public Player(InputDevice input,
              java.lang.String name,
              com.badlogic.gdx.graphics.Color color,
              com.badlogic.gdx.graphics.Color color2)
```
    Represents a player who has joined the game
    
    Parameters:
    
    input - The keyboard/controller etc he is using
    
    name - The name to display for this player. Defaults to 'PLAYERx' but may be customized in options
    
    color - A custom colour chosen by player in options
    
    input - The keyboard/controller etc he is using
    
    name - The name to display for this player. Defaults to 'PLAYERx' but may be customized in options
    
    color - A custom colour chosen by player in options
    
    color - Another custom colour
- Method Detail
  - compareTo
```
public int compareTo(Player other)
```
    Compares players to see who has highest score
  - getScore
```
public int getScore()
```
    If your game keeps score you can store it here
  - setScore
```
public void setScore(int p)
```
    If your game keeps score you can store it here
  - getDeaths
```
public int getDeaths()
```
    If your game tracks lives, you can store how many times the player has died here (rather than lives remaining)
  - setDeaths
```
public void setDeaths(int p)
```
    If your game tracks lives, you can store how many times the player has died here (rather than lives remaining)
  - getHealthLost
```
public float getHealthLost()
```
    If your game tracks health, you can store how much health the player has lost here (rather than storing the remaining health)
  - setHealthLost
```
public void setHealthLost(float p)
```
    If your game tracks health, you can store how much health the player has lost here (rather than storing the remaining health)
  - getMetaScore
```
public int getMetaScore()
```
    When game is part of a multi-round tournment this represents the overall score in the tournament
  - incMetaScore
```
public void incMetaScore(int i)
```
  - getStartingHealth
```
public float getStartingHealth()
```
    How much health the player started with
  - setStartingHealth
```
public void setStartingHealth(float p)
```
    How much health the player started with
  - healthDisplayString
```
public java.lang.String healthDisplayString(float startingHealth)
```
  - livesDisplayString
```
public java.lang.String livesDisplayString(int startingLives)
```
  - isOutOfLives
```
public boolean isOutOfLives(int lives)
```
    Gameover, man, gameover.
  - reset
```
public void reset()
```
    Resets score, lives and health for a new round
  - getInput
```
public InputDevice getInput()
```
    The keyboard/controller etc he is using
  - getName
```
public java.lang.String getName()
```
    The name to display for this player.
    Defaults to 'PLAYERx' but may be customized in options
  - getColor
```
public com.badlogic.gdx.graphics.Color getColor()
```
    A custom colour chosen by player in options
  - getColor2
```
public com.badlogic.gdx.graphics.Color getColor2()
```

Class Player

Constructor Summary

Method Summary

Constructor Detail

Player

Method Detail

compareTo

getScore

setScore

getDeaths

setDeaths

getHealthLost

setHealthLost

getMetaScore

incMetaScore

getStartingHealth

setStartingHealth

healthDisplayString

livesDisplayString

isOutOfLives

reset

getInput

getName

getColor

getColor2