Player

java.lang.Object
- shared.model.Player

All Implemented Interfaces:

java.io.Serializable
```
public class Player
extends java.lang.Object
implements java.io.Serializable
```
A player in the game. Can be an AI player or a human player

Author:

matthewcarlson, garrettegan

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`armySize`
`CatanColor`	`color`
`private boolean`	`isRobot`
`java.lang.String`	`name`
`Bank`	`playerBank`
`private int`	`playerID`
`private int`	`playerIndex`
`private static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description
`Player(java.lang.String name, int index, CatanColor playerColor, boolean isHuman)` Creates a Player
`Player(java.lang.String name, int index, CatanColor playerColor, boolean isHuman, int ID)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`int`	`getArmySize()` Gets this player's army size
`int`	`hashCode()`
`int`	`incrementArmySize()` Increments this player's army size
`boolean`	`isARobot()` A simple function to determine if the player is controlled by AI
`int`	`playerID()` Returns the player ID
`int`	`playerIndex()` Returns the playerIndex so it can't be changed
`java.lang.String`	`toString()`
`int`	`totalResources()`

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

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - name
```
public java.lang.String name
```
  - color
```
public CatanColor color
```
  - playerBank
```
public Bank playerBank
```
  - playerIndex
```
private int playerIndex
```
  - playerID
```
private int playerID
```
  - isRobot
```
private boolean isRobot
```
  - armySize
```
private int armySize
```
- Constructor Detail
  - Player
```
public Player(java.lang.String name,
              int index,
              CatanColor playerColor,
              boolean isHuman)
```
    Creates a Player
    
    Parameters:
    
    name - the name of the player
    
    index - the player's index
    
    playerColor - the color of the player's game pieces
    
    isHuman - whether the player is a human or computer player
  - Player
```
public Player(java.lang.String name,
              int index,
              CatanColor playerColor,
              boolean isHuman,
              int ID)
```
- Method Detail
  - getArmySize
```
public int getArmySize()
```
    Gets this player's army size
    
    Returns:
    
    the size of this player's army
  - incrementArmySize
```
public int incrementArmySize()
```
    Increments this player's army size
    
    Returns:
    
    this player's new army size
  - isARobot
```
public boolean isARobot()
```
    A simple function to determine if the player is controlled by AI
    
    Returns:
    
    true if is a robot
  - playerIndex
```
public int playerIndex()
```
    Returns the playerIndex so it can't be changed
    
    Returns:
    
    0 to 3
  - playerID
```
public int playerID()
```
    Returns the player ID
    
    Returns:
  - totalResources
```
public int totalResources()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class Player

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

name

color

playerBank

playerIndex

playerID

isRobot

armySize

Constructor Detail

Player

Player

Method Detail

getArmySize

incrementArmySize

isARobot

playerIndex

playerID

totalResources

toString

hashCode

equals