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"

    11

    12

#define GAME_DIFFICULTY_NUM 18

    13

    14

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

    15

typedef uint16 GDType;

    16

struct GameDifficulty {

    17

	GDType max_no_competitors;

    18

	GDType competitor_start_time;

    19

	GDType number_towns;

    20

	GDType number_industries;

    21

	GDType max_loan;

    22

	GDType initial_interest;

    23

	GDType vehicle_costs;

    24

	GDType competitor_speed;

    25

	GDType competitor_intelligence; ///< no longer in use

    26

	GDType vehicle_breakdowns;

    27

	GDType subsidy_multiplier;

    28

	GDType construction_cost;

    29

	GDType terrain_type;

    30

	GDType quantity_sea_lakes;

    31

	GDType economy;

    32

	GDType line_reverse_mode;

    33

	GDType disasters;

    34

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

    35

};

    36

    37

struct GameOptions {

    38

	GameDifficulty diff;

    39

	byte diff_level;

    40

	byte currency;

    41

	byte units;

    42

	byte town_name;

    43

	byte landscape;

    44

	byte snow_line;

    45

	byte autosave;

    46

	byte road_side;

    47

};

    48

    49

/* These are the options for the current game

    50

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

    51

extern GameOptions _opt;

    52

    53

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

    54

extern GameOptions _opt_newgame;

    55

    56

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

    57

extern GameOptions *_opt_ptr;

    58

    59

struct Patches {

    60

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

    61

	bool vehicle_speed;                 ///< show vehicle speed

    62

	bool build_on_slopes;               ///< allow building on slopes

    63

	bool mammoth_trains;                ///< allow very long trains

    64

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

    65

	bool full_load_any;                 ///< new full load calculation, any cargo must be full

    66

	bool improved_load;                 ///< improved loading algorithm

    67

	bool gradual_loading;               ///< load vehicles gradually

    68

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

    69

	bool inflation;                     ///< disable inflation

    70

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

    71

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

    72

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

    73

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

    74

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

    75

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

    76

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

    77

	uint8 order_review_system;

    78

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

    79

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

    80

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

    81

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

    82

	bool new_nonstop;                   ///< ttdpatch compatible nonstop handling

    83

	bool roadveh_queue;                 ///< buggy road vehicle queueing

    84

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

    85

	byte errmsg_duration;               ///< duration of error message

    86

	byte land_generator;                ///< the landscape generator

    87

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

    88

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

    89

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

    90

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

    91

	byte tree_placer;                   ///< the tree placer algorithm

    92

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

    93

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

    94

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

    95

	bool nonuniform_stations;           ///< allow nonuniform train stations

    96

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

    97

	bool always_small_airport;          ///< always allow small airports

    98

	bool realistic_acceleration;        ///< realistic acceleration for trains

    99

	bool wagon_speed_limits;            ///< enable wagon speed limits

   100

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

   101

	bool invisible_trees;               ///< don't show trees when buildings are transparent

   102

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

   103

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

   104

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

   105

	bool smooth_scroll;                 ///< Smooth scroll viewports

   106

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

   107

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

   108

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

   109

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

   110

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

   111

	uint8 loading_indicators;           ///< Show loading indicators

   112

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

   113

   114

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

   115

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

   116

   117

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

   118

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

   119

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

   120

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

   121

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

   122

   123

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

   124

	uint16 servint_trains;              ///< service interval for trains

   125

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

   126

	uint16 servint_aircraft;            ///< service interval for aircraft

   127

	uint16 servint_ships;               ///< service interval for ships

   128

   129

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

   130

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

   131

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

   132

   133

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

   134

   135

	bool autorenew;

   136

	int16 autorenew_months;

   137

	int32 autorenew_money;

   138

   139

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

   140

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

   141

   142

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

   143

   144

	bool ai_disable_veh_train;             ///< disable types for AI

   145

	bool ai_disable_veh_roadveh;           ///< disable types for AI

   146

	bool ai_disable_veh_aircraft;          ///< disable types for AI

   147

	bool ai_disable_veh_ship;              ///< disable types for AI

   148

	Year starting_year;                    ///< starting date

   149

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

   150

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

   151

   152

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

   153

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

   154

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

   155

	bool extra_dynamite;                   ///< extra dynamite

   156

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

   157

   158

	bool never_expire_vehicles;            ///< never expire vehicles

   159

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

   160

   161

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

   162

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

   163

	bool smooth_economy;                   ///< smooth economy

   164

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

   165

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

   166

   167

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

   168

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

   169

   170

	uint8 map_x;                           ///< Size of map

   171

	uint8 map_y;

   172

   173

	byte drag_signals_density;             ///< many signals density

   174

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

   175

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

   176

   177

	/*

   178

	 * New Path Finding

   179

	 */

   180

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

   181

   182

	/**

   183

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

   184

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

   185

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

   186

	 * sophisticated way sometime soon

   187

	 */

   188

	uint32 npf_max_search_nodes;

   189

   190

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

   191

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

   192

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

   193

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

   194

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

   195

	uint32 npf_rail_curve_penalty;         ///< The penalty for curves

   196

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

   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

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

   204

   205

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

   206

   207

	/** YAPF settings */

   208

	YapfSettings  yapf;

   209

   210

	uint8 right_mouse_btn_emulation;

   211

   212

	uint8 scrollwheel_scrolling;

   213

	uint8 scrollwheel_multiplier;

   214

   215

	uint8 town_growth_rate;      ///< Town growth rate

   216

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

   217

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

   218

   219

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

   220

   221

	TownLayoutByte town_layout;  ///< Select town layout

   222

   223

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

   224

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

   225

   226

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

   227

   228

	bool mod_road_rebuild;       ///< Roadworks remove unneccesary RoadBits

   229

   230

	bool exclusive_rights;       ///< allow buying exclusive rights

   231

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

   232

   233

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

   234

};

   235

   236

extern Patches _patches;

   237

   238

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

   239

extern Patches _patches_newgame;

   240

   241

#endif /* SETTINGS_TYPE_H */