JSettlers v1.0.6 API
Built ${date}

soc.message
Class SOCBCastTextMsg

java.lang.Object
  extended bysoc.message.SOCMessage
      extended bysoc.message.SOCBCastTextMsg
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class SOCBCastTextMsg
extends SOCMessage

This message contains a text message for everyone connected

Author:
Robert S Thomas
See Also:
Serialized Form

Field Summary
 
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, RESOURCECOUNT, ROBOTDISMISS, ROLLDICE, ROLLDICEREQUEST, sep, sep2, SERVERPING, SETPLAYEDDEVCARD, SETSEATLOCK, SETTURN, SETUPDONE, SITDOWN, STARTGAME, STATUSMESSAGE, TEXTMSG, TURN, UPDATEROBOTPARAMS
 
Constructor Summary
SOCBCastTextMsg(java.lang.String tm)
          Create a BCastTextMsg message.
 
Method Summary
 java.lang.String getText()
           
static SOCBCastTextMsg parseDataStr(java.lang.String s)
          Parse the command String into a BCastTextMsg message
 java.lang.String toCmd()
          BCASTTEXTMSG sep text
static java.lang.String toCmd(java.lang.String tm)
          BCASTTEXTMSG sep text
 java.lang.String toString()
           
 
Methods inherited from class soc.message.SOCMessage
getType, toMsg
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SOCBCastTextMsg

public SOCBCastTextMsg(java.lang.String tm)
Create a BCastTextMsg message.

Parameters:
tm - text message
Method Detail

getText

public java.lang.String getText()
Returns:
the text message

toCmd

public java.lang.String toCmd()
BCASTTEXTMSG sep text

Specified by:
toCmd in class SOCMessage
Returns:
the command String

toCmd

public static java.lang.String toCmd(java.lang.String tm)
BCASTTEXTMSG sep text

Parameters:
tm - the text message
Returns:
the command string

parseDataStr

public static SOCBCastTextMsg parseDataStr(java.lang.String s)
Parse the command String into a BCastTextMsg message

Parameters:
s - the String to parse
Returns:
a BCastTextMsg message, or null of the data is garbled

toString

public java.lang.String toString()
Returns:
a human readable form of the message

JSettlers v1.0.6 API
Built ${date}