Go to the documentation of this file.00001
00002
00003
00004
00005
00006
00007
00008
00009
00012 #ifndef SETTINGS_TYPE_H
00013 #define SETTINGS_TYPE_H
00014
00015 #include "date_type.h"
00016 #include "town_type.h"
00017 #include "transport_type.h"
00018 #include "network/core/config.h"
00019 #include "company_type.h"
00020 #include "cargotype.h"
00021 #include "linkgraph/linkgraph_type.h"
00022 #include "zoom_type.h"
00023 #include "openttd.h"
00024
00026 enum IndustryDensity {
00027 ID_FUND_ONLY,
00028 ID_MINIMAL,
00029 ID_VERY_LOW,
00030 ID_LOW,
00031 ID_NORMAL,
00032 ID_HIGH,
00033
00034 ID_END,
00035 };
00036
00038 struct DifficultySettings {
00039 byte max_no_competitors;
00040 byte number_towns;
00041 byte industry_density;
00042 uint32 max_loan;
00043 byte initial_interest;
00044 byte vehicle_costs;
00045 byte competitor_speed;
00046 byte vehicle_breakdowns;
00047 byte subsidy_multiplier;
00048 byte construction_cost;
00049 byte terrain_type;
00050 byte quantity_sea_lakes;
00051 byte economy;
00052 byte line_reverse_mode;
00053 byte disasters;
00054 byte town_council_tolerance;
00055 byte diff_level;
00056 };
00057
00059 struct GUISettings {
00060 bool sg_full_load_any;
00061 bool lost_vehicle_warn;
00062 uint8 order_review_system;
00063 bool vehicle_income_warn;
00064 bool show_finances;
00065 bool sg_new_nonstop;
00066 bool new_nonstop;
00067 uint8 stop_location;
00068 bool autoscroll;
00069 byte errmsg_duration;
00070 byte hover_delay;
00071 bool link_terraform_toolbar;
00072 uint8 smallmap_land_colour;
00073 bool reverse_scroll;
00074 bool smooth_scroll;
00075 bool measure_tooltip;
00076 byte liveries;
00077 bool prefer_teamchat;
00078 uint8 advanced_vehicle_list;
00079 uint8 loading_indicators;
00080 uint8 default_rail_type;
00081 uint8 toolbar_pos;
00082 uint8 statusbar_pos;
00083 uint8 window_snap_radius;
00084 uint8 window_soft_limit;
00085 ZoomLevelByte zoom_min;
00086 ZoomLevelByte zoom_max;
00087 bool disable_unsuitable_building;
00088 byte autosave;
00089 bool threaded_saves;
00090 bool keep_all_autosave;
00091 bool autosave_on_exit;
00092 uint8 date_format_in_default_names;
00093 byte max_num_autosaves;
00094 bool population_in_label;
00095 uint8 right_mouse_btn_emulation;
00096 uint8 scrollwheel_scrolling;
00097 uint8 scrollwheel_multiplier;
00098 bool timetable_arrival_departure;
00099 bool left_mouse_btn_scrolling;
00100 bool pause_on_newgame;
00101 bool enable_signal_gui;
00102 Year coloured_news_year;
00103 bool timetable_in_ticks;
00104 bool quick_goto;
00105 bool auto_euro;
00106 byte drag_signals_density;
00107 Year semaphore_build_before;
00108 byte news_message_timeout;
00109 bool show_track_reservation;
00110 uint8 default_signal_type;
00111 uint8 cycle_signal_types;
00112 byte station_numtracks;
00113 byte station_platlength;
00114 bool station_dragdrop;
00115 bool station_show_coverage;
00116 bool persistent_buildingtools;
00117 bool expenses_layout;
00118 uint32 last_newgrf_count;
00119 byte missing_strings_threshold;
00120 uint8 graph_line_thickness;
00121
00122 uint16 console_backlog_timeout;
00123 uint16 console_backlog_length;
00124
00125 uint8 station_gui_group_order;
00126 uint8 station_gui_sort_by;
00127 uint8 station_gui_sort_order;
00128 #ifdef ENABLE_NETWORK
00129 uint16 network_chat_box_width;
00130 uint8 network_chat_box_height;
00131 uint16 network_chat_timeout;
00132 #endif
00133
00134 uint8 developer;
00135 bool show_date_in_logs;
00136 bool newgrf_developer_tools;
00137 bool ai_developer_tools;
00138 bool scenario_developer;
00139 bool newgrf_show_old_versions;
00140 uint8 newgrf_default_palette;
00141
00146 bool UserIsAllowedToChangeNewGRFs() const
00147 {
00148 return this->scenario_developer || this->newgrf_developer_tools;
00149 }
00150 };
00151
00153 struct MusicSettings {
00154 byte playlist;
00155 byte music_vol;
00156 byte effect_vol;
00157 byte custom_1[33];
00158 byte custom_2[33];
00159 bool playing;
00160 bool shuffle;
00161 };
00162
00164 struct LocaleSettings {
00165 byte currency;
00166 byte units;
00167 char *digit_group_separator;
00168 char *digit_group_separator_currency;
00169 char *digit_decimal_separator;
00170 };
00171
00173 struct NetworkSettings {
00174 #ifdef ENABLE_NETWORK
00175 uint16 sync_freq;
00176 uint8 frame_freq;
00177 uint16 commands_per_frame;
00178 uint16 max_commands_in_queue;
00179 uint16 bytes_per_frame;
00180 uint16 bytes_per_frame_burst;
00181 uint16 max_init_time;
00182 uint16 max_join_time;
00183 uint16 max_download_time;
00184 uint16 max_password_time;
00185 uint16 max_lag_time;
00186 bool pause_on_join;
00187 uint16 server_port;
00188 uint16 server_admin_port;
00189 bool server_admin_chat;
00190 char server_name[NETWORK_NAME_LENGTH];
00191 char server_password[NETWORK_PASSWORD_LENGTH];
00192 char rcon_password[NETWORK_PASSWORD_LENGTH];
00193 char admin_password[NETWORK_PASSWORD_LENGTH];
00194 bool server_advertise;
00195 uint8 lan_internet;
00196 char client_name[NETWORK_CLIENT_NAME_LENGTH];
00197 char default_company_pass[NETWORK_PASSWORD_LENGTH];
00198 char connect_to_ip[NETWORK_HOSTNAME_LENGTH];
00199 char network_id[NETWORK_SERVER_ID_LENGTH];
00200 bool autoclean_companies;
00201 uint8 autoclean_unprotected;
00202 uint8 autoclean_protected;
00203 uint8 autoclean_novehicles;
00204 uint8 max_companies;
00205 uint8 max_clients;
00206 uint8 max_spectators;
00207 Year restart_game_year;
00208 uint8 min_active_clients;
00209 uint8 server_lang;
00210 bool reload_cfg;
00211 char last_host[NETWORK_HOSTNAME_LENGTH];
00212 uint16 last_port;
00213 bool no_http_content_downloads;
00214 #else
00215 #endif
00216 };
00217
00219 struct GameCreationSettings {
00220 uint32 generation_seed;
00221 Year starting_year;
00222 uint8 map_x;
00223 uint8 map_y;
00224 byte land_generator;
00225 byte oil_refinery_limit;
00226 byte snow_line_height;
00227 byte tgen_smoothness;
00228 byte tree_placer;
00229 byte heightmap_rotation;
00230 byte se_flat_world_height;
00231 byte town_name;
00232 byte landscape;
00233 byte water_borders;
00234 uint16 custom_town_number;
00235 byte variety;
00236 byte custom_sea_level;
00237 byte min_river_length;
00238 byte river_route_random;
00239 byte amount_of_rivers;
00240 };
00241
00243 struct ConstructionSettings {
00244 bool build_on_slopes;
00245 bool autoslope;
00246 uint16 max_bridge_length;
00247 uint16 max_tunnel_length;
00248 bool signal_side;
00249 bool extra_dynamite;
00250 bool road_stop_on_town_road;
00251 bool road_stop_on_competitor_road;
00252 uint8 raw_industry_construction;
00253 uint8 industry_platform;
00254 bool freeform_edges;
00255 uint8 extra_tree_placement;
00256 uint8 command_pause_level;
00257
00258 uint32 terraform_per_64k_frames;
00259 uint16 terraform_frame_burst;
00260 uint32 clear_per_64k_frames;
00261 uint16 clear_frame_burst;
00262 };
00263
00265 struct AISettings {
00266 bool ai_in_multiplayer;
00267 bool ai_disable_veh_train;
00268 bool ai_disable_veh_roadveh;
00269 bool ai_disable_veh_aircraft;
00270 bool ai_disable_veh_ship;
00271 };
00272
00274 struct ScriptSettings {
00275 uint32 script_max_opcode_till_suspend;
00276 };
00277
00279 struct OPFSettings {
00280 uint16 pf_maxlength;
00281 byte pf_maxdepth;
00282 };
00283
00285 struct NPFSettings {
00291 uint32 npf_max_search_nodes;
00292 uint32 maximum_go_to_depot_penalty;
00293
00294 uint32 npf_rail_firstred_penalty;
00295 uint32 npf_rail_firstred_exit_penalty;
00296 uint32 npf_rail_lastred_penalty;
00297 uint32 npf_rail_station_penalty;
00298 uint32 npf_rail_slope_penalty;
00299 uint32 npf_rail_curve_penalty;
00300 uint32 npf_rail_depot_reverse_penalty;
00301 uint32 npf_rail_pbs_cross_penalty;
00302 uint32 npf_rail_pbs_signal_back_penalty;
00303 uint32 npf_buoy_penalty;
00304 uint32 npf_water_curve_penalty;
00305 uint32 npf_road_curve_penalty;
00306 uint32 npf_crossing_penalty;
00307 uint32 npf_road_drive_through_penalty;
00308 uint32 npf_road_dt_occupied_penalty;
00309 uint32 npf_road_bay_occupied_penalty;
00310 };
00311
00313 struct YAPFSettings {
00314 bool disable_node_optimization;
00315 uint32 max_search_nodes;
00316 uint32 maximum_go_to_depot_penalty;
00317 bool ship_use_yapf;
00318 bool road_use_yapf;
00319 bool rail_use_yapf;
00320 uint32 road_slope_penalty;
00321 uint32 road_curve_penalty;
00322 uint32 road_crossing_penalty;
00323 uint32 road_stop_penalty;
00324 uint32 road_stop_occupied_penalty;
00325 uint32 road_stop_bay_occupied_penalty;
00326 bool rail_firstred_twoway_eol;
00327 uint32 rail_firstred_penalty;
00328 uint32 rail_firstred_exit_penalty;
00329 uint32 rail_lastred_penalty;
00330 uint32 rail_lastred_exit_penalty;
00331 uint32 rail_station_penalty;
00332 uint32 rail_slope_penalty;
00333 uint32 rail_curve45_penalty;
00334 uint32 rail_curve90_penalty;
00335 uint32 rail_depot_reverse_penalty;
00336 uint32 rail_crossing_penalty;
00337 uint32 rail_look_ahead_max_signals;
00338 int32 rail_look_ahead_signal_p0;
00339 int32 rail_look_ahead_signal_p1;
00340 int32 rail_look_ahead_signal_p2;
00341 uint32 rail_pbs_cross_penalty;
00342 uint32 rail_pbs_station_penalty;
00343 uint32 rail_pbs_signal_back_penalty;
00344 uint32 rail_doubleslip_penalty;
00345
00346 uint32 rail_longer_platform_penalty;
00347 uint32 rail_longer_platform_per_tile_penalty;
00348 uint32 rail_shorter_platform_penalty;
00349 uint32 rail_shorter_platform_per_tile_penalty;
00350 };
00351
00353 struct PathfinderSettings {
00354 uint8 pathfinder_for_trains;
00355 uint8 pathfinder_for_roadvehs;
00356 uint8 pathfinder_for_ships;
00357 bool new_pathfinding_all;
00358
00359 bool roadveh_queue;
00360 bool forbid_90_deg;
00361
00362 bool reverse_at_signals;
00363 byte wait_oneway_signal;
00364 byte wait_twoway_signal;
00365
00366 bool reserve_paths;
00367 byte wait_for_pbs_path;
00368 byte path_backoff_interval;
00369
00370 OPFSettings opf;
00371 NPFSettings npf;
00372 YAPFSettings yapf;
00373 };
00374
00376 struct OrderSettings {
00377 bool improved_load;
00378 bool gradual_loading;
00379 bool selectgoods;
00380 bool no_servicing_if_no_breakdowns;
00381 bool serviceathelipad;
00382 };
00383
00385 struct VehicleSettings {
00386 uint8 max_train_length;
00387 uint8 smoke_amount;
00388 uint8 train_acceleration_model;
00389 uint8 roadveh_acceleration_model;
00390 uint8 train_slope_steepness;
00391 uint8 roadveh_slope_steepness;
00392 bool wagon_speed_limits;
00393 bool disable_elrails;
00394 UnitID max_trains;
00395 UnitID max_roadveh;
00396 UnitID max_aircraft;
00397 UnitID max_ships;
00398 uint8 plane_speed;
00399 uint8 freight_trains;
00400 bool dynamic_engines;
00401 bool never_expire_vehicles;
00402 byte extend_vehicle_life;
00403 byte road_side;
00404 uint8 plane_crashes;
00405 };
00406
00408 struct EconomySettings {
00409 bool inflation;
00410 bool bribe;
00411 bool smooth_economy;
00412 bool allow_shares;
00413 uint8 feeder_payment_share;
00414 byte dist_local_authority;
00415 bool exclusive_rights;
00416 bool fund_buildings;
00417 bool fund_roads;
00418 bool give_money;
00419 bool mod_road_rebuild;
00420 bool multiple_industry_per_town;
00421 uint8 town_growth_rate;
00422 uint8 larger_towns;
00423 uint8 initial_city_size;
00424 TownLayoutByte town_layout;
00425 bool allow_town_roads;
00426 TownFoundingByte found_town;
00427 bool station_noise_level;
00428 uint16 town_noise_population[3];
00429 bool allow_town_level_crossings;
00430 bool infrastructure_maintenance;
00431 };
00432
00433 struct LinkGraphSettings {
00434 uint16 recalc_interval;
00435 DistributionTypeByte distribution_pax;
00436 DistributionTypeByte distribution_mail;
00437 DistributionTypeByte distribution_armoured;
00438 DistributionTypeByte distribution_default;
00439 uint8 accuracy;
00440 uint8 demand_size;
00441 uint8 demand_distance;
00442 uint8 short_path_saturation;
00443
00444 inline DistributionType GetDistributionType(CargoID cargo) const {
00445 if (IsCargoInClass(cargo, CC_PASSENGERS)) {
00446 return this->distribution_pax;
00447 } else if (IsCargoInClass(cargo, CC_MAIL)) {
00448 return this->distribution_mail;
00449 } else if (IsCargoInClass(cargo, CC_ARMOURED)) {
00450 return this->distribution_armoured;
00451 } else {
00452 return this->distribution_default;
00453 }
00454 }
00455 };
00456
00458 struct StationSettings {
00459 bool modified_catchment;
00460 bool adjacent_stations;
00461 bool distant_join_stations;
00462 bool never_expire_airports;
00463 byte station_spread;
00464 };
00465
00467 struct VehicleDefaultSettings {
00468 bool servint_ispercent;
00469 uint16 servint_trains;
00470 uint16 servint_roadveh;
00471 uint16 servint_aircraft;
00472 uint16 servint_ships;
00473 };
00474
00476 struct CompanySettings {
00477 bool engine_renew;
00478 int16 engine_renew_months;
00479 uint32 engine_renew_money;
00480 bool renew_keep_length;
00481 VehicleDefaultSettings vehicle;
00482 };
00483
00485 struct GameSettings {
00486 DifficultySettings difficulty;
00487 GameCreationSettings game_creation;
00488 ConstructionSettings construction;
00489 AISettings ai;
00490 ScriptSettings script;
00491 class AIConfig *ai_config[MAX_COMPANIES];
00492 class GameConfig *game_config;
00493 PathfinderSettings pf;
00494 OrderSettings order;
00495 VehicleSettings vehicle;
00496 EconomySettings economy;
00497 LinkGraphSettings linkgraph;
00498 StationSettings station;
00499 LocaleSettings locale;
00500 };
00501
00503 struct ClientSettings {
00504 GUISettings gui;
00505 NetworkSettings network;
00506 CompanySettings company;
00507 MusicSettings music;
00508 };
00509
00511 extern ClientSettings _settings_client;
00512
00514 extern GameSettings _settings_game;
00515
00517 extern GameSettings _settings_newgame;
00518
00520 extern VehicleDefaultSettings _old_vds;
00521
00526 static inline GameSettings &GetGameSettings()
00527 {
00528 return (_game_mode == GM_MENU) ? _settings_newgame : _settings_game;
00529 }
00530
00531 #endif