soc.message
Class SOCGameState

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCGameState

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SOCGameState

extends SOCMessage

This message communicates the current state of the game

Author:

Robert S Thomas

See Also:

SOCGame.getGameState(), Serialized Form

Field Summary

private java.lang.String	game Name of game
private int	state Game state

Fields inherited from class soc.message.SOCMessage

ACCEPTOFFER, ADMINPING, ADMINRESET, BANKTRADE, BCASTTEXTMSG, BOARDLAYOUT, BUILDREQUEST, BUYCARDREQUEST, CANCELBUILDREQUEST, CHANGEFACE, CHANNELS, CHOOSEPLAYER, CHOOSEPLAYERREQUEST, CLEAROFFER, CLEARTRADEMSG, CREATEACCOUNT, DELETECHANNEL, DELETEGAME, DEVCARD, DEVCARDCOUNT, DICERESULT, DISCARD, DISCARDREQUEST, DISCOVERYPICK, ENDTURN, FIRSTPLAYER, GAMEMEMBERS, GAMES, GAMESTATE, GAMESTATS, GAMETEXTMSG, IMAROBOT, JOIN, JOINAUTH, JOINGAME, JOINGAMEAUTH, JOINGAMEREQUEST, LARGESTARMY, LASTSETTLEMENT, LEAVE, LEAVEALL, LEAVEGAME, LONGESTROAD, MAKEOFFER, MEMBERS, messageType, MONOPOLYPICK, MOVEROBBER, NEWCHANNEL, NEWGAME, NULLMESSAGE, PLAYDEVCARDREQUEST, PLAYERELEMENT, POTENTIALSETTLEMENTS, PUTPIECE, REJECTCONNECTION, REJECTOFFER, RESETBOARDAUTH, RESETBOARDREJECT, RESETBOARDREQUEST, RESETBOARDVOTE, RESETBOARDVOTEREQUEST, RESOURCECOUNT, ROBOTDISMISS, ROLLDICE, ROLLDICEPROMPT, ROLLDICEREQUEST, sep, sep_char, sep2, sep2_char, SERVERPING, SETPLAYEDDEVCARD, SETSEATLOCK, SETTURN, SETUPDONE, SITDOWN, STARTGAME, STATUSMESSAGE, TEXTMSG, TURN, UPDATEROBOTPARAMS, VERSION

Constructor Summary

SOCGameState(java.lang.String ga, int gs)
Create a GameState message.

Method Summary

java.lang.String	getGame()
int	getState()
static SOCGameState	parseDataStr(java.lang.String s) Parse the command String into a GameState message
java.lang.String	toCmd() GAMESTATE sep game sep2 state
static java.lang.String	toCmd(java.lang.String ga, int gs) GAMESTATE sep game sep2 state
java.lang.String	toString() Simple human-readable representation, used for debug purposes.

Methods inherited from class soc.message.SOCMessage

getMaximumVersion, getMinimumVersion, getType, toMsg, toSingleElemArray

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

game

private java.lang.String game

Name of game

state

private int state

Game state

Constructor Detail

SOCGameState

public SOCGameState(java.lang.String ga,
                    int gs)

Create a GameState message.

Parameters:

ga - name of the game

gs - game state

Method Detail

getGame

public java.lang.String getGame()

Returns:

the game name

getState

public int getState()

Returns:

the game state

toCmd

public java.lang.String toCmd()

GAMESTATE sep game sep2 state

Specified by:

toCmd in class SOCMessage

Returns:

the command String

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int gs)

GAMESTATE sep game sep2 state

Parameters:

ga - the game name

gs - the game state

Returns:

the command string

parseDataStr

public static SOCGameState parseDataStr(java.lang.String s)

Parse the command String into a GameState message

Parameters:

s - the String to parse

Returns:

a GameState message, or null of the data is garbled

toString

public java.lang.String toString()

Description copied from class: SOCMessage

Simple human-readable representation, used for debug purposes.

Specified by:

toString in class SOCMessage

Returns:

a human readable form of the message