JSettlers v1.0.6 API
Built ${date}

soc.message
Class SOCStartGame

java.lang.Object
  extended bysoc.message.SOCMessage
      extended bysoc.message.SOCStartGame
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class SOCStartGame
extends SOCMessage

This message means that a player wants to start the game

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
SOCStartGame(java.lang.String ga)
          Create a StartGame message.
 
Method Summary
 java.lang.String getGame()
           
static SOCStartGame parseDataStr(java.lang.String s)
          Parse the command String into a StartGame message
 java.lang.String toCmd()
          STARTGAME sep game
static java.lang.String toCmd(java.lang.String ga)
          STARTGAME sep game
 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

SOCStartGame

public SOCStartGame(java.lang.String ga)
Create a StartGame message.

Parameters:
ga - the name of the game
Method Detail

getGame

public java.lang.String getGame()
Returns:
the name of the game

toCmd

public java.lang.String toCmd()
STARTGAME sep game

Specified by:
toCmd in class SOCMessage
Returns:
the command string

toCmd

public static java.lang.String toCmd(java.lang.String ga)
STARTGAME sep game

Parameters:
ga - the name of the game
Returns:
the command string

parseDataStr

public static SOCStartGame 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

JSettlers v1.0.6 API
Built ${date}