soc.message
Class SOCResetBoardAuth

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

All Implemented Interfaces:

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

public class SOCResetBoardAuth
extends SOCMessageTemplate2i

This message from server informs the client that a game they're playing has been "reset" to a new game (with same name and players, new layout), and they should join at the given position.

For human players, this message replaces the SOCJoinGameAuth seen when joining a brand-new game; the reset message will be followed with others which will fill in the game state.

For robots, they must discard game state and ask to re-join. Robot client treats as a SOCRobotJoinGameRequest: Asks to join the new game.

Follows SOCResetBoardRequest and SOCResetBoardVote messages. For details of messages sent, see SOCServer.resetBoardAndNotify(String, int).

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.SOCMessageTemplate2i

game, p1, p2

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

SOCResetBoardAuth(java.lang.String ga, int joinpn, int reqpn)
Create a ResetBoardAuth message.

Method Summary

int	getMinimumVersion() Minimum version where this message type is used.
int	getRejoinPlayerNumber()
int	getRequestingPlayerNumber()
static SOCResetBoardAuth	parseDataStr(java.lang.String s) Parse the command String into a SOCResetBoardAuth message

Methods inherited from class soc.message.SOCMessageTemplate2i

getGame, getParam1, getParam2, 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

SOCResetBoardAuth

public SOCResetBoardAuth(java.lang.String ga,
                         int joinpn,
                         int reqpn)

Create a ResetBoardAuth message.

Parameters:

ga - the name of the game

joinpn - the player position number at which to join

reqpn - player number who requested the reset

Method Detail

getRejoinPlayerNumber

public int getRejoinPlayerNumber()

Returns:

the player position number at which to rejoin

getRequestingPlayerNumber

public int getRequestingPlayerNumber()

Returns:

the number of the player who requested the board reset

parseDataStr

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

Parse the command String into a SOCResetBoardAuth message

Parameters:

s - the String to parse: RESETBOARDAUTH sep game sep2 playernumber sep2 requester

Returns:

a SOCResetBoardAuth message, or null if the data is garbled

getMinimumVersion

public int getMinimumVersion()

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

Overrides:

getMinimumVersion in class SOCMessage

Returns:

Version number, 1100 for JSettlers 1.1.00.