soc.message
Class SOCRevealFogHex

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

All Implemented Interfaces:

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

public class SOCRevealFogHex
extends SOCMessageTemplate3i

This message from server reveals a hex previously hidden by fog on the large sea board. Hexes are revealed by placing roads or ships that touch a corner of a fog hex. This message is sent out before the SOCPutPiece for the new road or ship.

Param 1: Coordinate of the land hex to reveal
Param 2: Revealed hex type, same value as SOCBoard.getHexTypeFromCoord(int)
Param 3: Revealed hex dice number, same value as SOCBoard.getNumberOnHexFromCoord(int), or 0

Used with game option/scenario SOCGameOption.K_SC_FOG.

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

SOCRevealFogHex(java.lang.String ga, int hexCoord, int hexType, int diceNum)
Create a SOCRevealFogHex message.

Method Summary

int	getMinimumVersion() Minimum version where this message type is used.
static SOCRevealFogHex	parseDataStr(java.lang.String s) Parse the command string into a SOCRevealFogHex message.
static java.lang.String	toCmd(java.lang.String ga, int hexCoord, int hexType, int diceNum) REVEALFOGHEX sep game sep2 hexcoord sep2 hextype sep2 dicenum

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

SOCRevealFogHex

public SOCRevealFogHex(java.lang.String ga,
                       int hexCoord,
                       int hexType,
                       int diceNum)

Create a SOCRevealFogHex message.

Parameters:

ga - the name of the game

hexCoord - Coordinate of the land hex to reveal

hexType - Revealed hex type, same value as SOCBoard.getHexTypeFromCoord(int)

diceNum - Revealed hex dice number, same value as SOCBoard.getNumberOnHexFromCoord(int), or 0

Method Detail

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int hexCoord,
                                     int hexType,
                                     int diceNum)

REVEALFOGHEX sep game sep2 hexcoord sep2 hextype sep2 dicenum

Parameters:

ga - the name of the game

hexCoord - Coordinate of the land hex to reveal

hexType - Revealed hex type, same value as SOCBoard.getHexTypeFromCoord(int)

diceNum - Revealed hex dice number, same value as SOCBoard.getNumberOnHexFromCoord(int), or 0

Returns:

the command string

parseDataStr

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

Parse the command string into a SOCRevealFogHex message.

Parameters:

s - the String to parse; format: game sep2 hexcoord sep2 hextype sep2 dicenum

Returns:

a SOCRevealFogHex message, or null if parsing errors

getMinimumVersion

public int getMinimumVersion()

Minimum version where this message type is used. REVEALFOGHEX introduced in 2.0.00 for fog on the large sea board.

Overrides:

getMinimumVersion in class SOCMessage

Returns:

Version number, 2000 for JSettlers 2.0.00.