soc.message
Class SOCRemovePiece

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCMessageTemplate3i
          soc.message.SOCRemovePiece

All Implemented Interfaces:

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

public class SOCRemovePiece
extends SOCMessageTemplate3i

This message from server announces a SOCShip removed from the board. Ships are removed when the player makes an attack on their Pirate Fortress and fails to win. Currently, no other piece types are removed in any scenario, but the message allows for other types in case that changes in a later version.

Param 1: Player number owning the piece
Param 2: Type of playing piece, such as SOCPlayingPiece.SHIP
Param 3: Coordinates of the piece to remove

(These parameters are in the same order as in SOCPutPiece.toCmd(String, int, int, int).)

Introduced in v2.0.00 for the pirate islands scenario (_SC_PIRI).

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.SOCMessageTemplate3i

game, p1, p2, p3

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

SOCRemovePiece(java.lang.String ga, int pn, int ptype, int co)
Create a SOCRemovePiece message.

SOCRemovePiece(java.lang.String ga, SOCPlayingPiece pp)
Create a SOCRemovePiece message for this piece.

Method Summary

int	getMinimumVersion() Minimum version where this message type is used.
static SOCRemovePiece	parseDataStr(java.lang.String s) Parse the command string into a SOCRemovePiece message.
static java.lang.String	toCmd(java.lang.String ga, int pn, int ptype, int co) REMOVEPIECE sep game sep2 pn sep2 ptype sep2 co

Methods inherited from class soc.message.SOCMessageTemplate3i

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

SOCRemovePiece

public SOCRemovePiece(java.lang.String ga,
                      int pn,
                      int ptype,
                      int co)

Create a SOCRemovePiece message.

Parameters:

ga - the name of the game

pn - player number owning the piece

ptype - type of playing piece, such as SOCPlayingPiece.SHIP

co - coordinates of the piece to remove

SOCRemovePiece

public SOCRemovePiece(java.lang.String ga,
                      SOCPlayingPiece pp)

Create a SOCRemovePiece message for this piece.

Parameters:

ga - the name of the game

pp - the playing piece to remove

Method Detail

toCmd

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

REMOVEPIECE sep game sep2 pn sep2 ptype sep2 co

Parameters:

ga - the name of the game

pn - player number owning the piece

ptype - type of playing piece, such as SOCPlayingPiece.SHIP

co - coordinates of the piece to remove

Returns:

the command string

parseDataStr

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

Parse the command string into a SOCRemovePiece message.

Parameters:

s - the String to parse; format: game sep2 pn sep2 ptype sep2 co

Returns:

a SOCRemovePiece message, or null if parsing errors

getMinimumVersion

public int getMinimumVersion()

Minimum version where this message type is used. REMOVEPIECE introduced in 2.0.00 for the pirate islands scenario (_SC_PIRI).

Overrides:

getMinimumVersion in class SOCMessage

Returns:

Version number, 2000 for JSettlers 2.0.00.