JSettlers v1.0.6 API
Built ${date}

soc.message
Class SOCDiscoveryPick

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

public class SOCDiscoveryPick
extends SOCMessage

This message says which resources the player picked for a Discovery card

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
SOCDiscoveryPick(java.lang.String ga, SOCResourceSet rs)
          Create a DiscoveryPick message.
 
Method Summary
 java.lang.String getGame()
           
 SOCResourceSet getResources()
           
static SOCDiscoveryPick parseDataStr(java.lang.String s)
          Parse the command String into a DiscoveryPick message
 java.lang.String toCmd()
          Converts the contents of this message into a String that can be transferred by a client or server.
static java.lang.String toCmd(java.lang.String ga, SOCResourceSet rs)
           
 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

SOCDiscoveryPick

public SOCDiscoveryPick(java.lang.String ga,
                        SOCResourceSet rs)
Create a DiscoveryPick message.

Parameters:
ga - the name of the game
rs - the chosen resources
Method Detail

getGame

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

getResources

public SOCResourceSet getResources()
Returns:
the chosen resources

toCmd

public java.lang.String toCmd()
Description copied from class: SOCMessage
Converts the contents of this message into a String that can be transferred by a client or server.

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

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     SOCResourceSet rs)
Parameters:
ga - the name of the game
rs - the chosen resources
Returns:
the command string

parseDataStr

public static SOCDiscoveryPick parseDataStr(java.lang.String s)
Parse the command String into a DiscoveryPick message

Parameters:
s - the String to parse
Returns:
a DiscoveryPick 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}