Uses of Class
soc.game.SOCGameOption

Packages that use SOCGameOption
soc.client   
soc.game   
soc.message   
soc.robot   
soc.server   
soc.util   
 

Uses of SOCGameOption in soc.client
 

Fields in soc.client with type parameters of type SOCGameOption
private  java.util.Map<java.awt.Component,SOCGameOption> NewGameOptionsFrame.controlsOpts
          Key = AWT control; value = SOCGameOption within NewGameOptionsFrame.opts.
 java.util.Map<java.lang.String,SOCGameOption> ServerGametypeInfo.optionSet
          Options will be null if SOCPlayerClient.sVersion is less than SOCNewGameWithOptions.VERSION_FOR_NEWGAMEWITHOPTIONS (1.1.07).
private  java.util.Map<java.lang.String,SOCGameOption> NewGameOptionsFrame.opts
          Contains this game's SOCGameOptions, or null if none.
 

Methods in soc.client with parameters of type SOCGameOption
private  void NewGameOptionsFrame.fireOptionChangeListener(SOCGameOption.ChangeListener cl, SOCGameOption opt, java.lang.Object oldValue, java.lang.Object newValue)
          Handle firing a game option's ChangeListener, and refreshing related gameopts' values on-screen if needed.
private  void NewGameOptionsFrame.fireUserChangedOptListeners(SOCGameOption opt, java.lang.Object ctrl, boolean newBoolValue, boolean changeBoolValue)
          A game option's value widget was changed by the user.
private  void NewGameOptionsFrame.initInterface_Opt1(SOCGameOption op, java.awt.Component oc, boolean hasCB, boolean allowPH, java.awt.Panel bp, java.awt.GridBagLayout gbl, java.awt.GridBagConstraints gbc)
          Add one GridBagLayout row with this game option (component and label(s)).
private  void NewGameOptionsFrame.initInterface_OptLine(SOCGameOption op, java.awt.Panel bp, java.awt.GridBagLayout gbl, java.awt.GridBagConstraints gbc)
          Set up one game option in one line of the panel.
private  java.awt.Choice NewGameOptionsFrame.initOption_enum(SOCGameOption op)
          Create a popup menu for the choices of this enum.
private  java.awt.Component NewGameOptionsFrame.initOption_int(SOCGameOption op)
          Based on this game option's type, present its intvalue either as a numeric textfield, or a popup menu if min/max are near each other.
 

Method parameters in soc.client with type arguments of type SOCGameOption
 void SOCPlayerClient.GameAwtDisplay.askStartGameWithOptions(java.lang.String gmName, boolean forPracticeServer, java.util.Map<java.lang.String,SOCGameOption> opts)
          Ask server to start a game with options.
protected  void SOCPlayerClient.checkGameoptsForUnknownScenario(java.util.Map<java.lang.String,SOCGameOption> opts)
          Check these game options to see if they contain a scenario we don't yet have full info about.
static NewGameOptionsFrame NewGameOptionsFrame.createAndShow(SOCPlayerClient.GameAwtDisplay cli, java.lang.String gaName, java.util.Map<java.lang.String,SOCGameOption> opts, boolean forPractice, boolean readOnly)
          Creates and shows a new NewGameOptionsFrame.
 java.util.List<java.lang.String> ServerGametypeInfo.receiveDefaults(java.util.Map<java.lang.String,SOCGameOption> servOpts)
          Set of default options has been received from the server, examine them.
static void NewGameOptionsFrame.showScenarioInfoDialog(SOCScenario sc, java.util.Map<java.lang.String,SOCGameOption> gameOpts, int vpWinner, SOCPlayerClient.GameAwtDisplay cli, java.awt.Frame parent)
          Show a popup window with this scenario's description, special rules, and number of victory points to win.
 void SOCPlayerClient.ClientNetwork.startPracticeGame(java.lang.String practiceGameName, java.util.Map<java.lang.String,SOCGameOption> gameOpts)
          Start a practice game.
 void SOCPlayerClient.startPracticeGame(java.lang.String practiceGameName, java.util.Map<java.lang.String,SOCGameOption> gameOpts, boolean mainPanelIsActive)
          Setup for practice game (on the non-tcp server).
 

Constructor parameters in soc.client with type arguments of type SOCGameOption
NewGameOptionsFrame(SOCPlayerClient.GameAwtDisplay gd, java.lang.String gaName, java.util.Map<java.lang.String,SOCGameOption> opts, boolean forPractice, boolean readOnly)
          Creates a new NewGameOptionsFrame.
 

Uses of SOCGameOption in soc.game
 

Fields in soc.game with type parameters of type SOCGameOption
private static java.util.Map<java.lang.String,SOCGameOption> SOCGameOption.allOptions
          Set of "known options".
private  java.util.Map<java.lang.String,SOCGameOption> SOCGame.opts
          the game options (SOCGameOption), or null
 java.util.List<SOCGameOption> SOCGameOptionVersionException.problemOptionsTooNew
          The SOCGameOption(s) which are too new, as returned by optionsNewerThanVersion(int, boolean, boolean, Map)
private static java.util.List<SOCGameOption> SOCGameOption.refreshList
          List of options to refresh on-screen after a change during game creation; filled by refreshDisplay().
 

Methods in soc.game that return SOCGameOption
static SOCGameOption SOCGameOption.getOption(java.lang.String key, boolean clone)
          Get information about a known option.
static SOCGameOption SOCGameOption.parseOptionNameValue(java.lang.String nvpair, boolean forceNameUpcase)
          Utility - parse a single name-value pair produced by packOptionsToString.
static SOCGameOption SOCGameOption.parseOptionNameValue(java.lang.String optkey, java.lang.String optval, boolean forceNameUpcase)
          Utility - parse an option name-value pair produced by packValue(StringBuilder) or packOptionsToString(Map, boolean).
static SOCGameOption SOCGameOption.trimEnumForVersion(SOCGameOption opt, int vers)
          Copy this option and restrict its enumerated values (type OTYPE_ENUM or similar) by trimming enumVals shorter.
 

Methods in soc.game that return types with arguments of type SOCGameOption
static java.util.Map<java.lang.String,SOCGameOption> SOCGameOption.cloneOptions(java.util.Map<java.lang.String,SOCGameOption> opts)
          Make a deep copy of a group of options.
static java.util.Map<java.lang.String,SOCGameOption> SOCGameOption.getAllKnownOptions()
           
static java.util.List<SOCGameOption> SOCGameOption.getAndClearRefreshList()
          Get the list of SOCGameOptions whose refreshDisplay() methods have been called, and clear the internal static copy.
 java.util.Map<java.lang.String,SOCGameOption> SOCGame.getGameOptions()
           
private static java.util.List<SOCGameOption> SOCGameOption.implOptionsVersionCheck(int vers, boolean getAllForVersion, boolean checkValues, boolean trimEnums, java.util.Map<java.lang.String,SOCGameOption> opts)
          Get all options added or changed since version vers, or all options valid at vers, to implement optionsNewerThanVersion(int, boolean, boolean, Map) and optionsForVersion(int, Map).
static java.util.Map<java.lang.String,SOCGameOption> SOCGameOption.initAllOptions()
          Create a set of the known options.
static java.util.List<SOCGameOption> SOCGameOption.optionsForVersion(int vers, java.util.Map<java.lang.String,SOCGameOption> opts)
          Get all options valid at version vers.
static java.util.List<SOCGameOption> SOCGameOption.optionsNewerThanVersion(int vers, boolean checkValues, boolean trimEnums, java.util.Map<java.lang.String,SOCGameOption> opts)
          Compare a set of options against the specified version.
static java.util.Map<java.lang.String,SOCGameOption> SOCGameOption.parseOptionsToMap(java.lang.String ostr)
          Utility - build a map of keys to SOCGameOptions by parsing a list of option name-value pairs.
 

Methods in soc.game with parameters of type SOCGameOption
static boolean SOCGameOption.addKnownOption(SOCGameOption onew)
          Add a new known option (presumably received from a server of newer or older version), or update the option's information.
private  void SOCBoard.makeNewBoard_placeHexes(int[] landHex, int[] numPath, int[] number, SOCGameOption optBC)
          For SOCBoard.makeNewBoard(Map), place the land hexes, number, and robber, after shuffling landHex[].
protected  void SOCBoard.makeNewBoard_shufflePorts(int[] portHex, SOCGameOption opt_breakClumps)
          For makeNewBoard, shuffle portHex[].
static void SOCGameOption.setKnownOptionCurrentValue(SOCGameOption ocurr)
          Set the current value(s) of a known option, based on the current value(s) of another object ocurr with the same key.
static SOCGameOption SOCGameOption.trimEnumForVersion(SOCGameOption opt, int vers)
          Copy this option and restrict its enumerated values (type OTYPE_ENUM or similar) by trimming enumVals shorter.
 void SOCGameOption.ChangeListener.valueChanged(SOCGameOption opt, java.lang.Object oldValue, java.lang.Object newValue, java.util.Map<java.lang.String,SOCGameOption> currentOpts)
          Called when the user changes opt's value during game creation.
 

Method parameters in soc.game with type arguments of type SOCGameOption
static java.lang.StringBuilder SOCGameOption.adjustOptionsToKnown(java.util.Map<java.lang.String,SOCGameOption> newOpts, java.util.Map<java.lang.String,SOCGameOption> knownOpts, boolean doServerPreadjust)
          Compare a set of options with known-good values.
static java.lang.StringBuilder SOCGameOption.adjustOptionsToKnown(java.util.Map<java.lang.String,SOCGameOption> newOpts, java.util.Map<java.lang.String,SOCGameOption> knownOpts, boolean doServerPreadjust)
          Compare a set of options with known-good values.
static java.util.Map<java.lang.String,SOCGameOption> SOCGameOption.cloneOptions(java.util.Map<java.lang.String,SOCGameOption> opts)
          Make a deep copy of a group of options.
 SOCBoard SOCBoard.BoardFactory.createBoard(java.util.Map<java.lang.String,SOCGameOption> gameOpts, boolean largeBoard, int maxPlayers)
          Create a new Settlers of Catan Board based on gameOpts; this is a factory method.
 SOCBoard SOCBoard.DefaultBoardFactory.createBoard(java.util.Map<java.lang.String,SOCGameOption> gameOpts, boolean largeBoard, int maxPlayers)
          Create a new Settlers of Catan Board based on gameOpts; this is a factory method.
private static IntPair SOCBoardLarge.getBoardSize(java.util.Map<java.lang.String,SOCGameOption> gameOpts, int maxPlayers)
          Get the board size for client's constructor: Default size SOCBoardLarge.BOARDHEIGHT_LARGE by SOCBoardLarge.BOARDWIDTH_LARGE, unless gameOpts contains "_BHW" Board Height and Width.
static int SOCGame.getGameOptionIntValue(java.util.Map<java.lang.String,SOCGameOption> opts, java.lang.String optKey)
          What is this integer game option's current value?
static int SOCGame.getGameOptionIntValue(java.util.Map<java.lang.String,SOCGameOption> opts, java.lang.String optKey, int defValue, boolean onlyIfBoolSet)
          What is this integer game option's current value?
static java.lang.String SOCGame.getGameOptionStringValue(java.util.Map<java.lang.String,SOCGameOption> opts, java.lang.String optKey)
          What is this string game option's current value?
private static java.util.List<SOCGameOption> SOCGameOption.implOptionsVersionCheck(int vers, boolean getAllForVersion, boolean checkValues, boolean trimEnums, java.util.Map<java.lang.String,SOCGameOption> opts)
          Get all options added or changed since version vers, or all options valid at vers, to implement optionsNewerThanVersion(int, boolean, boolean, Map) and optionsForVersion(int, Map).
static boolean SOCGame.isGameOptionSet(java.util.Map<java.lang.String,SOCGameOption> opts, java.lang.String optKey)
          Is this boolean-valued game option currently set to true?
 void SOCBoardLarge.makeNewBoard(java.util.Map<java.lang.String,SOCGameOption> opts)
          Shuffle the hex tiles and layout a board.
 void SOCBoard.makeNewBoard(java.util.Map<java.lang.String,SOCGameOption> opts)
          Shuffle the hex tiles and layout a board.
static java.util.List<SOCGameOption> SOCGameOption.optionsForVersion(int vers, java.util.Map<java.lang.String,SOCGameOption> opts)
          Get all options valid at version vers.
static java.util.List<SOCGameOption> SOCGameOption.optionsNewerThanVersion(int vers, boolean checkValues, boolean trimEnums, java.util.Map<java.lang.String,SOCGameOption> opts)
          Compare a set of options against the specified version.
static java.lang.String SOCGameOption.packOptionsToString(java.util.Map<java.lang.String,SOCGameOption> omap, boolean hideEmptyStringOpts)
          Utility - build a string of option name-value pairs.
static java.lang.String SOCGameOption.packOptionsToString(java.util.Map<java.lang.String,SOCGameOption> omap, boolean hideEmptyStringOpts, int cliVers)
          Utility - build a string of option name-value pairs, adjusting for old clients if necessary.
static void SOCGameOption.setBoolOption(java.util.Map<java.lang.String,SOCGameOption> newOpts, java.lang.String boKey)
          Within a set of options, include a boolean option and make it true.
static void SOCGameOption.setIntOption(java.util.Map<java.lang.String,SOCGameOption> newOpts, java.lang.String ioKey, int ivalue, boolean bvalue)
          Within a set of options, include an int or intbool option and set its value.
static SOCBoard SOCBoard.DefaultBoardFactory.staticCreateBoard(java.util.Map<java.lang.String,SOCGameOption> gameOpts, boolean largeBoard, int maxPlayers)
          Create a new Settlers of Catan Board based on gameOpts; this is a factory method.
 void SOCGameOption.ChangeListener.valueChanged(SOCGameOption opt, java.lang.Object oldValue, java.lang.Object newValue, java.util.Map<java.lang.String,SOCGameOption> currentOpts)
          Called when the user changes opt's value during game creation.
 

Constructors in soc.game with parameters of type SOCGameOption
SOCGameOption(SOCGameOption intOpt, int maxIntValue)
          Copy constructor for int-valued types (OTYPE_INT, OTYPE_INTBOOL), for restricting (trimming) max value for a certain client version.
SOCGameOption(SOCGameOption opt, java.lang.String newDesc)
          Copy constructor for i18n localization of getDesc().
SOCGameOption(SOCGameOption enumOpt, java.lang.String[] keptEnumVals)
          Copy constructor for enum-valued types (OTYPE_ENUM, OTYPE_ENUMBOOL), for restricting (trimming) values for a certain client version.
 

Constructor parameters in soc.game with type arguments of type SOCGameOption
SOCBoard(java.util.Map<java.lang.String,SOCGameOption> gameOpts, int maxPlayers)
          Create a new Settlers of Catan Board, with the v1 or v2 encoding.
SOCBoardLarge(java.util.Map<java.lang.String,SOCGameOption> gameOpts, int maxPlayers)
          Create a new Settlers of Catan Board, with the v3 encoding.
SOCBoardLarge(java.util.Map<java.lang.String,SOCGameOption> gameOpts, int maxPlayers, IntPair boardHeightWidth)
          Create a new Settlers of Catan Board, with the v3 encoding and a certain size.
SOCGame(java.lang.String n, boolean isActive, java.util.Map<java.lang.String,SOCGameOption> op)
          create a new game that can be ACTIVE or INACTIVE, and have options and optionally a scenario (game option "SC").
SOCGame(java.lang.String n, java.util.Map<java.lang.String,SOCGameOption> op)
          create a new, active game with options and optionally a scenario (game option "SC").
SOCGameOptionVersionException(int optVers, int cliVers, java.util.List<SOCGameOption> optsValuesTooNew)
           
 

Uses of SOCGameOption in soc.message
 

Fields in soc.message declared as SOCGameOption
protected  SOCGameOption SOCGameOptionInfo.opt
           
 

Fields in soc.message with type parameters of type SOCGameOption
private  java.util.Map<java.lang.String,SOCGameOption> SOCRobotJoinGameRequest.opts
          Game options, or null
private  java.util.Map<java.lang.String,SOCGameOption> SOCNewGameWithOptionsRequest.opts
          may be null
 

Methods in soc.message that return SOCGameOption
 SOCGameOption SOCGameOptionInfo.getOptionInfo()
           
 

Methods in soc.message that return types with arguments of type SOCGameOption
 java.util.Map<java.lang.String,SOCGameOption> SOCRobotJoinGameRequest.getOptions()
           
 java.util.Map<java.lang.String,SOCGameOption> SOCNewGameWithOptionsRequest.getOptions()
           
 

Method parameters in soc.message with type arguments of type SOCGameOption
static java.lang.String SOCRobotJoinGameRequest.toCmd(java.lang.String ga, int pn, java.util.Map<java.lang.String,SOCGameOption> opts)
          ROBOTJOINGAMEREQUEST sep game sep2 playerNumber sep2 optionstring
static java.lang.String SOCNewGameWithOptions.toCmd(java.lang.String ga, java.util.Map<java.lang.String,SOCGameOption> opts, int gameMinVers, int cliVers)
          NEWGAMEWITHOPTIONS sep game sep2 minVers sep2 optionstring
static java.lang.String SOCNewGameWithOptionsRequest.toCmd(java.lang.String nn, java.lang.String pw, java.lang.String hn, java.lang.String ga, java.util.Map<java.lang.String,SOCGameOption> opts)
          NEWGAMEWITHOPTIONSREQUEST sep nickname sep2 password sep2 host sep2 game sep2 options
 

Constructors in soc.message with parameters of type SOCGameOption
SOCGameOptionInfo(SOCGameOption op, int cliVers, java.lang.String localDesc)
          Constructor for server to tell client about a game option.
 

Constructor parameters in soc.message with type arguments of type SOCGameOption
SOCNewGameWithOptions(java.lang.String ga, java.util.Map<java.lang.String,SOCGameOption> opts, int minVers)
          Create a SOCNewGameWithOptions message.
SOCNewGameWithOptionsRequest(java.lang.String nn, java.lang.String pw, java.lang.String hn, java.lang.String ga, java.util.Map<java.lang.String,SOCGameOption> opts)
          Create a NewGameWithOptionsRequest message.
SOCRobotJoinGameRequest(java.lang.String ga, int pn, java.util.Map<java.lang.String,SOCGameOption> opts)
          Create a RobotJoinGameRequest message.
 

Uses of SOCGameOption in soc.robot
 

Fields in soc.robot with type parameters of type SOCGameOption
private  java.util.Hashtable<java.lang.String,java.util.Map<java.lang.String,SOCGameOption>> SOCRobotClient.gameOptions
          options for all games on the server we've been asked to join.
 

Uses of SOCGameOption in soc.server
 

Methods in soc.server that return SOCGameOption
static SOCGameOption SOCServer.parseCmdline_GameOption(SOCGameOption op, java.lang.String optRaw, java.util.HashMap<java.lang.String,java.lang.String> optsAlreadySet)
          Quick-and-dirty command line parsing of a game option.
 

Methods in soc.server that return types with arguments of type SOCGameOption
 java.util.Map<java.lang.String,SOCGameOption> SOCServer.getGameOptions(java.lang.String gm)
          Given a game name on this server, return its game options.
static java.util.Map<java.lang.String,SOCGameOption> SOCServer.localizeKnownOptions(java.util.Locale loc, boolean updateStaticKnownOpts)
          Given a StringManager (for a client's locale), return all known game options, localizing the descriptive names if available.
 

Methods in soc.server with parameters of type SOCGameOption
private  void SOCBoardLargeAtServer.makeNewBoard_placeHexes(int[] landHexType, int[] landPath, int[] number, boolean shuffleDiceNumbers, boolean shuffleLandHexes, int[] landAreaPathRanges, boolean addToExistingLA, int maxPl, SOCGameOption optBC, java.lang.String scen)
          For SOCBoardLargeAtServer.makeNewBoard(Map), place the land hexes, number, and robber for multiple land areas, after shuffling their common landHexType[].
private  void SOCBoardLargeAtServer.makeNewBoard_placeHexes(int[] landHexType, int[] landPath, int[] number, boolean shuffleDiceNumbers, boolean shuffleLandHexes, int landAreaNumber, boolean addToExistingLA, int maxPl, SOCGameOption optBC, java.lang.String scen)
          For SOCBoardLargeAtServer.makeNewBoard(Map), place the land hexes, number, and robber, after shuffling landHexType[].
static SOCGameOption SOCServer.parseCmdline_GameOption(SOCGameOption op, java.lang.String optRaw, java.util.HashMap<java.lang.String,java.lang.String> optsAlreadySet)
          Quick-and-dirty command line parsing of a game option.
 

Method parameters in soc.server with type arguments of type SOCGameOption
 boolean SOCServer.connectToGame(StringConnection c, java.lang.String gaName, java.util.Map<java.lang.String,SOCGameOption> gaOpts)
          Adds a connection to a game, unless they're already a member.
 SOCBoard SOCBoardLargeAtServer.BoardFactoryAtServer.createBoard(java.util.Map<java.lang.String,SOCGameOption> gameOpts, boolean largeBoard, int maxPlayers)
          Create a new Settlers of Catan Board based on gameOpts; this is a factory method.
 SOCGame SOCGameListAtServer.createGame(java.lang.String gaName, java.lang.String gaOwner, java.lang.String gaLocaleStr, java.util.Map<java.lang.String,SOCGameOption> gaOpts, GameHandler handler)
          create a new game, and add to the list; game will expire in SOCGameListAtServer.GAME_TIME_EXPIRE_MINUTES minutes.
private  SOCGame SOCServer.createGameAndBroadcast(StringConnection c, java.lang.String gaName, java.util.Map<java.lang.String,SOCGameOption> gaOpts, int gVers, boolean isBotsOnly, boolean hasGameListMonitor)
          Create a new game, and announce it with a broadcast.
private  void SOCServer.createOrJoinGameIfUserOK(StringConnection c, java.lang.String msgUser, java.lang.String msgPass, java.lang.String gameName, java.util.Map<java.lang.String,SOCGameOption> gameOpts)
          Check username/password and create new game, or join game.
private static int SOCBoardLargeAtServer.getBoardSize(java.util.Map<java.lang.String,SOCGameOption> gameOpts, int maxPlayers)
          Get the board size for BoardFactoryAtServer.createBoard: The default size BOARDHEIGHT_LARGE by BOARDWIDTH_LARGE, unless gameOpts contains a scenario ("SC") whose layout has a custom height/width.
 void SOCBoardLargeAtServer.makeNewBoard(java.util.Map<java.lang.String,SOCGameOption> opts)
          Shuffle the hex tiles and layout a board.
 

Constructor parameters in soc.server with type arguments of type SOCGameOption
SOCBoardLargeAtServer(java.util.Map<java.lang.String,SOCGameOption> gameOpts, int maxPlayers, IntPair boardHeightWidth)
          Create a new Settlers of Catan Board, with the v3 encoding.
SOCGameListAtServer.GameInfoAtServer(java.util.Map<java.lang.String,SOCGameOption> gameOpts, GameHandler typeHandler)
          Constructor, with handler and optional game options.
 

Uses of SOCGameOption in soc.util
 

Fields in soc.util with type parameters of type SOCGameOption
 java.util.Map<java.lang.String,SOCGameOption> SOCGameList.GameInfo.opts
           
 

Methods in soc.util that return types with arguments of type SOCGameOption
 java.util.Map<java.lang.String,SOCGameOption> SOCGameList.getGameOptions(java.lang.String gaName)
          get a game's SOCGameOptions, if stored and parsed
 java.util.Map<java.lang.String,SOCGameOption> SOCGameList.parseGameOptions(java.lang.String gaName)
          Parse these game options from string to map.
 java.util.Map<java.lang.String,SOCGameOption> SOCGameList.GameInfo.parseOptsStr()
          Parse optsStr to opts, unless it's already been parsed.
 

Method parameters in soc.util with type arguments of type SOCGameOption
protected  void SOCGameList.addGame(java.lang.String gaName, java.util.Map<java.lang.String,SOCGameOption> gaOpts, java.lang.String gaOptsStr, boolean cannotJoin)
          Internal use - Add this game name, with game options.
 SOCRobotParameters SOCRobotParameters.copyIfOptionChanged(java.util.Map<java.lang.String,SOCGameOption> gameOpts)
          Examine game options, and if any would change the robot parameters, make a copy of these parameters with the changed options.
 

Constructor parameters in soc.util with type arguments of type SOCGameOption
SOCGameList.GameInfo(boolean canJoinGame, java.util.Map<java.lang.String,SOCGameOption> gameOpts)
          Constructor: gameOpts is null or contains game option objects