GameState (Sergeants 0.1 API)

java.lang.Object
- pl.joegreen.sergeants.framework.model.GameState

```
public class GameState
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class GameState.Field

class GameState.VisibleField

Nested Classes
Modifier and Type	Class and Description
`class`	`GameState.Field`
`class`	`GameState.VisibleField`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(Object other)`
`static GameState`	`createInitialGameState(GameStartApiResponse startData, GameUpdateApiResponse firstUpdateData)` Creates the first game state just after the game is started.
`boolean`	`equals(Object o)`
`String`	`getChatRoom()` Identifier of the main game chat room.
`int`	`getColumns()` Horizontal size of the map.
`Collection<GameState.Field>`	`getFields()`
`com.google.common.collect.ImmutableMap<Position,GameState.Field>`	`getFieldsMap()`
`Player`	`getMyPlayer()` Representation of bot's player.
`int`	`getMyPlayerIndex()` Index of bot's player.
`Collection<Integer>`	`getMyTeamIndexes()` Indexes of players being in the same team as bot.
`com.google.common.collect.ImmutableList<Player>`	`getPlayers()` Players currently playing and those already dead.
`String`	`getReplayId()` Replay identifier.
`int`	`getRows()` Vertical size of the map.
`String`	`getTeamChatRoom()` Identifier of the private team chat room.
`int`	`getTurn()` "Server turn" which is increased after every update (possibility of making a move).
`GameState.Field[][]`	`getTwoDimensionalArrayOfFields()`
`Collection<GameState.VisibleField>`	`getVisibleFields()`
`com.google.common.collect.ImmutableMap<Position,GameState.VisibleField>`	`getVisibleFieldsMap()`
`int`	`hashCode()`
`boolean`	`isValidPosition(Position position)` Checks if given position lays inside the map.
`Position`	`positionFromIndex(int index)`
`int`	`positionToIndex(Position position)`
`String`	`toString()`
`GameState`	`update(GameUpdateApiResponse gameUpdateData)` Updates game state from previous turn with new information received from server.

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

- Method Detail
  - createInitialGameState
```
public static GameState createInitialGameState(GameStartApiResponse startData,
                                               GameUpdateApiResponse firstUpdateData)
```
    Creates the first game state just after the game is started. Can be done only after both messages are received from server: GameStartApiResponse and GameUpdateApiResponse. Cannot be use for further updates, as later game updates from server contain only differences.
  - update
```
public GameState update(GameUpdateApiResponse gameUpdateData)
```
    Updates game state from previous turn with new information received from server. The method only works fine if updates are applied in sequence, as server is only sending map differences in update messages.
  - getColumns
```
public int getColumns()
```
    Horizontal size of the map. Does not change during the game.
  - getRows
```
public int getRows()
```
    Vertical size of the map. Does not change during the game.
  - getTurn
```
public int getTurn()
```
    "Server turn" which is increased after every update (possibility of making a move). Is not the same as turn number displayed in browser (browser turn is equal to two server turns).
  - getPlayers
```
public com.google.common.collect.ImmutableList<Player> getPlayers()
```
    Players currently playing and those already dead. Represents the table that is displayed in browser in the top right corner of the map.
  - getMyPlayerIndex
```
public int getMyPlayerIndex()
```
    Index of bot's player.
  - getMyPlayer
```
public Player getMyPlayer()
```
    Representation of bot's player. getPlayers()
  - getReplayId
```
public String getReplayId()
```
    Replay identifier. Replays are available only after game is finished. Use http://bot.generals.io/replays/{replayId} to see the replay in your browser.
  - getChatRoom
```
public String getChatRoom()
```
    Identifier of the main game chat room.
  - getTeamChatRoom
```
public String getTeamChatRoom()
```
    Identifier of the private team chat room.
  - getVisibleFieldsMap
```
public com.google.common.collect.ImmutableMap<Position,GameState.VisibleField> getVisibleFieldsMap()
```
  - getFieldsMap
```
public com.google.common.collect.ImmutableMap<Position,GameState.Field> getFieldsMap()
```
  - getFields
```
public Collection<GameState.Field> getFields()
```
  - getVisibleFields
```
public Collection<GameState.VisibleField> getVisibleFields()
```
  - getTwoDimensionalArrayOfFields
```
public GameState.Field[][] getTwoDimensionalArrayOfFields()
```
  - positionFromIndex
```
public Position positionFromIndex(int index)
```
  - positionToIndex
```
public int positionToIndex(Position position)
```
  - isValidPosition
```
public boolean isValidPosition(Position position)
```
    Checks if given position lays inside the map.
  - getMyTeamIndexes
```
public Collection<Integer> getMyTeamIndexes()
```
    Indexes of players being in the same team as bot.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class GameState

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createInitialGameState

update

getColumns

getRows

getTurn

getPlayers

getMyPlayerIndex

getMyPlayer

getReplayId

getChatRoom

getTeamChatRoom

getVisibleFieldsMap

getFieldsMap

getFields

getVisibleFields

getTwoDimensionalArrayOfFields

positionFromIndex

positionToIndex

isValidPosition

getMyTeamIndexes

toString

equals

canEqual

hashCode