soc.message
Class SOCPutPiece

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCPutPiece

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SOCPutPiece

extends SOCMessage

This message means that a player has placed a piece on the board

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	pieceType the type of piece being placed
private int	playerNumber the player number of who played the piece

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

SOCPutPiece(java.lang.String na, int pn, int pt, int co)
create a PutPiece message

Method Summary

int	getCoordinates()
java.lang.String	getGame()
int	getPieceType()
int	getPlayerNumber()
static SOCPutPiece	parseDataStr(java.lang.String s) parse the command string into a PutPiece message
java.lang.String	toCmd() Command string: PUTPIECE sep game sep2 playerNumber sep2 pieceType sep2 coordinates
static java.lang.String	toCmd(java.lang.String na, int pn, int pt, int co) Command string: PUTPIECE sep game sep2 playerNumber sep2 pieceType 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

pieceType

private int pieceType

the type of piece being placed

playerNumber

private int playerNumber

the player number of who played the piece

coordinates

private int coordinates

the coordinates of the piece

Constructor Detail

SOCPutPiece

public SOCPutPiece(java.lang.String na,
                   int pn,
                   int pt,
                   int co)

create a PutPiece message

Parameters:

na - name of the game

pt - type of playing piece

pn - player number

co - coordinates

Method Detail

getGame

public java.lang.String getGame()

Returns:

the name of the game

getPieceType

public int getPieceType()

Returns:

the type of playing piece

getPlayerNumber

public int getPlayerNumber()

Returns:

the player number

getCoordinates

public int getCoordinates()

Returns:

the coordinates

toCmd

public java.lang.String toCmd()

Command string: PUTPIECE sep game sep2 playerNumber sep2 pieceType 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 pt,
                                     int co)

Command string: PUTPIECE sep game sep2 playerNumber sep2 pieceType sep2 coordinates

Parameters:

na - the name of the game

pt - type of playing piece

pn - player number

co - coordinates

Returns:

the command string

parseDataStr

public static SOCPutPiece parseDataStr(java.lang.String s)

parse the command string into a PutPiece 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