net.sf.freecol.common.model
Class GameOptions

java.lang.Object
  extended by net.sf.freecol.common.model.GameOptions

public class GameOptions
extends java.lang.Object

Keeps track of the available game options. New options must be added to the Specification and each option should be given an unique identifier (defined as a constant in this class).


Field Summary
static java.lang.String ALLOW_STUDENT_SELECTION
          Whether to educate the least skilled unit first.
static java.lang.String CUSTOM_IGNORE_BOYCOTT
          Does the Custom House sell boycotted goods
static java.lang.String ENHANCED_MISSIONARIES
          Do missionaries provide extra benefits.
static java.lang.String EXPERTS_HAVE_CONNECTIONS
          Whether experts have connections, producing without raw materials in factories
static java.lang.String EXPLORATION_POINTS
          Whether to award exploration points or not.
static java.lang.String FOG_OF_WAR
          Enables/disables fog of war.
static java.lang.String LAST_COLONIAL_YEAR
          The last year of the game for colonial players.
static java.lang.String LAST_YEAR
          The very last year of the game.
static java.lang.String MANDATORY_COLONY_YEAR
          The year in which owning at least one colony becomes mandatory.
static java.lang.String SAVE_PRODUCTION_OVERFLOW
           
static java.lang.String SEASON_YEAR
          The first year in which there are two seasons.
static java.lang.String SHIP_TRADE_PENALTY
          The penalty applied to trading with the natives from a ship.
static java.lang.String STARTING_MONEY
          The amount of money each player will receive before the game starts.
static java.lang.String STARTING_POSITIONS
          How to determine the starting positions of European players.
static int STARTING_POSITIONS_CLASSIC
           
static int STARTING_POSITIONS_HISTORICAL
           
static int STARTING_POSITIONS_RANDOM
           
static java.lang.String STARTING_YEAR
          The year in which the game starts.
static java.lang.String TELEPORT_REF
          Does the REF "teleport" to its first target.
static java.lang.String VICTORY_DEFEAT_EUROPEANS
          Victory condition: Should a Player who first defeats all other european players win the game?
static java.lang.String VICTORY_DEFEAT_HUMANS
          Victory condition: Should a Player who first defeats all other human players win the game?
static java.lang.String VICTORY_DEFEAT_REF
          Victory condition: Should the Player who first defeats the Royal Expeditionary Force win the game?
 
Constructor Summary
GameOptions()
           
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STARTING_MONEY

public static final java.lang.String STARTING_MONEY
The amount of money each player will receive before the game starts.

See Also:
Constant Field Values

SHIP_TRADE_PENALTY

public static final java.lang.String SHIP_TRADE_PENALTY
The penalty applied to trading with the natives from a ship.

See Also:
Constant Field Values

FOG_OF_WAR

public static final java.lang.String FOG_OF_WAR
Enables/disables fog of war.

See Also:
Constant Field Values

CUSTOM_IGNORE_BOYCOTT

public static final java.lang.String CUSTOM_IGNORE_BOYCOTT
Does the Custom House sell boycotted goods

See Also:
Constant Field Values

EXPERTS_HAVE_CONNECTIONS

public static final java.lang.String EXPERTS_HAVE_CONNECTIONS
Whether experts have connections, producing without raw materials in factories

See Also:
Constant Field Values

SAVE_PRODUCTION_OVERFLOW

public static final java.lang.String SAVE_PRODUCTION_OVERFLOW
See Also:
Constant Field Values

EXPLORATION_POINTS

public static final java.lang.String EXPLORATION_POINTS
Whether to award exploration points or not.

See Also:
Constant Field Values

VICTORY_DEFEAT_REF

public static final java.lang.String VICTORY_DEFEAT_REF
Victory condition: Should the Player who first defeats the Royal Expeditionary Force win the game?

See Also:
Constant Field Values

VICTORY_DEFEAT_EUROPEANS

public static final java.lang.String VICTORY_DEFEAT_EUROPEANS
Victory condition: Should a Player who first defeats all other european players win the game?

See Also:
Constant Field Values

VICTORY_DEFEAT_HUMANS

public static final java.lang.String VICTORY_DEFEAT_HUMANS
Victory condition: Should a Player who first defeats all other human players win the game?

See Also:
Constant Field Values

ALLOW_STUDENT_SELECTION

public static final java.lang.String ALLOW_STUDENT_SELECTION
Whether to educate the least skilled unit first. This is the behaviour of the original game and disallows manually assigning students to teachers.

See Also:
Constant Field Values

STARTING_YEAR

public static final java.lang.String STARTING_YEAR
The year in which the game starts. At the moment, changing this value only shortens the game. In future, it might cause the map generator to create foreign colonies.

See Also:
Constant Field Values

SEASON_YEAR

public static final java.lang.String SEASON_YEAR
The first year in which there are two seasons. Changing this value influences the duration of the game.

See Also:
Constant Field Values

MANDATORY_COLONY_YEAR

public static final java.lang.String MANDATORY_COLONY_YEAR
The year in which owning at least one colony becomes mandatory.

See Also:
Constant Field Values

LAST_YEAR

public static final java.lang.String LAST_YEAR
The very last year of the game.

See Also:
Constant Field Values

LAST_COLONIAL_YEAR

public static final java.lang.String LAST_COLONIAL_YEAR
The last year of the game for colonial players. In other words, if a colonial player does not declare independence by the end of this year, the game is lost.

See Also:
Constant Field Values

STARTING_POSITIONS

public static final java.lang.String STARTING_POSITIONS
How to determine the starting positions of European players.

See Also:
Constant Field Values

STARTING_POSITIONS_CLASSIC

public static final int STARTING_POSITIONS_CLASSIC
See Also:
Constant Field Values

STARTING_POSITIONS_RANDOM

public static final int STARTING_POSITIONS_RANDOM
See Also:
Constant Field Values

STARTING_POSITIONS_HISTORICAL

public static final int STARTING_POSITIONS_HISTORICAL
See Also:
Constant Field Values

ENHANCED_MISSIONARIES

public static final java.lang.String ENHANCED_MISSIONARIES
Do missionaries provide extra benefits.

See Also:
Constant Field Values

TELEPORT_REF

public static final java.lang.String TELEPORT_REF
Does the REF "teleport" to its first target.

See Also:
Constant Field Values
Constructor Detail

GameOptions

public GameOptions()