soc.message
Class SOCChangeFace

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCChangeFace

All Implemented Interfaces:

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

public class SOCChangeFace
extends SOCMessage
implements SOCMessageForGame

This message says that a player is changing the face icon.

Although this is a game-specific message, it's handled by SOCServer instead of a GameHandler.

Author:

Robert S. Thomas

See Also:

Serialized Form

Field Summary

private int	faceId The id of the face image
private java.lang.String	game Name of game
private int	playerNumber The number player that is changing
private static long	serialVersionUID

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

SOCChangeFace(java.lang.String ga, int pn, int id)
Create a ChangeFace message.

Method Summary

int	getFaceId()
java.lang.String	getGame() Name of game this message is for.
int	getPlayerNumber()
static SOCChangeFace	parseDataStr(java.lang.String s) Parse the command String into a ChangeFace message
java.lang.String	toCmd() CHANGEFACE sep game sep2 playerNumber sep2 faceId
static java.lang.String	toCmd(java.lang.String ga, int pn, int id) CHANGEFACE sep game sep2 playerNumber sep2 faceId
java.lang.String	toString() Simple human-readable representation, used for debug purposes.

Methods inherited from class soc.message.SOCMessage

arrayIntoStringBuf, enumIntoStringBuf, getClassNameShort, getMaximumVersion, getMinimumVersion, 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

game

private java.lang.String game

Name of game

playerNumber

private int playerNumber

The number player that is changing

faceId

private int faceId

The id of the face image

Constructor Detail

SOCChangeFace

public SOCChangeFace(java.lang.String ga,
                     int pn,
                     int id)

Create a ChangeFace message.

Parameters:

ga - the name of the game

pn - the number of the changing player

id - the id of the face image; 1 and higher are human face images, 0 is the default robot, -1 is the smarter robot.

Method Detail

getGame

public java.lang.String getGame()

Description copied from interface: SOCMessageForGame

Name of game this message is for. Must not be null if message is in per-game structures or code.

At the server, the message treater dispatches incoming SOCMessageForGames based on their getGame():

• null: Message is ignored
• SOCMessage.GAME_NONE: Message is handled by SOCServer itself
• Any other game name: Looks for a game with that name, to dispatch to the GameHandler for that game's type. If no game with that name is found, the message is ignored.

Specified by:

getGame in interface SOCMessageForGame

Returns:

the name of the game

See Also:

SOCMessage.GAME_NONE

getPlayerNumber

public int getPlayerNumber()

Returns:

the number of changing player

getFaceId

public int getFaceId()

Returns:

the id of the face image; 1 and higher are human face images, 0 is the default robot, -1 is the smarter robot.

toCmd

public java.lang.String toCmd()

CHANGEFACE sep game sep2 playerNumber sep2 faceId

Specified by:

toCmd in class SOCMessage

Returns:

the command string

toCmd

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

CHANGEFACE sep game sep2 playerNumber sep2 faceId

Parameters:

ga - the name of the game

pn - the number of the changing player

id - the id of the face image

Returns:

the command string

parseDataStr

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

Parse the command String into a ChangeFace message

Parameters:

s - the String to parse

Returns:

a ChangeFace message, or null of the data is garbled

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