GameState (Sergeants 0.6 API)

All Superinterfaces:

GameStateFieldContext

All Known Implementing Classes:

UpdatableGameState
```
public interface GameState
extends GameStateFieldContext
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`int`	`getAttackIndex()` Officially "the attackIndex field is unnecessary for bots -- it's used by our client to show/hide attack arrows when appropriate."
`default String`	`getChatRoom()` Identifier of the main game chat room.
`int`	`getColumns()` Horizontal size of the map.
`default Collection<Field>`	`getFields()`
`com.google.common.collect.ImmutableMap<Position,Field>`	`getFieldsMap()`
`GameStarted`	`getGameStartedData()`
`default Player`	`getMyPlayer()`
`default int`	`getMyPlayerIndex()` Index of bot's player.
`default Set<Integer>`	`getMyTeamIndexes()`
`default Set<Position>`	`getNeighbourPositions(Position position)`
`default Set<Field>`	`getNeighbours(Field field)`
`com.google.common.collect.ImmutableList<Player>`	`getPlayers()` Players currently playing and those already dead.
`default String`	`getReplayId()` Replay identifier.
`int`	`getRows()` Vertical size of the map.
`default String`	`getTeamChatRoom()` Identifier of the private team chat room.
`int`	`getTurn()` "Server turn" which is increased after every update (possibility of making a move).
`default Field[][]`	`getTwoDimensionalArrayOfFields()`
`default Collection<VisibleField>`	`getVisibleFields()`
`default com.google.common.collect.ImmutableMap<Position,VisibleField>`	`getVisibleFieldsMap()`
`default boolean`	`isValidPosition(Position position)`
`default Position`	`positionFromIndex(int index)`
`default int`	`positionToIndex(Position position)`

- Method Detail
  - getColumns
```
int getColumns()
```
    Horizontal size of the map. Does not change during the game.
  - getRows
```
int getRows()
```
    Vertical size of the map. Does not change during the game.
  - getTurn
```
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).
  - getAttackIndex
```
int getAttackIndex()
```
    Officially "the attackIndex field is unnecessary for bots -- it's used by our client to show/hide attack arrows when appropriate." Some people say it can be used to find out state of moves queue and plan more complex moves ;-)
  - getPlayers
```
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.
  - getFieldsMap
```
com.google.common.collect.ImmutableMap<Position,Field> getFieldsMap()
```
  - getGameStartedData
```
GameStarted getGameStartedData()
```
  - getMyPlayer
```
default Player getMyPlayer()
```
  - getVisibleFieldsMap
```
default com.google.common.collect.ImmutableMap<Position,VisibleField> getVisibleFieldsMap()
```
  - getFields
```
default Collection<Field> getFields()
```
  - getVisibleFields
```
default Collection<VisibleField> getVisibleFields()
```
  - getTwoDimensionalArrayOfFields
```
default Field[][] getTwoDimensionalArrayOfFields()
```
  - positionFromIndex
```
default Position positionFromIndex(int index)
```
  - positionToIndex
```
default int positionToIndex(Position position)
```
    Specified by:
    
    positionToIndex in interface GameStateFieldContext
  - isValidPosition
```
default boolean isValidPosition(Position position)
```
  - getMyTeamIndexes
```
default Set<Integer> getMyTeamIndexes()
```
    Specified by:
    
    getMyTeamIndexes in interface GameStateFieldContext
  - getMyPlayerIndex
```
default int getMyPlayerIndex()
```
    Index of bot's player.
    
    Specified by:
    
    getMyPlayerIndex in interface GameStateFieldContext
  - getReplayId
```
default 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
```
default String getChatRoom()
```
    Identifier of the main game chat room.
  - getTeamChatRoom
```
default String getTeamChatRoom()
```
    Identifier of the private team chat room.
  - getNeighbourPositions
```
default Set<Position> getNeighbourPositions(Position position)
```
  - getNeighbours
```
default Set<Field> getNeighbours(Field field)
```
    Specified by:
    
    getNeighbours in interface GameStateFieldContext

Interface GameState

Method Summary

Method Detail

getColumns

getRows

getTurn

getAttackIndex

getPlayers

getFieldsMap

getGameStartedData

getMyPlayer

getVisibleFieldsMap

getFields

getVisibleFields

getTwoDimensionalArrayOfFields

positionFromIndex

positionToIndex

isValidPosition

getMyTeamIndexes

getMyPlayerIndex

getReplayId

getChatRoom

getTeamChatRoom

getNeighbourPositions

getNeighbours