soc.message
Class SOCRollDicePrompt

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

All Implemented Interfaces:

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

public class SOCRollDicePrompt
extends SOCMessage
implements SOCMessageForGame

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.

If the player is rolling the dice, they will respond with SOCRollDice, or SOCPlayDevCardRequest to play a development card instead.

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
private static long	serialVersionUID Class marked for v1.1.11 with SOCMessageForGame.

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

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

Method Summary

java.lang.String	getGame() Name of game this message is for.
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

arrayIntoStringBuf, enumIntoStringBuf, getClassNameShort, getMaximumVersion, 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 marked for v1.1.11 with SOCMessageForGame. Introduced at v1.1.00.

See Also:

Constant Field Values

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()

Description copied from interface: SOCMessageForGame

Name of game this message is for. Must not be null if message is in per-game structures or code.

At the server, the message treater dispatches incoming SOCMessageForGames based on their getGame():

• null: Message is ignored
• SOCMessage.GAME_NONE: Message is handled by SOCServer itself
• Any other game name: Looks for a game with that name, to dispatch to the GameHandler for that game's type. If no game with that name is found, the message is ignored.

Specified by:

getGame in interface SOCMessageForGame

Returns:

the name of the game

See Also:

SOCMessage.GAME_NONE

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.