soc.message
Class SOCDiceResult

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCMessageTemplate1i
          soc.message.SOCDiceResult

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SOCDiceResult

extends SOCMessageTemplate1i

This message reports total of what was rolled on the dice. The two individual dice amounts can be reported in a text message.

Author:

Robert S. Thomas

See Also:

Serialized Form

Field Summary

Fields inherited from class soc.message.SOCMessageTemplate1i

game, p1

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

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

Method Summary

int	getResult()
static SOCDiceResult	parseDataStr(java.lang.String s) Parse the command String into a DiceResult message
static java.lang.String	toCmd(java.lang.String ga, int dr) DICERESULT sep game sep2 result

Methods inherited from class soc.message.SOCMessageTemplate1i

getGame, getParam, toCmd, toCmd, toString

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

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

getResult

public int getResult()

Returns:

the dice result

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: DICERESULT sep game sep2 result

Returns:

a DiceResult message, or null if the data is garbled