JSettlers v1.0.6 API
Built ${date}

soc.message
Class SOCGameStats

java.lang.Object
  extended bysoc.message.SOCMessage
      extended bysoc.message.SOCGameStats
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class SOCGameStats
extends SOCMessage

This message contains the scores for the people at a game. Used for displaying games in the player client list.

Author:
Robert S. Thomas
See Also:
Serialized Form

Field Summary
 
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, RESOURCECOUNT, ROBOTDISMISS, ROLLDICE, ROLLDICEREQUEST, sep, sep2, SERVERPING, SETPLAYEDDEVCARD, SETSEATLOCK, SETTURN, SETUPDONE, SITDOWN, STARTGAME, STATUSMESSAGE, TEXTMSG, TURN, UPDATEROBOTPARAMS
 
Constructor Summary
SOCGameStats(java.lang.String ga, int[] sc, boolean[] rb)
          Create a GameStats message
 
Method Summary
 java.lang.String getGame()
           
 boolean[] getRobotSeats()
           
 int[] getScores()
           
static SOCGameStats parseDataStr(java.lang.String s)
          Parse the command String into a GameStatss message
 java.lang.String toCmd()
          Converts the contents of this message into a String that can be transferred by a client or server.
static java.lang.String toCmd(java.lang.String ga, int[] sc, boolean[] rb)
           
 java.lang.String toString()
           
 
Methods inherited from class soc.message.SOCMessage
getType, toMsg
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SOCGameStats

public SOCGameStats(java.lang.String ga,
                    int[] sc,
                    boolean[] rb)
Create a GameStats message

Parameters:
ga - the name of the game
sc - the scores
rb - where robots are sitting
Method Detail

getGame

public java.lang.String getGame()
Returns:
the name of the game

getScores

public int[] getScores()
Returns:
the scores

getRobotSeats

public boolean[] getRobotSeats()
Returns:
where the robots are sitting

toCmd

public java.lang.String toCmd()
Description copied from class: SOCMessage
Converts the contents of this message into a String that can be transferred by a client or server.

Specified by:
toCmd in class SOCMessage
Returns:
the command string

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int[] sc,
                                     boolean[] rb)
Parameters:
ga - the name of the game
sc - the scores
rb - where robots are sitting
Returns:
the command string

parseDataStr

public static SOCGameStats parseDataStr(java.lang.String s)
Parse the command String into a GameStatss message

Parameters:
s - the String to parse
Returns:
a GameStats message, or null of the data is garbled

toString

public java.lang.String toString()
Returns:
a human readable form of the message

JSettlers v1.0.6 API
Built ${date}