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

#include "network/core/config.h"

    12

    13

/** Settings related to the difficulty of the game */

    14

struct DifficultySettings {

    15

	byte   max_no_competitors;               ///< the number of competitors (AIs)

    16

	byte   competitor_start_time;            ///< how long to wait for the first competitors (AIs)

    17

	byte   number_towns;                     ///< the amount of towns

    18

	byte   number_industries;                ///< the amount of industries

    19

	uint32 max_loan;                         ///< the maximum initial loan

    20

	byte   initial_interest;                 ///< amount of interest (to pay over the loan)

    21

	byte   vehicle_costs;                    ///< amount of money spent on vehicle running cost

    22

	byte   competitor_speed;                 ///< the speed at which the AI builds

    23

	byte   competitor_intelligence;          ///< the competior's (AI) intelligence

    24

	byte   vehicle_breakdowns;               ///< likelihood of vehicles breaking down

    25

	byte   subsidy_multiplier;               ///< amount of subsidy

    26

	byte   construction_cost;                ///< how expensive is building

    27

	byte   terrain_type;                     ///< the mountainousness of the landscape

    28

	byte   quantity_sea_lakes;               ///< the amount of seas/lakes

    29

	byte   economy;                          ///< how volatile is the economy

    30

	byte   line_reverse_mode;                ///< reversing at stations or not

    31

	byte   disasters;                        ///< are disasters enabled

    32

	byte   town_council_tolerance;           ///< minimum required town ratings to be allowed to demolish stuff

    33

	byte   diff_level;                       ///< the difficulty level

    34

};

    35

    36

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

    37

struct GUISettings {

    38

	bool   vehicle_speed;                    ///< show vehicle speed

    39

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

    40

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

    41

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

    42

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

    43

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

    44

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

    45

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

    46

	bool   new_nonstop;                      ///< ttdpatch compatible nonstop handling

    47

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

    48

	byte   errmsg_duration;                  ///< duration of error message

    49

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

    50

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

    51

	bool   smooth_scroll;                    ///< smooth scroll viewports

    52

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

    53

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

    54

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

    55

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

    56

	uint8  loading_indicators;               ///< show loading indicators

    57

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

    58

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

    59

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

    60

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

    61

	byte   autosave;                         ///< how often should we do autosaves?

    62

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

    63

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

    64

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

    65

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

    66

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

    67

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

    68

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

    69

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

    70

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

    71

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

    72

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

    73

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

    74

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

    75

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

    76

	byte   drag_signals_density;             ///< many signals density

    77

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

    78

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

    79

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

    80

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

    81

	byte   news_message_timeout;             ///< how much longer than the news message "age" should we keep the message in the history

    82

	bool   show_track_reservation;           ///< highlight reserved tracks.

    83

	uint8  default_signal_type;              ///< the signal type to build by default.

    84

	uint8  cycle_signal_types;               ///< what signal types to cycle with the build signal tool.

    85

    86

	uint16 console_backlog_timeout;          ///< the minimum amount of time items should be in the console backlog before they will be removed in ~3 seconds granularity.

    87

	uint16 console_backlog_length;           ///< the minimum amount of items in the console backlog before items will be removed.

    88

#ifdef ENABLE_NETWORK

    89

	uint16 network_chat_box_width;           ///< width of the chat box in pixels

    90

	uint8  network_chat_box_height;          ///< height of the chat box in lines

    91

#endif

    92

};

    93

    94

/** Settings related to currency/unit systems. */

    95

struct LocaleSettings {

    96

	byte   currency;                         ///< currency we currently use

    97

	byte   units;                            ///< unit system we show everything

    98

};

    99

   100

/** All settings related to the network. */

   101

struct NetworkSettings {

   102

#ifdef ENABLE_NETWORK

   103

	uint16 sync_freq;                                     ///< how often do we check whether we are still in-sync

   104

	uint8  frame_freq;                                    ///< how often do we send commands to the clients

   105

	uint16 max_join_time;                                 ///< maximum amount of time, in game ticks, a client may take to join

   106

	bool   pause_on_join;                                 ///< pause the game when people join

   107

	char   server_bind_ip[NETWORK_HOSTNAME_LENGTH];       ///< IP address the server binds to

   108

	uint16 server_port;                                   ///< port the server listens on

   109

	char   server_name[NETWORK_NAME_LENGTH];              ///< name of the server

   110

	char   server_password[NETWORK_PASSWORD_LENGTH];      ///< passowrd for joining this server

   111

	char   rcon_password[NETWORK_PASSWORD_LENGTH];        ///< passowrd for rconsole (server side)

   112

	bool   server_advertise;                              ///< advertise the server to the masterserver

   113

	uint8  lan_internet;                                  ///< search on the LAN or internet for servers

   114

	char   client_name[NETWORK_NAME_LENGTH];              ///< name of the player (as client)

   115

	char   default_company_pass[NETWORK_PASSWORD_LENGTH]; ///< default password for new companies in encrypted form

   116

	char   connect_to_ip[NETWORK_HOSTNAME_LENGTH];        ///< default for the "Add server" query

   117

	char   network_id[NETWORK_UNIQUE_ID_LENGTH];          ///< semi-unique ID of the client

   118

	bool   autoclean_companies;                           ///< automatically remove companies that are not in use

   119

	uint8  autoclean_unprotected;                         ///< remove passwordless companies after this many months

   120

	uint8  autoclean_protected;                           ///< remove the password from passworded companies after this many months

   121

	uint8  max_companies;                                 ///< maximum amount of companies

   122

	uint8  max_clients;                                   ///< maximum amount of clients

   123

	uint8  max_spectators;                                ///< maximum amount of spectators

   124

	Year   restart_game_year;                             ///< year the server restarts

   125

	uint8  min_active_clients;                            ///< minimum amount of active clients to unpause the game

   126

	uint8  server_lang;                                   ///< language of the server

   127

	bool   reload_cfg;                                    ///< reload the config file before restarting

   128

	char   last_host[NETWORK_HOSTNAME_LENGTH];            ///< IP address of the last joined server

   129

	uint16 last_port;                                     ///< port of the last joined server

   130

#else /* ENABLE_NETWORK */

   131

#endif

   132

};

   133

   134

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

   135

struct GameCreationSettings {

   136

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

   137

	Year   starting_year;                    ///< starting date

   138

	uint8  map_x;                            ///< X size of map

   139

	uint8  map_y;                            ///< Y size of map

   140

	byte   land_generator;                   ///< the landscape generator

   141

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

   142

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

   143

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

   144

	byte   tree_placer;                      ///< the tree placer algorithm

   145

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

   146

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

   147

	byte   town_name;                        ///< the town name generator used for town names

   148

	byte   landscape;                        ///< the landscape we're currently in

   149

	byte   snow_line;                        ///< the snowline level in this game

   150

};

   151

   152

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

   153

struct ConstructionSettings {

   154

	bool   build_on_slopes;                  ///< allow building on slopes

   155

	bool   autoslope;                        ///< allow terraforming under things

   156

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

   157

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

   158

	bool   extra_dynamite;                   ///< extra dynamite

   159

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

   160

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

   161

};

   162

   163

/** Settings related to the AI. */

   164

struct AISettings {

   165

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

   166

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

   167

	bool   ai_disable_veh_train;             ///< disable types for AI

   168

	bool   ai_disable_veh_roadveh;           ///< disable types for AI

   169

	bool   ai_disable_veh_aircraft;          ///< disable types for AI

   170

	bool   ai_disable_veh_ship;              ///< disable types for AI

   171

};

   172

   173

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

   174

struct OPFSettings {

   175

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

   176

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

   177

};

   178

   179

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

   180

struct NPFSettings {

   181

	/**

   182

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

   183

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

   184

	 * of not being perfect anymore.

   185

	 */

   186

	uint32 npf_max_search_nodes;

   187

   188

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

   189

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

   190

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

   191

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

   192

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

   193

	uint32 npf_rail_curve_penalty;           ///< the penalty for curves

   194

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

   195

	uint32 npf_rail_pbs_cross_penalty;       ///< the penalty for crossing a reserved rail track

   196

	uint32 npf_rail_pbs_signal_back_penalty; ///< the penalty for passing a pbs signal from the backside

   197

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

   198

	uint32 npf_water_curve_penalty;          ///< the penalty for curves

   199

	uint32 npf_road_curve_penalty;           ///< the penalty for curves

   200

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

   201

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

   202

};

   203

   204

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

   205

struct YAPFSettings {

   206

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

   207

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

   208

	bool   ship_use_yapf;                    ///< use YAPF for ships

   209

	bool   road_use_yapf;                    ///< use YAPF for road

   210

	bool   rail_use_yapf;                    ///< use YAPF for rail

   211

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

   212

	uint32 road_curve_penalty;               ///< penalty for curves

   213

	uint32 road_crossing_penalty;            ///< penalty for level crossing

   214

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

   215

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

   216

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

   217

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

   218

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

   219

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

   220

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

   221

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

   222

	uint32 rail_curve45_penalty;             ///< penalty for curve

   223

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

   224

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

   225

	uint32 rail_crossing_penalty;            ///< penalty for level crossing

   226

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

   227

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

   228

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

   229

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

   230

	uint32 rail_pbs_cross_penalty;           ///< penalty for crossing a reserved tile

   231

	uint32 rail_pbs_station_penalty;         ///< penalty for crossing a reserved station tile

   232

	uint32 rail_pbs_signal_back_penalty;     ///< penalty for passing a pbs signal from the backside

   233

	uint32 rail_doubleslip_penalty;          ///< penalty for passing a double slip switch

   234

   235

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

   236

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

   237

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

   238

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

   239

};

   240

   241

/** Settings related to all pathfinders. */

   242

struct PathfinderSettings {

   243

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

   244

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

   245

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

   246

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

   247

   248

	bool   roadveh_queue;                    ///< buggy road vehicle queueing

   249

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

   250

   251

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

   252

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

   253

   254

	bool   reserve_paths;                    ///< always reserve paths regardless of signal type.

   255

	byte   wait_for_pbs_path;                ///< how long to wait for a path reservation.

   256

	byte   path_backoff_interval;            ///< ticks between checks for a free path.

   257

   258

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

   259

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

   260

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

   261

};

   262

   263

/** Settings related to orders. */

   264

struct OrderSettings {

   265

	bool   improved_load;                    ///< improved loading algorithm

   266

	bool   gradual_loading;                  ///< load vehicles gradually

   267

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

   268

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

   269

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

   270

	bool   timetabling;                      ///< whether to allow timetabling

   271

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

   272

};

   273

   274

/** Settings related to vehicles. */

   275

struct VehicleSettings {

   276

	bool   mammoth_trains;                   ///< allow very long trains

   277

	bool   realistic_acceleration;           ///< realistic acceleration for trains

   278

	bool   wagon_speed_limits;               ///< enable wagon speed limits

   279

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

   280

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

   281

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

   282

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

   283

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

   284

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

   285

	uint16 servint_trains;                   ///< service interval for trains

   286

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

   287

	uint16 servint_aircraft;                 ///< service interval for aircraft

   288

	uint16 servint_ships;                    ///< service interval for ships

   289

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

   290

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

   291

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

   292

	bool   never_expire_vehicles;            ///< never expire vehicles

   293

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

   294

	byte   road_side;                        ///< the side of the road vehicles drive on

   295

};

   296

   297

/** Settings related to the economy. */

   298

struct EconomySettings {

   299

	bool   inflation;                        ///< disable inflation

   300

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

   301

	bool   smooth_economy;                   ///< smooth economy

   302

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

   303

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

   304

	bool   exclusive_rights;                 ///< allow buying exclusive rights

   305

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

   306

	bool   mod_road_rebuild;                 ///< roadworks remove unneccesary RoadBits

   307

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

   308

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

   309

	uint8  town_growth_rate;                 ///< town growth rate

   310

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

   311

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

   312

	TownLayoutByte town_layout;              ///< select town layout

   313

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

   314

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

   315

};

   316

   317

/** Settings related to stations. */

   318

struct StationSettings {

   319

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

   320

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

   321

	bool   nonuniform_stations;              ///< allow nonuniform train stations

   322

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

   323

	bool   always_small_airport;             ///< always allow small airports

   324

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

   325

};

   326

   327

/** All settings together for the game. */

   328

struct GameSettings {

   329

	DifficultySettings   difficulty;         ///< settings related to the difficulty

   330

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

   331

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

   332

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

   333

	PathfinderSettings   pf;                 ///< settings for all pathfinders

   334

	OrderSettings        order;              ///< settings related to orders

   335

	VehicleSettings      vehicle;            ///< options for vehicles

   336

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

   337

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

   338

	LocaleSettings       locale;             ///< settings related to used currency/unit system in the current game

   339

};

   340

   341

/** All settings that are only important for the local client. */

   342

struct ClientSettings {

   343

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

   344

	NetworkSettings      network;            ///< settings related to the network

   345

};

   346

   347

/** The current settings for this game. */

   348

extern ClientSettings _settings_client;

   349

   350

/** The current settings for this game. */

   351

extern GameSettings _settings_game;

   352

   353

/** The settings values that are used for new games and/or modified in config file. */

   354

extern GameSettings _settings_newgame;

   355

   356

#endif /* SETTINGS_TYPE_H */