soc.message
Class SOCPickResourcesRequest

java.lang.Object
  extended by soc.message.SOCMessage
      extended by soc.message.SOCMessageTemplate1i
          extended by soc.message.SOCPickResourcesRequest
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, SOCMessageForGame

public class SOCPickResourcesRequest
extends SOCMessageTemplate1i

This message from server to a client informs the client's player that in a game they're playing, they must pick which resources they want from a gold hex. Client should respond with SOCPickResources.

Similar send/response pattern as SOCDiscardRequest / SOCDiscard.

Since:
2.0.00
Author:
Jeremy D Monin <jeremy@nand.net>
See Also:
Serialized Form

Field Summary
private static long serialVersionUID
           
 
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
SOCPickResourcesRequest(java.lang.String ga, int numRes)
          Create a SOCPickResourcesRequest message.
 
Method Summary
 int getMinimumVersion()
          Minimum version where this message type is used.
static SOCPickResourcesRequest parseDataStr(java.lang.String s)
          Parse the command String into a SOCPickResourcesRequest message
static java.lang.String toCmd(java.lang.String ga, int numRes)
          PICKRESOURCESREQUEST sep game sep2 numResources
 
Methods inherited from class soc.message.SOCMessageTemplate1i
getGame, getParam, toCmd, toCmd, toString
 
Methods inherited from class soc.message.SOCMessage
arrayIntoStringBuf, enumIntoStringBuf, getClassNameShort, getMaximumVersion, 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
See Also:
Constant Field Values
Constructor Detail

SOCPickResourcesRequest

public SOCPickResourcesRequest(java.lang.String ga,
                               int numRes)
Create a SOCPickResourcesRequest message.

Parameters:
ga - the name of the game
numRes - number of resources the client should pick
Method Detail

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int numRes)
PICKRESOURCESREQUEST sep game sep2 numResources

Parameters:
ga - the name of the game
numRes - number of resources the client should pick
Returns:
the command string

parseDataStr

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

Parameters:
s - the String to parse
Returns:
a SOCPickResourcesRequest message, or null if the data is garbled

getMinimumVersion

public int getMinimumVersion()
Minimum version where this message type is used. PICKRESOURCESREQUEST introduced in 2.0.00 for gold hexes on the large sea board.

Overrides:
getMinimumVersion in class SOCMessage
Returns:
Version number, 2000 for JSettlers 2.0.00.