JSettlers v1.0.6 API
Built ${date}

soc.message
Class SOCBuildRequest

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

public class SOCBuildRequest
extends SOCMessage

This message says which player the current player wants to steal from.

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
SOCBuildRequest(java.lang.String ga, int pt)
          Create a BuildRequest message.
 
Method Summary
 java.lang.String getGame()
           
 int getPieceType()
           
static SOCBuildRequest parseDataStr(java.lang.String s)
          Parse the command String into a BuildRequest message
 java.lang.String toCmd()
          BUILDREQUEST sep game sep2 pieceType
static java.lang.String toCmd(java.lang.String ga, int pt)
          BUILDREQUEST sep game sep2 pieceType
 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

SOCBuildRequest

public SOCBuildRequest(java.lang.String ga,
                       int pt)
Create a BuildRequest message.

Parameters:
ga - the name of the game
pt - the type of piece to build
Method Detail

getGame

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

getPieceType

public int getPieceType()
Returns:
the type of piece to build

toCmd

public java.lang.String toCmd()
BUILDREQUEST sep game sep2 pieceType

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

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int pt)
BUILDREQUEST sep game sep2 pieceType

Parameters:
ga - the name of the game
pt - the type of piece to build
Returns:
the command string

parseDataStr

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

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