pl.joegreen.sergeants.api.response

Class GameStartApiResponse

java.lang.Object

pl.joegreen.sergeants.api.response.GameStartApiResponse

public final class GameStartApiResponse
extends Object

Constructor Summary

Constructors

Constructor and Description
GameStartApiResponse(int playerIndex, String replayId, String chatRoom, String teamChatRoom, String[] usernames, Integer[] teams)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getChatRoom() Identifier of the main chat room, useful when sending a chat message (GeneralsApi.sendChatMessage(String, String)).
int	getPlayerIndex() Index of bot's player.
String	getReplayId() Replay identifier.
String	getTeamChatRoom() Identifier of the team chat room, useful when sending a chat message (GeneralsApi.sendChatMessage(String, String)).
Integer[]	getTeams() Array if team identifiers of each player, indexed by player index.
String[]	getUsernames() Array of player names, indexed by player index.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GameStartApiResponse

@ConstructorProperties(value={"playerIndex","replayId","chatRoom","teamChatRoom","usernames","teams"})
public GameStartApiResponse(int playerIndex,
                                                                                                                                    String replayId,
                                                                                                                                    String chatRoom,
                                                                                                                                    String teamChatRoom,
                                                                                                                                    String[] usernames,
                                                                                                                                    Integer[] teams)

Method Detail

getPlayerIndex

public int getPlayerIndex()

Index of bot's player.

getReplayId

public String getReplayId()

Replay identifier. Use http://bot.generals.io/replays/{replayId} to see the replay in your browser.

getChatRoom

public String getChatRoom()

Identifier of the main chat room, useful when sending a chat message (GeneralsApi.sendChatMessage(String, String)).

getTeamChatRoom

public String getTeamChatRoom()

Identifier of the team chat room, useful when sending a chat message (GeneralsApi.sendChatMessage(String, String)). Can be null if there are no teams in the game.

getUsernames

public String[] getUsernames()

Array of player names, indexed by player index.

getTeams

public Integer[] getTeams()

Array if team identifiers of each player, indexed by player index. Can be null if there are no teams/

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