soc.message
Class SOCResetBoardVoteRequest

java.lang.Object
  extended by soc.message.SOCMessage
      extended by soc.message.SOCMessageTemplate1i
          extended by soc.message.SOCResetBoardVoteRequest
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, SOCMessageForGame

public class SOCResetBoardVoteRequest
extends SOCMessageTemplate1i

This message from server informs the client that in a game they're playing, another player requests a "board reset" (new game with same name and players, new layout), and they should vote yes or no. This won't be sent to robots: robots are assumed to vote yes and go along.

Since:
1.1.00
Author:
Jeremy D Monin <jeremy@nand.net>
See Also:
SOCResetBoardRequest, Serialized Form

Field Summary
private static long serialVersionUID
           
 
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
SOCResetBoardVoteRequest(java.lang.String ga, int reqpn)
          Create a SOCResetBoardVoteRequest message.
 
Method Summary
 int getMinimumVersion()
          Minimum version where this message type is used.
 int getRequestingPlayer()
           
static SOCResetBoardVoteRequest parseDataStr(java.lang.String s)
          Parse the command String into a SOCResetBoardVoteRequest message
static java.lang.String toCmd(java.lang.String ga, int reqpn)
          RESETBOARDVOTEREQUEST sep game sep2 playernumber
 
Methods inherited from class soc.message.SOCMessageTemplate1i
getGame, getParam, toCmd, toCmd, toString
 
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
See Also:
Constant Field Values
Constructor Detail

SOCResetBoardVoteRequest

public SOCResetBoardVoteRequest(java.lang.String ga,
                                int reqpn)
Create a SOCResetBoardVoteRequest message.

Parameters:
ga - the name of the game
reqpn - player number who requested the reset
Method Detail

getRequestingPlayer

public int getRequestingPlayer()
Returns:
the player number of the player who requested the board reset

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int reqpn)
RESETBOARDVOTEREQUEST sep game sep2 playernumber

Parameters:
ga - the name of the game
reqpn - player number who requested the reset
Returns:
the command string

parseDataStr

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

Parameters:
s - the String to parse
Returns:
a SOCResetBoardVoteRequest message, or null if the data is garbled

getMinimumVersion

public int getMinimumVersion()
Minimum version where this message type is used. RESETBOARDVOTEREQUEST introduced in 1.1.00 for reset-board feature.

Overrides:
getMinimumVersion in class SOCMessage
Returns:
Version number, 1100 for JSettlers 1.1.00.