pl.joegreen.sergeants.api.response

Class GameUpdateApiResponse

java.lang.Object

pl.joegreen.sergeants.api.response.GameUpdateApiResponse

public final class GameUpdateApiResponse
extends Object

Constructor Summary

Constructors

Constructor and Description
GameUpdateApiResponse(int turn, int[] mapDiff, int[] citiesDiff, int[] generals, int attackIndex, ScoreApiResponse[] scores, double[] stars)

Method Summary

Modifier and Type	Method and Description
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[]	getCitiesDiff() Diff to update the array with cities representation.
int[]	getGenerals() Array of indexes of generals, indexed with player index.
int[]	getMapDiff() Diff to update the array with map (tiles/armies) representation.
ScoreApiResponse[]	getScores() Array indexed by player index, includes things shown in the score table (titles, army, is dead).
double[]	getStars()
int	getTurn()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GameUpdateApiResponse

@ConstructorProperties(value={"turn","mapDiff","citiesDiff","generals","attackIndex","scores","stars"})
public GameUpdateApiResponse(int turn,
                                                                                                                                      int[] mapDiff,
                                                                                                                                      int[] citiesDiff,
                                                                                                                                      int[] generals,
                                                                                                                                      int attackIndex,
                                                                                                                                      ScoreApiResponse[] scores,
                                                                                                                                      double[] stars)

Method Detail

getTurn

public int getTurn()

getMapDiff

public int[] getMapDiff()

Diff to update the array with map (tiles/armies) representation. Use MapPatcher to apply the diff.

getCitiesDiff

public int[] getCitiesDiff()

Diff to update the array with cities representation. Use MapPatcher to apply the diff.

getGenerals

public int[] getGenerals()

Array of indexes of generals, indexed with player index. If general of player is not visible/does not exist, contains -1 in appropriate position.

getAttackIndex

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

getScores

public ScoreApiResponse[] getScores()

Array indexed by player index, includes things shown in the score table (titles, army, is dead). Does not include stars.

getStars

public double[] getStars()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object