soc.message
Class SOCResetBoardVote

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCMessageTemplate2i
          soc.message.SOCResetBoardVote

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SOCResetBoardVote

extends SOCMessageTemplate2i

This bi-directional message gives the client's vote on a "board reset", which was requested by another player in that game.

• This message to server is in response to a SOCResetBoardRequest sent earlier this turn to all non-robot clients. (Robots' vote is always Yes.)
• Followed by (from server, to all clients) SOCResetBoardVote with the same data, informing all players of this client's vote.
• Once voting is complete, server sends to all either a SOCResetBoardAuth or SOCResetBoardReject message.

For details of messages sent, see SOCServer.resetBoardAndNotify(String, int).

Author:

Jeremy D. Monin

See Also:

Serialized Form

Field Summary

Fields inherited from class soc.message.SOCMessageTemplate2i

game, p1, p2

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

SOCResetBoardVote(java.lang.String ga, int pn, boolean pyes)
Create a SOCResetBoardVoteRequest message.

Method Summary

int	getMinimumVersion() Minimum version where this message type is used.
int	getPlayerNumber()
boolean	getPlayerVote()
static SOCResetBoardVote	parseDataStr(java.lang.String s) Parse the command String into a SOCResetBoardVote message
static java.lang.String	toCmd(java.lang.String ga, int pn, boolean pyes) RESETBOARDVOTE sep game sep2 playernumber sep2 yesno [Yes is 1, No is 0]

Methods inherited from class soc.message.SOCMessageTemplate2i

getGame, getParam1, getParam2, toCmd, toCmd, toString

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

Constructor Detail

SOCResetBoardVote

public SOCResetBoardVote(java.lang.String ga,
                         int pn,
                         boolean pyes)

Create a SOCResetBoardVoteRequest message.

Parameters:

ga - the name of the game

pn - the player position who voted (used when sending to other clients)

pyes - did they vote yes

Method Detail

getPlayerNumber

public int getPlayerNumber()

Returns:

the voter's player number

getPlayerVote

public boolean getPlayerVote()

Returns:

if true, the vote is Yes

toCmd

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

RESETBOARDVOTE sep game sep2 playernumber sep2 yesno [Yes is 1, No is 0]

Parameters:

ga - the name of the game

pn - the voter's player number

pyes - if the vote was yes

Returns:

the command string

parseDataStr

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

Parse the command String into a SOCResetBoardVote message

Parameters:

s - the String to parse: RESETBOARDVOTE sep game sep2 playernumber sep2 yesno [1 or 0]

Returns:

a SOCResetBoardVote message, or null if the data is garbled

getMinimumVersion

public int getMinimumVersion()

Minimum version where this message type is used. RESETBOARDVOTE introduced in 1.1.00 for reset-board feature.

Overrides:

getMinimumVersion in class SOCMessage

Returns:

Version number, 1100 for JSettlers 1.1.00.