SOCCancelBuildRequest

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

soc.message
Class SOCCancelBuildRequest

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCCancelBuildRequest

All Implemented Interfaces:: java.io.Serializable, java.lang.Cloneable, SOCMessageForGame

public class SOCCancelBuildRequest
extends SOCMessage
implements SOCMessageForGame
extends SOCMessage
implements SOCMessageForGame

This message type has five possible meanings, depending on game state and direction sent:

When sent from client to server:

During piece placement (PLACING_ROAD, PLACING_SETTLEMENT, PLACING_CITY, PLACING_SHIP, PLACING_INV_ITEM):
CANCELBUILDREQUEST means the player has changed their mind about spending resources to build a piece. Server will reply by returning the player's resources and changing game state.
The special inventory items in PLACING_INV_ITEM each have a different placement message, but if item placement can be canceled, use this common message type, with pieceType == -3 (INV_ITEM_PLACE_CANCEL). If placement can't be canceled, server will reply with SOCGameServerText.
While placing the second free road or ship (PLACING_FREE_ROAD2), means the player has decided to skip placing the second free road or ship, to use just one road or ship piece. Server will reply with new game state. (This was added in v1.1.17)
Not sent from client during other game states. Server will reply with SOCGameServerText.
When sent from server to client:
During game startup (START1B, START2B or START3B):
Sent from server, CANCELBUILDREQUEST means the current player is undoing the placement of their initial settlement.
During piece placement (PLACING_ROAD, PLACING_CITY, PLACING_SETTLEMENT, PLACING_FREE_ROAD1 or PLACING_FREE_ROAD2):
Sent from server, CANCELBUILDREQUEST means the player has sent an illegal PUTPIECE (bad building location). Humans can probably decide a better place to put their road, but robots must cancel the build request and decide on a new plan.
This can also be the reply if the client sends an illegal BUILDREQUEST (no resources, not the right game state, etc.). In that case it's sent only to robot clients, not to humans. (Humans get a textual error message, and can understand that instead.)
Piece type -2 is sent only from server to robot client, as a way to tell robots they can't buy a development card (insufficient resources, or no cards left). (This was added in 1.1.09.) -2 == soc.robot.SOCPossiblePiece.CARD.

Author:: Robert S. Thomas
See Also:: Serialized Form

Field Summary
`private java.lang.String`	`game` Name of game
`static int`	`INV_ITEM_PLACE_CANCEL` pieceType to cancel special `SOCInventoryItem` placement.
`private int`	`pieceType` The type of piece to cancel build, such as `SOCPlayingPiece.CITY` -2 is used from server to reject request to buy a Development Card.
`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

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
`SOCCancelBuildRequest(java.lang.String ga, int pt)` Create a CancelBuildRequest message.

Method Summary
`java.lang.String`	`getGame()` Name of game this message is for.
`int`	`getPieceType()`
`static SOCCancelBuildRequest`	`parseDataStr(java.lang.String s)` Parse the command String into a CancelBuildRequest message
`java.lang.String`	`toCmd()` CANCELBUILDREQUEST sep game sep2 pieceType
`static java.lang.String`	`toCmd(java.lang.String ga, int pt)` CANCELBUILDREQUEST 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

INV_ITEM_PLACE_CANCEL

public static final int INV_ITEM_PLACE_CANCEL

pieceType to cancel special SOCInventoryItem placement.

Since:: 2.0.00
See Also:: Constant Field Values

serialVersionUID

private static final long serialVersionUID

See Also:: Constant Field Values

game

private final java.lang.String game

Name of game

pieceType

private final int pieceType

The type of piece to cancel build, such as SOCPlayingPiece.CITY -2 is used from server to reject request to buy a Development Card. -3 (INV_ITEM_PLACE_CANCEL) is used from client to request canceling placement of a special SOCInventoryItem if possible.

Constructor Detail