soc.message
Class SOCDiceResult

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, SOCMessageForGame

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.

This is in response to a client player's SOCRollDice request. Will always be followed by SOCGameState (7 might lead to discards or moving the robber, etc.), and sometimes with further messages after that, depending on the roll results and scenario/rules in effect.

When players gain resources on the roll, game members will be sent SOCDiceResultResources for v2.0.00+ clients; older clients will be sent SOCPlayerElement(GAIN, resType, amount) and a text message such as "Joe gets 3 sheep. Mike gets 1 clay."

Players who gain resources on the roll will be sent SOCPlayerElement(SET, resType, amount) messages for all their new resource counts. Before v2.0.00, those were sent to each player in the game after a roll, not just those who gained resources.

Author:

Robert S. Thomas

See Also:

Serialized Form

Field Summary

private static long

serialVersionUID Class converted for v1.1.00 to use SOCMessageTemplate1i.

Fields inherited from class soc.message.SOCMessageTemplate1i

game, p1

Fields inherited from class soc.message.SOCMessage

ACCEPTOFFER, ADMINPING, ADMINRESET, AUTHREQUEST, BANKTRADE, BCASTTEXTMSG, BOARDLAYOUT, BOARDLAYOUT2, BOARDSPECIALEDGE, BUILDREQUEST, BUYCARDREQUEST, CANCELBUILDREQUEST, CHANGEFACE, CHANNELS, CHOOSEPLAYER, CHOOSEPLAYERREQUEST, CLEAROFFER, CLEARTRADEMSG, CREATEACCOUNT, DEBUGFREEPLACE, DELETECHANNEL, DELETEGAME, DEVCARDACTION, DEVCARDCOUNT, DICERESULT, DICERESULTRESOURCES, DISCARD, DISCARDREQUEST, DISCOVERYPICK, ENDTURN, FIRSTPLAYER, GAME_NONE, GAMEMEMBERS, GAMEOPTIONGETDEFAULTS, GAMEOPTIONGETINFOS, GAMEOPTIONINFO, GAMES, GAMESERVERTEXT, GAMESTATE, GAMESTATS, GAMESWITHOPTIONS, GAMETEXTMSG, IMAROBOT, INVENTORYITEMACTION, JOIN, JOINAUTH, JOINGAME, JOINGAMEAUTH, LARGESTARMY, LASTSETTLEMENT, LEAVE, LEAVEALL, LEAVEGAME, LEGALEDGES, LOCALIZEDSTRINGS, LONGESTROAD, MAKEOFFER, MEMBERS, messageType, MONOPOLYPICK, MOVEPIECE, MOVEPIECEREQUEST, MOVEROBBER, NEWCHANNEL, NEWGAME, NEWGAMEWITHOPTIONS, NEWGAMEWITHOPTIONSREQUEST, NULLMESSAGE, PICKRESOURCES, PICKRESOURCESREQUEST, PIECEVALUE, PLAYDEVCARDREQUEST, PLAYERELEMENT, PLAYERELEMENTS, PLAYERSTATS, POTENTIALSETTLEMENTS, PUTPIECE, REJECTCONNECTION, REJECTOFFER, REMOVEPIECE, RESETBOARDAUTH, RESETBOARDREJECT, RESETBOARDREQUEST, RESETBOARDVOTE, RESETBOARDVOTEREQUEST, RESOURCECOUNT, REVEALFOGHEX, ROBOTDISMISS, ROBOTJOINGAMEREQUEST, ROLLDICE, ROLLDICEPROMPT, ROLLDICEREQUEST, SCENARIOINFO, sep, sep_char, sep2, sep2_char, SERVERPING, SETPLAYEDDEVCARD, SETSEATLOCK, SETSPECIALITEM, SETTURN, SETUPDONE, SIMPLEACTION, SIMPLEREQUEST, SITDOWN, STARTGAME, STATUSMESSAGE, SVPTEXTMSG, TEXTMSG, TIMINGPING, 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

arrayIntoStringBuf, enumIntoStringBuf, getClassNameShort, getMaximumVersion, getMinimumVersion, getType, isSingleLineAndSafe, isSingleLineAndSafe, toMsg

Methods inherited from class java.lang.Object

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

Methods inherited from interface soc.message.SOCMessageForGame

getType

Field Detail

serialVersionUID

private static final long serialVersionUID

Class converted for v1.1.00 to use SOCMessageTemplate1i. Over the network, fields are unchanged since v1.0.0 or earlier, per git and old cvs history. -JM

See Also:

Constant Field Values

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