soc.message
Class SOCSetTurn

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCMessageTemplate1i
          soc.message.SOCSetTurn

All Implemented Interfaces:

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

public class SOCSetTurn
extends SOCMessageTemplate1i

This message from server to client says whose turn it is. Only the game's current player number should change; no other game state is updated.

Author:

Robert S. Thomas

See Also:

SOCTurn, Serialized Form

Field Summary

private static long

serialVersionUID Class converted for v1.1.00 to use SOCMessageTemplate1i.

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

SOCSetTurn(java.lang.String ga, int pn)
Create a SetTurn message.

Method Summary

int	getPlayerNumber()
static SOCSetTurn	parseDataStr(java.lang.String s) Parse the command String into a SetTurn message
static java.lang.String	toCmd(java.lang.String ga, int pn) SETTURN 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, getMinimumVersion, 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 converted for v1.1.00 to use SOCMessageTemplate1i. Over the network, fields are unchanged since v1.0.0 or earlier, per git and old cvs history. -JM

See Also:

Constant Field Values

Constructor Detail

SOCSetTurn

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

Create a SetTurn message.

Parameters:

ga - the name of the game

pn - the seat number

Method Detail

getPlayerNumber

public int getPlayerNumber()

Returns:

the seat number

toCmd

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

SETTURN sep game sep2 playerNumber

Parameters:

ga - the name of the game

pn - the seat number

Returns:

the command string

parseDataStr

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

Parse the command String into a SetTurn message

Parameters:

s - the String to parse: SETTURN sep game sep2 playerNumber

Returns:

a StartGame message, or null if the data is garbled