soc.message
Class SOCLongestRoad

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

public class SOCLongestRoad
extends SOCMessage

This message says which player has longest road. Sent from server during joinGame. During normal gameplay, "longest road" indicator at client is updated by examining game state, not by messages from server.

Author:
Robert S. Thomas
See Also:
Serialized Form

Field Summary
private  java.lang.String game
          Name of game
private  int playerNumber
          The number of the player with longest road
 
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
SOCLongestRoad(java.lang.String ga, int pn)
          Create a LongestRoad message.
 
Method Summary
 java.lang.String getGame()
           
 int getPlayerNumber()
           
static SOCLongestRoad parseDataStr(java.lang.String s)
          Parse the command String into a StartGame message
 java.lang.String toCmd()
          LONGESTROAD sep game sep2 playerNumber
static java.lang.String toCmd(java.lang.String ga, int pn)
          LONGESTROAD sep game sep2 playerNumber
 java.lang.String toString()
          Simple human-readable representation, used for debug purposes.
 
Methods inherited from class soc.message.SOCMessage
getMaximumVersion, getMinimumVersion, getType, toMsg, toSingleElemArray
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

game

private java.lang.String game
Name of game


playerNumber

private int playerNumber
The number of the player with longest road

Constructor Detail

SOCLongestRoad

public SOCLongestRoad(java.lang.String ga,
                      int pn)
Create a LongestRoad 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 number of the player with longest road

toCmd

public java.lang.String toCmd()
LONGESTROAD 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)
LONGESTROAD sep game sep2 playerNumber

Parameters:
ga - the name of the game
pn - the seat number
Returns:
the command string

parseDataStr

public static SOCLongestRoad 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()
Description copied from class: SOCMessage
Simple human-readable representation, used for debug purposes.

Specified by:
toString in class SOCMessage
Returns:
a human readable form of the message