JSettlers v1.0.6 API
Built ${date}

soc.message
Class SOCDiceResult

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

public class SOCDiceResult
extends SOCMessage

This message reports what was rolled on the dice

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
SOCDiceResult(java.lang.String ga, int dr)
          Create a DiceResult message.
 
Method Summary
 java.lang.String getGame()
           
 int getResult()
           
static SOCDiceResult parseDataStr(java.lang.String s)
          Parse the command String into a DiceResult message
 java.lang.String toCmd()
          DICERESULT sep game sep2 result
static java.lang.String toCmd(java.lang.String ga, int dr)
          DICERESULT sep game sep2 result
 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

SOCDiceResult

public SOCDiceResult(java.lang.String ga,
                     int dr)
Create a DiceResult message.

Parameters:
ga - the name of the game
dr - the dice result
Method Detail

getGame

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

getResult

public int getResult()
Returns:
the dice result

toCmd

public java.lang.String toCmd()
DICERESULT sep game sep2 result

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

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int dr)
DICERESULT sep game sep2 result

Parameters:
ga - the name of the game
dr - the dice result
Returns:
the command string

parseDataStr

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

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