soc.message
Class SOCBoardLayout

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCBoardLayout

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SOCBoardLayout

extends SOCMessage

This message contains the board layout information. That is, the hex layout, the number layout, and where the robber is. This does not contain information about where the player's pieces are on the board.

Author:

Robert S. Thomas

See Also:

Serialized Form

Field Summary

private java.lang.String	game Name of game
private int[]	hexLayout The hex layout
private int[]	numberLayout The number layout
private int	robberHex Where the robber is

Fields inherited from class soc.message.SOCMessage

ACCEPTOFFER, ADMINPING, ADMINRESET, BANKTRADE, BCASTTEXTMSG, BOARDLAYOUT, BUILDREQUEST, BUYCARDREQUEST, CANCELBUILDREQUEST, CHANGEFACE, CHANNELS, CHOOSEPLAYER, CHOOSEPLAYERREQUEST, CLEAROFFER, CLEARTRADEMSG, CREATEACCOUNT, DELETECHANNEL, DELETEGAME, DEVCARD, DEVCARDCOUNT, DICERESULT, DISCARD, DISCARDREQUEST, DISCOVERYPICK, ENDTURN, FIRSTPLAYER, GAMEMEMBERS, GAMES, GAMESTATE, GAMESTATS, GAMETEXTMSG, IMAROBOT, JOIN, JOINAUTH, JOINGAME, JOINGAMEAUTH, JOINGAMEREQUEST, LARGESTARMY, LASTSETTLEMENT, LEAVE, LEAVEALL, LEAVEGAME, LONGESTROAD, MAKEOFFER, MEMBERS, messageType, MONOPOLYPICK, MOVEROBBER, NEWCHANNEL, NEWGAME, NULLMESSAGE, PLAYDEVCARDREQUEST, PLAYERELEMENT, POTENTIALSETTLEMENTS, PUTPIECE, REJECTCONNECTION, REJECTOFFER, RESETBOARDAUTH, RESETBOARDREJECT, RESETBOARDREQUEST, RESETBOARDVOTE, RESETBOARDVOTEREQUEST, RESOURCECOUNT, ROBOTDISMISS, ROLLDICE, ROLLDICEPROMPT, ROLLDICEREQUEST, sep, sep_char, sep2, sep2_char, SERVERPING, SETPLAYEDDEVCARD, SETSEATLOCK, SETTURN, SETUPDONE, SITDOWN, STARTGAME, STATUSMESSAGE, TEXTMSG, TURN, UPDATEROBOTPARAMS, VERSION

Constructor Summary

SOCBoardLayout(java.lang.String ga, int[] hl, int[] nl, int rh)
Create a SOCBoardLayout message

Method Summary

java.lang.String	getGame()
int[]	getHexLayout()
int[]	getNumberLayout()
int	getRobberHex()
static SOCBoardLayout	parseDataStr(java.lang.String s) Parse the command String into a BoardLayout message
java.lang.String	toCmd() BOARDLAYOUT sep game sep2 hexLayout[0] sep2 ...
static java.lang.String	toCmd(java.lang.String ga, int[] hl, int[] nl, int rh) BOARDLAYOUT sep game sep2 hexLayout[0] sep2 ...
java.lang.String	toString() Simple human-readable representation, used for debug purposes.

Methods inherited from class soc.message.SOCMessage

getMaximumVersion, getMinimumVersion, getType, toMsg, toSingleElemArray

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

game

private java.lang.String game

Name of game

hexLayout

private int[] hexLayout

The hex layout

numberLayout

private int[] numberLayout

The number layout

robberHex

private int robberHex

Where the robber is

Constructor Detail

SOCBoardLayout

public SOCBoardLayout(java.lang.String ga,
                      int[] hl,
                      int[] nl,
                      int rh)

Create a SOCBoardLayout message

Parameters:

ga - the name of the game

hl - the hex layout

nl - the number layout

rh - the robber hex

Method Detail

getGame

public java.lang.String getGame()

Returns:

the name of the game

getHexLayout

public int[] getHexLayout()

Returns:

the hex layout

getNumberLayout

public int[] getNumberLayout()

Returns:

the number layout

getRobberHex

public int getRobberHex()

Returns:

the robber hex

toCmd

public java.lang.String toCmd()

BOARDLAYOUT sep game sep2 hexLayout[0] sep2 ... sep2 hexLayout[36] sep2 numberLayout[0] sep2 ... sep2 numberLayout[36] sep2 robberHex

Specified by:

toCmd in class SOCMessage

Returns:

the command string

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int[] hl,
                                     int[] nl,
                                     int rh)

BOARDLAYOUT sep game sep2 hexLayout[0] sep2 ... sep2 hexLayout[36] sep2 numberLayout[0] sep2 ... sep2 numberLayout[36] sep2 robberHex

Returns:

the command string

parseDataStr

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

Parse the command String into a BoardLayout message

Parameters:

s - the String to parse

Returns:

a BoardLayout message

toString

public java.lang.String toString()

Description copied from class: SOCMessage

Simple human-readable representation, used for debug purposes.

Specified by:

toString in class SOCMessage

Returns:

a human readable form of the message