soc.message
Class SOCBoardSpecialEdge

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCMessageTemplate2i
          soc.message.SOCBoardSpecialEdge

All Implemented Interfaces:

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

public class SOCBoardSpecialEdge
extends SOCMessageTemplate2i

This message from the server to clients announces that an edge on the game board has become a Special Edge, or is no longer a Special Edge. Used in some game scenarios. Applies only to games using SOCBoardLarge.

Param 1: The edge coordinate
Param 2: Its new special edge type, such as SOCBoardLarge.SPECIAL_EDGE_DEV_CARD, 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.SOCMessageTemplate2i

game, p1, p2

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

SOCBoardSpecialEdge(java.lang.String ga, int edge, int seType)
Create a SOCBoardSpecialEdge message.

Method Summary

int	getMinimumVersion() Minimum version where this message type is used.
static SOCBoardSpecialEdge	parseDataStr(java.lang.String s) Parse the command String into a SOCBoardSpecialEdge message.
static java.lang.String	toCmd(java.lang.String ga, int edge, int seType) BOARDSPECIALEDGE sep game sep2 edge sep2 seType

Methods inherited from class soc.message.SOCMessageTemplate2i

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

SOCBoardSpecialEdge

public SOCBoardSpecialEdge(java.lang.String ga,
                           int edge,
                           int seType)

Create a SOCBoardSpecialEdge message.

Parameters:

ga - the name of the game

edge - the edge coordinate

seType - the special edge type, such as SOCBoardLarge.SPECIAL_EDGE_DEV_CARD, or 0

Method Detail

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int edge,
                                     int seType)

BOARDSPECIALEDGE sep game sep2 edge sep2 seType

Parameters:

ga - the name of the game

edge - the edge coordinate

seType - the special edge type, such as SOCBoardLarge.SPECIAL_EDGE_DEV_CARD, or 0

Returns:

the command string

parseDataStr

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

Parse the command String into a SOCBoardSpecialEdge message.

Parameters:

s - the String to parse: BOARDSPECIALEDGE sep game sep2 edge sep2 seType

Returns:

a SOCBoardSpecialEdge message, or null if the data is garbled

getMinimumVersion

public final int getMinimumVersion()

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

Overrides:

getMinimumVersion in class SOCMessage

Returns:

Version number, 2000 for JSettlers 2.0.00.