soc.message
Class SOCMoveRobber

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

public class SOCMoveRobber
extends SOCMessage

This message means that a player wants to move the robber

Author:
Robert S Thomas
See Also:
Serialized Form

Field Summary
private  int coordinates
          the coordinates of the piece
private  java.lang.String game
          the name of the game
private  int playerNumber
          the number of the player moving the robber
 
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
SOCMoveRobber(java.lang.String na, int pn, int co)
          create a MoveRobber message
 
Method Summary
 int getCoordinates()
           
 java.lang.String getGame()
           
 int getPlayerNumber()
           
static SOCMoveRobber parseDataStr(java.lang.String s)
          parse the command string into a MoveRobber message
 java.lang.String toCmd()
          Command string: MOVEROBBER sep game sep2 playerNumber sep2 coordinates
static java.lang.String toCmd(java.lang.String na, int pn, int co)
          Command string: MOVEROBBER sep game sep2 playerNumber sep2 coordinates
 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
the name of the game


playerNumber

private int playerNumber
the number of the player moving the robber


coordinates

private int coordinates
the coordinates of the piece

Constructor Detail

SOCMoveRobber

public SOCMoveRobber(java.lang.String na,
                     int pn,
                     int co)
create a MoveRobber message

Parameters:
na - name of the game
pn - player number
co - coordinates
Method Detail

getGame

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

getPlayerNumber

public int getPlayerNumber()
Returns:
the player number

getCoordinates

public int getCoordinates()
Returns:
the coordinates

toCmd

public java.lang.String toCmd()
Command string: MOVEROBBER sep game sep2 playerNumber sep2 coordinates

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

toCmd

public static java.lang.String toCmd(java.lang.String na,
                                     int pn,
                                     int co)
Command string: MOVEROBBER sep game sep2 playerNumber sep2 coordinates

Parameters:
na - the name of the game
pn - player number
co - coordinates
Returns:
the command string

parseDataStr

public static SOCMoveRobber parseDataStr(java.lang.String s)
parse the command string into a MoveRobber message

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