soc.message
Class SOCPieceValue

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

All Implemented Interfaces:

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

public class SOCPieceValue
extends SOCMessageTemplate3i

This message from server updates the value(s) of a piece on the board.

Current uses (v2.0.00):

• Cloth count for a village in the SC_CLVI cloth trade scenario
• Fortress strength in the SC_PIRI pirate islands scenario

Param 1: Coordinate of the piece to be updated
Param 2: New value for the piece
Param 3: New secondary value (if piece has 2 value fields), or 0

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

SOCPieceValue(java.lang.String ga, int coord, int pv1, int pv2)
Create a SOCPieceValue message.

Method Summary

int	getMinimumVersion() Minimum version where this message type is used.
static SOCPieceValue	parseDataStr(java.lang.String s) Parse the command string into a SOCPieceValue message.
static java.lang.String	toCmd(java.lang.String ga, int coord, int pv1, int pv2) PIECEVALUE sep game sep2 coord sep2 pv1 sep2 pv2

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

SOCPieceValue

public SOCPieceValue(java.lang.String ga,
                     int coord,
                     int pv1,
                     int pv2)

Create a SOCPieceValue message.

Parameters:

ga - the name of the game

coord - Coordinate of the piece to be updated

pv1 - New value for the piece

pv2 - New secondary value (if piece has 2 value fields), or 0

Method Detail

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int coord,
                                     int pv1,
                                     int pv2)

PIECEVALUE sep game sep2 coord sep2 pv1 sep2 pv2

Parameters:

ga - the name of the game

coord - Coordinate of the piece to be updated

pv1 - New value for the piece

pv2 - New secondary value (if piece has 2 value fields), or 0

Returns:

the command string

parseDataStr

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

Parse the command string into a SOCPieceValue message.

Parameters:

s - the String to parse; format: game sep2 coord sep2 pv1 sep2 pv2

Returns:

a SOCPieceValue message, or null if parsing errors

getMinimumVersion

public int getMinimumVersion()

Minimum version where this message type is used. PIECEVALUE introduced in 2.0.00 for the cloth villages scenario.

Overrides:

getMinimumVersion in class SOCMessage

Returns:

Version number, 2000 for JSettlers 2.0.00.