GameState

java.lang.Object
- shared.model.GameState

All Implemented Interfaces:

java.io.Serializable
```
public class GameState
extends java.lang.Object
implements java.io.Serializable
```
An object that keeps track of whose turn it is.

Author:

matthewcarlson, garrettegan

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

int activePlayerIndex

private static long serialVersionUID

GameRound state

Fields
Modifier and Type	Field and Description
`int`	`activePlayerIndex`
`private static long`	`serialVersionUID`
`GameRound`	`state`

Constructor Summary

Constructors
Constructor and Description

GameState()

Constructors
Constructor and Description
`GameState()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`endGame()`
`boolean`	`equals(java.lang.Object obj)`
`int`	`hashCode()`
`boolean`	`IsEndGame()` checks if the game state is finished
`boolean`	`IsSetup()` Whether the game is in setup or not
`boolean`	`nextTurn()` Sets the game state to the next player's turn (roll phase)
`boolean`	`startBuildPhase()` Sets the game state to the same player's turn (build phase)
`boolean`	`startGame()` Sets the game state to the first player's turn (roll phase)
`boolean`	`startRobbing(boolean requireDiscard)` Start robbing
`boolean`	`stopRobbing()` Stop the robbing
`boolean`	`stopRolling()`

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

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - state
```
public GameRound state
```
  - activePlayerIndex
```
public int activePlayerIndex
```
- Constructor Detail
  - GameState
```
public GameState()
```
- Method Detail
  - startGame
```
public boolean startGame()
```
    Sets the game state to the first player's turn (roll phase)
    
    Returns:
    
    successful or not (almost always is true)
  - nextTurn
```
public boolean nextTurn()
```
    Sets the game state to the next player's turn (roll phase)
    
    Returns:
    
    successful or not (almost always is true)
  - startBuildPhase
```
public boolean startBuildPhase()
```
    Sets the game state to the same player's turn (build phase)
    
    Returns:
    
    successful or not (almost always is true)
  - startRobbing
```
public boolean startRobbing(boolean requireDiscard)
```
    Start robbing
    
    Returns:
  - stopRobbing
```
public boolean stopRobbing()
```
    Stop the robbing
    
    Returns:
  - stopRolling
```
public boolean stopRolling()
```
    Returns:
  - IsEndGame
```
public boolean IsEndGame()
```
    checks if the game state is finished
    
    Returns:
    
    successful or not (almost always is true)
  - IsSetup
```
public boolean IsSetup()
```
    Whether the game is in setup or not
    
    Returns:
    
    true if firstround or second round
  - endGame
```
public void endGame()
```
  - 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 GameState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

state

activePlayerIndex

Constructor Detail

GameState

Method Detail

startGame

nextTurn

startBuildPhase

startRobbing

stopRobbing

stopRolling

IsEndGame

IsSetup

endGame

hashCode

equals