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 "yapf/yapf_settings.h"

     9

#include "date_type.h"

    10

#include "town_type.h"

    12

    13

#define GAME_DIFFICULTY_NUM 18

    14

    15

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

    16

typedef uint16 GDType;

    17

struct GameDifficulty {

    18

	GDType max_no_competitors;

    19

	GDType competitor_start_time;

    20

	GDType number_towns;

    21

	GDType number_industries;

    22

	GDType max_loan;

    23

	GDType initial_interest;

    24

	GDType vehicle_costs;

    25

	GDType competitor_speed;

    26

	GDType competitor_intelligence; ///< no longer in use

    27

	GDType vehicle_breakdowns;

    28

	GDType subsidy_multiplier;

    29

	GDType construction_cost;

    30

	GDType terrain_type;

    31

	GDType quantity_sea_lakes;

    32

	GDType economy;

    33

	GDType line_reverse_mode;

    34

	GDType disasters;

    35

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

    36

};

    37

    38

struct GameOptions {

    39

	GameDifficulty diff;

    40

	byte diff_level;

    41

	byte currency;

    42

	byte units;

    43

	byte town_name;

    44

	byte landscape;

    45

	byte snow_line;

    46

	byte autosave;

    47

	byte road_side;

    48

};

    49

    50

/* These are the options for the current game

    51

 * either ingame, or loaded. Also used for networking games */

    52

extern GameOptions _opt;

    53

    54

/* These are the default options for a new game */

    55

extern GameOptions _opt_newgame;

    56

    57

/* Pointer to one of the two _opt OR _opt_newgame structs */

    58

extern GameOptions *_opt_ptr;

    59

    60

struct Patches {

    61

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

    62

	bool vehicle_speed;                 ///< show vehicle speed

    63

	bool build_on_slopes;               ///< allow building on slopes

    64

	bool mammoth_trains;                ///< allow very long trains

    65

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

    66

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

    67

	bool improved_load;                 ///< improved loading algorithm

    68

	bool gradual_loading;               ///< load vehicles gradually

    69

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

    70

	bool inflation;                     ///< disable inflation

    71

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

    72

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

    73

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

    74

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

    75

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

    76

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

    77

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

    78

	uint8 order_review_system;

    79

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

    80

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

    81

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

    82

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

    83

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

    84

	bool new_nonstop;                   ///< ttdpatch compatible nonstop handling

    85

	bool roadveh_queue;                 ///< buggy road vehicle queueing

    86

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

    87

	byte errmsg_duration;               ///< duration of error message

    88

	byte land_generator;                ///< the landscape generator

    89

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

    90

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

    91

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

    92

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

    93

	byte tree_placer;                   ///< the tree placer algorithm

    94

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

    95

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

    96

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

    97

	bool nonuniform_stations;           ///< allow nonuniform train stations

    98

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

    99

	bool always_small_airport;          ///< always allow small airports

   100

	bool realistic_acceleration;        ///< realistic acceleration for trains

   101

	bool wagon_speed_limits;            ///< enable wagon speed limits

   102

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

   103

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

   104

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

   105

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

   106

	bool smooth_scroll;                 ///< Smooth scroll viewports

   107

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

   108

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

   109

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

   110

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

   111

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

   112

	uint8 loading_indicators;           ///< Show loading indicators

   113

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

   114

   115

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

   116

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

   117

   118

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

   119

	UnitID max_trains;                  ///< max trains in game per player (these are 16bit because the unitnumber field can't hold more)

   120

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

   121

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

   122

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

   123

   124

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

   125

	uint16 servint_trains;              ///< service interval for trains

   126

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

   127

	uint16 servint_aircraft;            ///< service interval for aircraft

   128

	uint16 servint_ships;               ///< service interval for ships

   129

   130

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

   131

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

   132

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

   133

   134

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

   135

   136

	bool autorenew;

   137

	int16 autorenew_months;

   138

	int32 autorenew_money;

   139

   140

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

   141

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

   142

   143

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

   144

   145

	bool ai_disable_veh_train;             ///< disable types for AI

   146

	bool ai_disable_veh_roadveh;           ///< disable types for AI

   147

	bool ai_disable_veh_aircraft;          ///< disable types for AI

   148

	bool ai_disable_veh_ship;              ///< disable types for AI

   149

	Year starting_year;                    ///< starting date

   150

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

   151

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

   152

   153

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

   154

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

   155

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

   156

	bool extra_dynamite;                   ///< extra dynamite

   157

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

   158

   159

	bool never_expire_vehicles;            ///< never expire vehicles

   160

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

   161

   162

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

   163

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

   164

	bool smooth_economy;                   ///< smooth economy

   165

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

   166

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

   167

   168

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

   169

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

   170

   171

	uint8 map_x;                           ///< Size of map

   172

	uint8 map_y;

   173

   174

	byte drag_signals_density;             ///< many signals density

   175

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

   176

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

   177

   178

	/*

   179

	 * New Path Finding

   180

	 */

   181

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

   182

   183

	/**

   184

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

   185

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

   186

	 * of not being perfect anymore. This will probably be fixed in a more

   187

	 * sophisticated way sometime soon

   188

	 */

   189

	uint32 npf_max_search_nodes;

   190

   191

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

   192

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

   193

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

   194

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

   195

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

   196

	uint32 npf_rail_curve_penalty;         ///< The penalty for curves

   197

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

   198

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

   199

	uint32 npf_water_curve_penalty;        ///< The penalty for curves

   200

	uint32 npf_road_curve_penalty;         ///< The penalty for curves

   201

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

   202

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

   203

   204

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

   205

   206

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

   207

   208

	/** YAPF settings */

   209

	YapfSettings  yapf;

   210

   211

	uint8 right_mouse_btn_emulation;

   212

   213

	uint8 scrollwheel_scrolling;

   214

	uint8 scrollwheel_multiplier;

   215

   216

	uint8 town_growth_rate;      ///< Town growth rate

   217

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

   218

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

   219

   220

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

   221

   222

	TownLayoutByte town_layout;  ///< Select town layout

   223

   224

	bool timetabling;            ///< Whether to allow timetabling.

   225

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

   226

   227

	bool autoslope;              ///< Allow terraforming under things.

   228

   229

	bool mod_road_rebuild;       ///< Roadworks remove unneccesary RoadBits

   230

   231

	bool exclusive_rights;       ///< allow buying exclusive rights

   232

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

   233

   234

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

   237

};

   238

   239

extern Patches _patches;

   240

   241

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

   242

extern Patches _patches_newgame;

   243

   244

#endif /* SETTINGS_TYPE_H */