JSettlers v1.0.6 API
Built ${date}

soc.message
Class SOCResourceCount

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

public class SOCResourceCount
extends SOCMessage

This message has the total resource count for a player

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
SOCResourceCount(java.lang.String ga, int pn, int rc)
          Create a ResourceCount message.
 
Method Summary
 int getCount()
           
 java.lang.String getGame()
           
 int getPlayerNumber()
           
static SOCResourceCount parseDataStr(java.lang.String s)
          Parse the command String into a ResourceCount message
 java.lang.String toCmd()
          RESOURCECOUNT sep game sep2 playerNumber sep2 count
static java.lang.String toCmd(java.lang.String ga, int pn, int rc)
          RESOURCECOUNT sep game sep2 playerNumber sep2 count
 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

SOCResourceCount

public SOCResourceCount(java.lang.String ga,
                        int pn,
                        int rc)
Create a ResourceCount message.

Parameters:
ga - the name of the game
pn - the seat number
rc - the resource count
Method Detail

getGame

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

getPlayerNumber

public int getPlayerNumber()
Returns:
the seat number

getCount

public int getCount()
Returns:
the recource count

toCmd

public java.lang.String toCmd()
RESOURCECOUNT sep game sep2 playerNumber sep2 count

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

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int pn,
                                     int rc)
RESOURCECOUNT sep game sep2 playerNumber sep2 count

Parameters:
ga - the name of the game
pn - the seat number
rc - the resource count
Returns:
the command string

parseDataStr

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

Parameters:
s - the String to parse
Returns:
a ResourceCount 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}