soc.message
Class SOCFirstPlayer

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCFirstPlayer

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SOCFirstPlayer

extends SOCMessage

This message says who the first player is

Author:

Robert S. Thomas

See Also:

Serialized Form

Field Summary

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, RESOURCECOUNT, ROBOTDISMISS, ROLLDICE, ROLLDICEREQUEST, sep, sep2, SERVERPING, SETPLAYEDDEVCARD, SETSEATLOCK, SETTURN, SETUPDONE, SITDOWN, STARTGAME, STATUSMESSAGE, TEXTMSG, TURN, UPDATEROBOTPARAMS

Constructor Summary

SOCFirstPlayer(java.lang.String ga, int pn)
Create a FirstPlayer message.

Method Summary

java.lang.String	getGame()
int	getPlayerNumber()
static SOCFirstPlayer	parseDataStr(java.lang.String s) Parse the command String into a StartGame message
java.lang.String	toCmd() FIRSTPLAYER sep game sep2 playerNumber
static java.lang.String	toCmd(java.lang.String ga, int pn) FIRSTPLAYER sep game sep2 playerNumber
java.lang.String	toString()

Methods inherited from class soc.message.SOCMessage

getType, toMsg

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SOCFirstPlayer

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

Create a FirstPlayer message.

Parameters:

ga - the name of the game

pn - the seat number

Method Detail

getGame

public java.lang.String getGame()

Returns:

the name of the game

getPlayerNumber

public int getPlayerNumber()

Returns:

the seat number

toCmd

public java.lang.String toCmd()

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

FIRSTPLAYER sep game sep2 playerNumber

Parameters:

ga - the name of the game

pn - the seat number

Returns:

the command string

parseDataStr

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

Parse the command String into a StartGame message

Parameters:

s - the String to parse

Returns:

a StartGame message, or null of the data is garbled

toString

public java.lang.String toString()

Returns:

a human readable form of the message