1

/* $Id$ */

     2

     3

/** @file settings_type.h Types related to global configuration settings. */

     4

     5

#ifndef SETTINGS_TYPE_H

     6

#define SETTINGS_TYPE_H

     7

     8

#include "date_type.h"

     9

#include "town_type.h"

    10

#include "transport_type.h"

    11

    12

enum {

    13

	GAME_DIFFICULTY_AI_NUMBER,

    14

	GAME_DIFFICULTY_AI_STARTTIME,

    15

	GAME_DIFFICULTY_TOWN_NUMBER,

    16

	GAME_DIFFICULTY_INDUSTRIE_NUMBER,

    17

	GAME_DIFFICULTY_MAX_LOAN,

    18

	GAME_DIFFICULTY_INITIAL_INTEREST,

    19

	GAME_DIFFICULTY_VEHICLE_COST,

    20

	GAME_DIFFICULTY_AI_SPEED,

    21

	GAME_DIFFICULTY_AI_INTELLIGENCE,       ///< no longer in use

    22

	GAME_DIFFICULTY_VEHICLES_BREAKDOWN,

    23

	GAME_DIFFICULTY_SUBSIDY_MULTIPLIER,

    24

	GAME_DIFFICULTY_CONSTRUCTION_COST,

    25

	GAME_DIFFICULTY_TYPE_TERRAIN,

    26

	GAME_DIFFICULTY_SEALAKE_NUMBER,

    27

	GAME_DIFFICULTY_ECONOMY,

    28

	GAME_DIFFICULTY_LINE_REVERSEMODE,

    29

	GAME_DIFFICULTY_DISASTERS,

    30

	GAME_DIFFICULTY_TOWNCOUNCIL_TOLERANCE, ///< minimum required town ratings to be allowed to demolish stuff

    31

	GAME_DIFFICULTY_NUM,

    32

};

    33

    34

/** Specific type for Game Difficulty to ease changing the type */

    35

typedef uint16 GDType;

    57

};

    58

    59

/** Settings related to the GUI and other stuff that is not saved in the savegame. */

    60

struct GUISettings {

    61

	bool   vehicle_speed;                    ///< show vehicle speed

    62

	bool   sg_full_load_any;                 ///< new full load calculation, any cargo must be full read from pre v93 savegames

    63

	bool   lost_train_warn;                  ///< if a train can't find its destination, show a warning

    64

	uint8  order_review_system;              ///< perform order reviews on vehicles

    65

	bool   train_income_warn;                ///< if train is generating little income, show a warning

    66

	bool   status_long_date;                 ///< always show long date in status bar

    67

	bool   show_finances;                    ///< show finances at end of year

    68

	bool   sg_new_nonstop;                   ///< ttdpatch compatible nonstop handling read from pre v93 savegames

    69

	bool   new_nonstop;                      ///< ttdpatch compatible nonstop handling

    70

	bool   autoscroll;                       ///< scroll when moving mouse to the edge

    71

	byte   errmsg_duration;                  ///< duration of error message

    72

	bool   link_terraform_toolbar;           ///< display terraform toolbar when displaying rail, road, water and airport toolbars

    73

	bool   reverse_scroll;                   ///< right-Click-Scrolling scrolls in the opposite direction

    74

	bool   smooth_scroll;                    ///< smooth scroll viewports

    75

	bool   measure_tooltip;                  ///< show a permanent tooltip when dragging tools

    76

	byte   liveries;                         ///< options for displaying company liveries, 0=none, 1=self, 2=all

    77

	bool   prefer_teamchat;                  ///< choose the chat message target with <ENTER>, true=all players, false=your team

    78

	uint8  advanced_vehicle_list;            ///< use the "advanced" vehicle list

    79

	uint8  loading_indicators;               ///< show loading indicators

    80

	uint8  default_rail_type;                ///< the default rail type for the rail GUI

    81

	uint8  toolbar_pos;                      ///< position of toolbars, 0=left, 1=center, 2=right

    82

	uint8  window_snap_radius;               ///< windows snap at each other if closer than this

    83

	bool   always_build_infrastructure;      ///< always allow building of infrastructure, even when you do not have the vehicles for it

    85

	bool   keep_all_autosave;                ///< name the autosave in a different way

    86

	bool   autosave_on_exit;                 ///< save an autosave when you quit the game, but do not ask "Do you really want to quit?"

    87

	byte   max_num_autosaves;                ///< controls how many autosavegames are made before the game starts to overwrite (names them 0 to max_num_autosaves - 1)

    88

	bool   population_in_label;              ///< show the population of a town in his label?

    89

	uint8  right_mouse_btn_emulation;        ///< should we emulate right mouse clicking?

    90

	uint8  scrollwheel_scrolling;            ///< scrolling using the scroll wheel?

    91

	uint8  scrollwheel_multiplier;           ///< how much 'wheel' per incoming event from the OS?

    92

	bool   pause_on_newgame;                 ///< whether to start new games paused or not

    93

	bool   enable_signal_gui;                ///< show the signal GUI when the signal button is pressed

    94

	Year   ending_year;                      ///< end of the game (just show highscore)

    95

	Year   colored_news_year;                ///< when does newspaper become colored?

    96

	bool   timetable_in_ticks;               ///< whether to show the timetable in ticks rather than days

    97

	bool   bridge_pillars;                   ///< show bridge pillars for high bridges

    98

	bool   auto_euro;                        ///< automatically switch to euro in 2002

    99

	byte   drag_signals_density;             ///< many signals density

   100

	Year   semaphore_build_before;           ///< build semaphore signals automatically before this year

   101

	bool   autorenew;                        ///< should autorenew be enabled for new companies?

   102

	int16  autorenew_months;                 ///< how many months from EOL of vehicles should autorenew trigger for new companies?

   103

	int32  autorenew_money;                  ///< how much money before autorenewing for new companies?

   106

};

   107

   108

/** Settings related to the creation of games. */

   109

struct GameCreationSettings {

   110

	uint32 generation_seed;                  ///< noise seed for world generation

   111

	Year   starting_year;                    ///< starting date

   112

	uint8  map_x;                            ///< X size of map

   113

	uint8  map_y;                            ///< Y size of map

   114

	byte   land_generator;                   ///< the landscape generator

   115

	byte   oil_refinery_limit;               ///< distance oil refineries allowed from map edge

   116

	byte   snow_line_height;                 ///< a number 0-15 that configured snow line height

   117

	byte   tgen_smoothness;                  ///< how rough is the terrain from 0-3

   118

	byte   tree_placer;                      ///< the tree placer algorithm

   119

	byte   heightmap_rotation;               ///< rotation director for the heightmap

   120

	byte   se_flat_world_height;             ///< land height a flat world gets in SE

   124

};

   125

   126

/** Settings related to construction in-game */

   127

struct ConstructionSettings {

   128

	bool   build_on_slopes;                  ///< allow building on slopes

   129

	bool   autoslope;                        ///< allow terraforming under things

   130

	bool   longbridges;                      ///< allow 100 tile long bridges

   131

	bool   signal_side;                      ///< show signals on right side

   132

	bool   extra_dynamite;                   ///< extra dynamite

   133

	bool   road_stop_on_town_road;           ///< allow building of drive-through road stops on town owned roads

   134

	uint8  raw_industry_construction;        ///< type of (raw) industry construction (none, "normal", prospecting)

   135

};

   136

   137

/** Settings related to the AI. */

   138

struct AISettings {

   139

	bool   ainew_active;                     ///< is the new AI active?

   140

	bool   ai_in_multiplayer;                ///< so we allow AIs in multiplayer

   141

	bool   ai_disable_veh_train;             ///< disable types for AI

   142

	bool   ai_disable_veh_roadveh;           ///< disable types for AI

   143

	bool   ai_disable_veh_aircraft;          ///< disable types for AI

   144

	bool   ai_disable_veh_ship;              ///< disable types for AI

   145

};

   146

   147

/** Settings related to the old pathfinder. */

   148

struct OPFSettings {

   149

	uint16 pf_maxlength;                     ///< maximum length when searching for a train route for new pathfinder

   150

	byte   pf_maxdepth;                      ///< maximum recursion depth when searching for a train route for new pathfinder

   151

};

   152

   153

/** Settings related to the new pathfinder. */

   154

struct NPFSettings {

   155

	/**

   156

	 * The maximum amount of search nodes a single NPF run should take. This

   157

	 * limit should make sure performance stays at acceptable levels at the cost

   158

	 * of not being perfect anymore.

   159

	 */

   160

	uint32 npf_max_search_nodes;

   161

   162

	uint32 npf_rail_firstred_penalty;        ///< the penalty for when the first signal is red (and it is not an exit or combo signal)

   163

	uint32 npf_rail_firstred_exit_penalty;   ///< the penalty for when the first signal is red (and it is an exit or combo signal)

   164

	uint32 npf_rail_lastred_penalty;         ///< the penalty for when the last signal is red

   165

	uint32 npf_rail_station_penalty;         ///< the penalty for station tiles

   166

	uint32 npf_rail_slope_penalty;           ///< the penalty for sloping upwards

   167

	uint32 npf_rail_curve_penalty;           ///< the penalty for curves

   168

	uint32 npf_rail_depot_reverse_penalty;   ///< the penalty for reversing in depots

   169

	uint32 npf_buoy_penalty;                 ///< the penalty for going over (through) a buoy

   170

	uint32 npf_water_curve_penalty;          ///< the penalty for curves

   171

	uint32 npf_road_curve_penalty;           ///< the penalty for curves

   172

	uint32 npf_crossing_penalty;             ///< the penalty for level crossings

   173

	uint32 npf_road_drive_through_penalty;   ///< the penalty for going through a drive-through road stop

   174

};

   175

   176

/** Settings related to the yet another pathfinder. */

   177

struct YAPFSettings {

   178

	bool   disable_node_optimization;        ///< whether to use exit-dir instead of trackdir in node key

   179

	uint32 max_search_nodes;                 ///< stop path-finding when this number of nodes visited

   180

	bool   ship_use_yapf;                    ///< use YAPF for ships

   181

	bool   road_use_yapf;                    ///< use YAPF for road

   182

	bool   rail_use_yapf;                    ///< use YAPF for rail

   183

	uint32 road_slope_penalty;               ///< penalty for up-hill slope

   184

	uint32 road_curve_penalty;               ///< penalty for curves

   185

	uint32 road_crossing_penalty;            ///< penalty for level crossing

   186

	uint32 road_stop_penalty;                ///< penalty for going through a drive-through road stop

   187

	bool   rail_firstred_twoway_eol;         ///< treat first red two-way signal as dead end

   188

	uint32 rail_firstred_penalty;            ///< penalty for first red signal

   189

	uint32 rail_firstred_exit_penalty;       ///< penalty for first red exit signal

   190

	uint32 rail_lastred_penalty;             ///< penalty for last red signal

   191

	uint32 rail_lastred_exit_penalty;        ///< penalty for last red exit signal

   192

	uint32 rail_station_penalty;             ///< penalty for non-target station tile

   193

	uint32 rail_slope_penalty;               ///< penalty for up-hill slope

   194

	uint32 rail_curve45_penalty;             ///< penalty for curve

   195

	uint32 rail_curve90_penalty;             ///< penalty for 90-deg curve

   196

	uint32 rail_depot_reverse_penalty;       ///< penalty for reversing in the depot

   197

	uint32 rail_crossing_penalty;            ///< penalty for level crossing

   198

	uint32 rail_look_ahead_max_signals;      ///< max. number of signals taken into consideration in look-ahead load balancer

   199

	int32  rail_look_ahead_signal_p0;        ///< constant in polynomial penalty function

   200

	int32  rail_look_ahead_signal_p1;        ///< constant in polynomial penalty function

   201

	int32  rail_look_ahead_signal_p2;        ///< constant in polynomial penalty function

   202

   203

	uint32 rail_longer_platform_penalty;           ///< penalty for longer  station platform than train

   204

	uint32 rail_longer_platform_per_tile_penalty;  ///< penalty for longer  station platform than train (per tile)

   205

	uint32 rail_shorter_platform_penalty;          ///< penalty for shorter station platform than train

   206

	uint32 rail_shorter_platform_per_tile_penalty; ///< penalty for shorter station platform than train (per tile)

   207

};

   208

   209

/** Settings related to all pathfinders. */

   210

struct PathfinderSettings {

   211

	uint8  pathfinder_for_trains;            ///< the pathfinder to use for trains

   212

	uint8  pathfinder_for_roadvehs;          ///< the pathfinder to use for roadvehicles

   213

	uint8  pathfinder_for_ships;             ///< the pathfinder to use for ships

   214

	bool   new_pathfinding_all;              ///< use the newest pathfinding algorithm for all

   215

   216

	bool   roadveh_queue;                    ///< buggy road vehicle queueing

   217

	bool   forbid_90_deg;                    ///< forbid trains to make 90 deg turns

   218

   219

	byte   wait_oneway_signal;               ///< waitingtime in days before a oneway signal

   220

	byte   wait_twoway_signal;               ///< waitingtime in days before a twoway signal

   221

   222

	OPFSettings  opf;                        ///< pathfinder settings for the old pathfinder

   223

	NPFSettings  npf;                        ///< pathfinder settings for the new pathfinder

   224

	YAPFSettings yapf;                       ///< pathfinder settings for the yet another pathfinder

   225

};

   226

   227

/** Settings related to orders. */

   228

struct OrderSettings {

   229

	bool   improved_load;                    ///< improved loading algorithm

   230

	bool   gradual_loading;                  ///< load vehicles gradually

   231

	bool   selectgoods;                      ///< only send the goods to station if a train has been there

   232

	bool   gotodepot;                        ///< allow goto depot in orders

   233

	bool   no_servicing_if_no_breakdowns;    ///< dont send vehicles to depot when breakdowns are disabled

   234

	bool   timetabling;                      ///< whether to allow timetabling

   235

	bool   serviceathelipad;                 ///< service helicopters at helipads automatically (no need to send to depot)

   236

};

   237

   238

/** Settings related to vehicles. */

   239

struct VehicleSettings {

   240

	bool   mammoth_trains;                   ///< allow very long trains

   241

	bool   realistic_acceleration;           ///< realistic acceleration for trains

   242

	bool   wagon_speed_limits;               ///< enable wagon speed limits

   243

	bool   disable_elrails;                  ///< when true, the elrails are disabled

   244

	UnitID max_trains;                       ///< max trains in game per player

   245

	UnitID max_roadveh;                      ///< max trucks in game per player

   246

	UnitID max_aircraft;                     ///< max planes in game per player

   247

	UnitID max_ships;                        ///< max ships in game per player

   248

	bool   servint_ispercent;                ///< service intervals are in percents

   249

	uint16 servint_trains;                   ///< service interval for trains

   250

	uint16 servint_roadveh;                  ///< service interval for road vehicles

   251

	uint16 servint_aircraft;                 ///< service interval for aircraft

   252

	uint16 servint_ships;                    ///< service interval for ships

   253

	uint8  plane_speed;                      ///< divisor for speed of aircraft

   254

	uint8  freight_trains;                   ///< value to multiply the weight of cargo by

   255

	bool   dynamic_engines;                  ///< enable dynamic allocation of engine data

   256

	bool   never_expire_vehicles;            ///< never expire vehicles

   257

	byte   extend_vehicle_life;              ///< extend vehicle life by this many years

   259

};

   260

   261

/** Settings related to the economy. */

   262

struct EconomySettings {

   263

	bool   inflation;                        ///< disable inflation

   264

	bool   bribe;                            ///< enable bribing the local authority

   265

	bool   smooth_economy;                   ///< smooth economy

   266

	bool   allow_shares;                     ///< allow the buying/selling of shares

   267

	byte   dist_local_authority;             ///< distance for town local authority, default 20

   268

	bool   exclusive_rights;                 ///< allow buying exclusive rights

   269

	bool   give_money;                       ///< allow giving other players money

   270

	bool   mod_road_rebuild;                 ///< roadworks remove unneccesary RoadBits

   271

	bool   multiple_industry_per_town;       ///< allow many industries of the same type per town

   272

	bool   same_industry_close;              ///< allow same type industries to be built close to each other

   273

	uint8  town_growth_rate;                 ///< town growth rate

   274

	uint8  larger_towns;                     ///< the number of cities to build. These start off larger and grow twice as fast

   275

	uint8  initial_city_size;                ///< multiplier for the initial size of the cities compared to towns

   276

	TownLayoutByte town_layout;              ///< select town layout

   277

	bool   station_noise_level;              ///< build new airports when the town noise level is still within accepted limits

   278

	uint16 town_noise_population[3];         ///< population to base decision on noise evaluation (@see town_council_tolerance)

   279

};

   280

   281

/** Settings related to stations. */

   282

struct StationSettings {

   283

	bool   modified_catchment;               ///< different-size catchment areas

   284

	bool   join_stations;                    ///< allow joining of train stations

   285

	bool   nonuniform_stations;              ///< allow nonuniform train stations

   286

	bool   adjacent_stations;                ///< allow stations to be built directly adjacent to other stations

   287

	bool   always_small_airport;             ///< always allow small airports

   288

	byte   station_spread;                   ///< amount a station may spread

   289

};

   290

   291

/** All settings together. */

   292

struct Settings {

   294

	GUISettings          gui;                ///< settings related to the GUI

   295

	GameCreationSettings game_creation;      ///< settings used during the creation of a game (map)

   296

	ConstructionSettings construction;       ///< construction of things in-game

   297

	AISettings           ai;                 ///< what may the AI do?

   298

	PathfinderSettings   pf;                 ///< settings for all pathfinders

   299

	OrderSettings        order;              ///< settings related to orders

   300

	VehicleSettings      vehicle;            ///< options for vehicles

   301

	EconomySettings      economy;            ///< settings to change the economy

   302

	StationSettings      station;            ///< settings related to station management

   303

};

   304

   306

extern Settings _settings;

   307

   309

extern Settings _settings_newgame;

   310

   311

#endif /* SETTINGS_TYPE_H */