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.lang.Cloneable, java.io.Serializable

public class SOCCancelBuildRequest
extends SOCMessage

This message type has three meanings, depending on game state and direction of send.

- When sent from client to server, CANCELBUILDREQUEST means the player has changed their mind about spending resources to build a piece. Only allowed during normal game play (PLACING_ROAD, PLACING_SETTLEMENT, or PLACING_CITY).

When sent from server to client:

- During game startup (START1B or START2B):
Sent from server, CANCELBUILDREQUEST means the current player wants to undo 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.

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

Field Summary
`private java.lang.String`	`game` Name of game
`private int`	`pieceType` The type of piece to build

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

Method Summary
`java.lang.String`	`getGame()`
`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

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

pieceType

private int pieceType

The type of piece to build

Constructor Detail