|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object soc.message.SOCMessage soc.message.SOCBuildRequest
public class SOCBuildRequest
This message, from client to server, says which piece type the current player wants to build.
During game state PLAY1
, this is a build request during the player's turn.
When sent during other game states, and other players' turns, this is a request
to start the 6-player Special Building Phase
.
Field Summary | |
---|---|
private java.lang.String |
game
Name of game |
private int |
pieceType
The type of piece to build, from SOCPlayingPiece constants,
or -1 to request the Special Building Phase. |
private static long |
serialVersionUID
|
Constructor Summary | |
---|---|
SOCBuildRequest(java.lang.String ga,
int pt)
Create a BuildRequest message. |
Method Summary | |
---|---|
java.lang.String |
getGame()
Name of game this message is for. |
int |
getPieceType()
|
static SOCBuildRequest |
parseDataStr(java.lang.String s)
Parse the command String into a BuildRequest message |
java.lang.String |
toCmd()
BUILDREQUEST sep game sep2 pieceType |
static java.lang.String |
toCmd(java.lang.String ga,
int pt)
BUILDREQUEST sep game sep2 pieceType |
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 |
---|
private static final long serialVersionUID
private java.lang.String game
private int pieceType
SOCPlayingPiece
constants,
or -1 to request the Special Building Phase.
Constructor Detail |
---|
public SOCBuildRequest(java.lang.String ga, int pt)
ga
- the name of the gamept
- the type of piece to build, from SOCPlayingPiece
constants,
or -1 to request the Special Building Phase.Method Detail |
---|
public java.lang.String getGame()
SOCMessageForGame
null
if message is in per-game structures or code.
At the server, the message treater dispatches incoming SOCMessageForGame
s
based on their getGame()
:
null
: Message is ignored
SOCMessage.GAME_NONE
: Message is handled by SOCServer
itself
GameHandler
for that game's type. If no game with that name is found,
the message is ignored.
getGame
in interface SOCMessageForGame
SOCMessage.GAME_NONE
public int getPieceType()
SOCPlayingPiece
constants,
or -1 to request the Special Building Phase.public java.lang.String toCmd()
toCmd
in class SOCMessage
public static java.lang.String toCmd(java.lang.String ga, int pt)
ga
- the name of the gamept
- the type of piece to build, or -1 for Special Building Phase
public static SOCBuildRequest parseDataStr(java.lang.String s)
s
- the String to parse
public java.lang.String toString()
SOCMessage
toString
in class SOCMessage
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |