soc.message
Class SOCMovePiece

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCMessageTemplate4i
          soc.message.SOCMovePiece

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, SOCMessageForGame

public class SOCMovePiece
extends SOCMessageTemplate4i

This server-broadcast message announces a player is moving a piece that's already on the board, to a new location. This is a response to all player clients, following a player's SOCMovePieceRequest. If pieceType == ship, the client should also print a line of text such as "* Joe moved a ship."

Since:

2.0.00

Author:

Jeremy D Monin <jeremy@nand.net>

See Also:

SOCMoveRobber, Serialized Form

Field Summary

private static long

serialVersionUID

Fields inherited from class soc.message.SOCMessageTemplate4i

game, p1, p2, p3, p4

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

SOCMovePiece(java.lang.String ga, int pn, int ptype, int fromCoord, int toCoord)
Create a SOCMovePiece message.

Method Summary

int	getFromCoord()
int	getMinimumVersion() Minimum version where this message type is used.
int	getPieceType()
int	getPlayerNumber()
int	getToCoord()
static SOCMovePiece	parseDataStr(java.lang.String s) Parse the command String into a SOCMovePiece message
static java.lang.String	toCmd(java.lang.String ga, int pn, int ptype, int fromCoord, int toCoord) MOVEPIECE sep game sep2 playernumber sep2 ptype sep2 fromCoord sep2 toCoord

Methods inherited from class soc.message.SOCMessageTemplate4i

getGame, getParam1, getParam2, getParam3, getParam4, 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

SOCMovePiece

public SOCMovePiece(java.lang.String ga,
                    int pn,
                    int ptype,
                    int fromCoord,
                    int toCoord)

Create a SOCMovePiece message.

Parameters:

ga - the name of the game

pn - the player number

ptype - piece type, such as SOCPlayingPiece.ROAD

fromCoord - move piece from this coordinate

toCoord - move piece to this coordinate

Method Detail

getPlayerNumber

public int getPlayerNumber()

Returns:

the player number

getPieceType

public int getPieceType()

Returns:

the piece type, such as SOCPlayingPiece.ROAD

getFromCoord

public int getFromCoord()

Returns:

the coordinate to move the piece from

getToCoord

public int getToCoord()

Returns:

the coordinate to move the piece to

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int pn,
                                     int ptype,
                                     int fromCoord,
                                     int toCoord)

MOVEPIECE sep game sep2 playernumber sep2 ptype sep2 fromCoord sep2 toCoord

Parameters:

ga - the name of the game

pn - the player number

ptype - piece type, such as SOCPlayingPiece.ROAD

fromCoord - move piece from this coordinate

toCoord - move piece to this coordinate

Returns:

the command string

parseDataStr

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

Parse the command String into a SOCMovePiece message

Parameters:

s - the String to parse: MOVEPIECE sep game sep2 playernumber sep2 ptype sep2 fromCoord sep2 toCoord

Returns:

a SOCMovePiece message, or null if the data is garbled

getMinimumVersion

public int getMinimumVersion()

Minimum version where this message type is used. MOVEPIECE introduced in 2.0.00.

Overrides:

getMinimumVersion in class SOCMessage

Returns:

Version number, 2000 for JSettlers 2.0.00.