pl.joegreen.sergeants.framework.model.api

Class UpdatableGameState

java.lang.Object

pl.joegreen.sergeants.framework.model.api.UpdatableGameState

All Implemented Interfaces:

GameState, GameStateFieldContext

public class UpdatableGameState
extends Object
implements GameState

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
static UpdatableGameState	createInitialGameState(GameStartApiResponse startData, GameUpdateApiResponse firstUpdateData) Creates the first game state just after the game is started.
boolean	equals(Object o)
int	getAttackIndex() Officially "the attackIndex field is unnecessary for bots -- it's used by our client to show/hide attack arrows when appropriate."
int	getColumns() Horizontal size of the map.
com.google.common.collect.ImmutableMap<Position,Field>	getFieldsMap()
GameStarted	getGameStartedData()
com.google.common.collect.ImmutableList<Player>	getPlayers() Players currently playing and those already dead.
int	getRows() Vertical size of the map.
int	getTurn() "Server turn" which is increased after every update (possibility of making a move).
com.google.common.collect.ImmutableMap<Position,VisibleField>	getVisibleFieldsMap()
int	hashCode()
String	toString()
UpdatableGameState	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

Methods inherited from interface pl.joegreen.sergeants.framework.model.GameState

getChatRoom, getFields, getMyPlayer, getMyPlayerIndex, getMyTeamIndexes, getNeighbourPositions, getNeighbours, getReplayId, getTeamChatRoom, getTwoDimensionalArrayOfFields, getVisibleFields, isValidPosition, positionFromIndex, positionToIndex

Method Detail

createInitialGameState

public static UpdatableGameState 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 UpdatableGameState 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()

Description copied from interface: GameState

Horizontal size of the map. Does not change during the game.

Specified by:

getColumns in interface GameState

getRows

public int getRows()

Description copied from interface: GameState

Vertical size of the map. Does not change during the game.

Specified by:

getRows in interface GameState

getTurn

public int getTurn()

Description copied from interface: GameState

"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).

Specified by:

getTurn in interface GameState

getAttackIndex

public int getAttackIndex()

Description copied from interface: GameState

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 ;-)

Specified by:

getAttackIndex in interface GameState

getFieldsMap

public com.google.common.collect.ImmutableMap<Position,Field> getFieldsMap()

Specified by:

getFieldsMap in interface GameState

getVisibleFieldsMap

public com.google.common.collect.ImmutableMap<Position,VisibleField> getVisibleFieldsMap()

Specified by:

getVisibleFieldsMap in interface GameState

getPlayers

public com.google.common.collect.ImmutableList<Player> getPlayers()

Description copied from interface: GameState

Players currently playing and those already dead. Represents the table that is displayed in browser in the top right corner of the map.

Specified by:

getPlayers in interface GameState

getGameStartedData

public GameStarted getGameStartedData()

Specified by:

getGameStartedData in interface GameState

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