soc.message
Class SOCRollDicePrompt

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCRollDicePrompt

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SOCRollDicePrompt

extends SOCMessage

This message from server informs all players whose turn it is, so they may roll the dice, or take other action allowable at that time.

Author:

Jeremy D. Monin

See Also:

Serialized Form

Field Summary

private java.lang.String	game Name of game
private int	playerNumber The player whose turn it is to roll

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

SOCRollDicePrompt(java.lang.String ga, int pn)
Create a RollDicePrompt message.

Method Summary

java.lang.String	getGame()
int	getMinimumVersion() Minimum version where this message type is used.
int	getPlayerNumber()
static SOCRollDicePrompt	parseDataStr(java.lang.String s) Parse the command String into a RollDiceRequest message
java.lang.String	toCmd() ROLLDICEPROMPT sep game sep2 playernumber
static java.lang.String	toCmd(java.lang.String ga, int pn) ROLLDICEPROMPT sep game sep2 playernumber
java.lang.String	toString() Simple human-readable representation, used for debug purposes.

Methods inherited from class soc.message.SOCMessage

getMaximumVersion, getType, toMsg, toSingleElemArray

Methods inherited from class java.lang.Object

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

Field Detail

game

private java.lang.String game

Name of game

playerNumber

private int playerNumber

The player whose turn it is to roll

Constructor Detail

SOCRollDicePrompt

public SOCRollDicePrompt(java.lang.String ga,
                         int pn)

Create a RollDicePrompt message.

Parameters:

ga - the name of the game

pn - the player number who should roll

Method Detail

getGame

public java.lang.String getGame()

Returns:

the name of the game

getPlayerNumber

public int getPlayerNumber()

Returns:

the player number whose turn it is to roll dice

toCmd

public java.lang.String toCmd()

ROLLDICEPROMPT sep game sep2 playernumber

Specified by:

toCmd in class SOCMessage

Returns:

the command string

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int pn)

ROLLDICEPROMPT sep game sep2 playernumber

Parameters:

ga - the name of the game

pn - the player number to roll

Returns:

the command string

parseDataStr

public static SOCRollDicePrompt parseDataStr(java.lang.String s)

Parse the command String into a RollDiceRequest message

Parameters:

s - the String to parse

Returns:

a DiceResult message, or null of the data is garbled

toString

public java.lang.String toString()

Description copied from class: SOCMessage

Simple human-readable representation, used for debug purposes.

Specified by:

toString in class SOCMessage

Returns:

a human readable form of the message

getMinimumVersion

public int getMinimumVersion()

Minimum version where this message type is used. ROLLDICEPROMPT introduced in 1.1.00 for automatic rolling after x seconds.

Overrides:

getMinimumVersion in class SOCMessage

Returns:

Version number, 1100 for JSettlers 1.1.00.