settings_type.h

Go to the documentation of this file.
00001 /* $Id$ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
00006  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00007  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
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_join_time;                                 
00182   bool   pause_on_join;                                 
00183   uint16 server_port;                                   
00184   uint16 server_admin_port;                             
00185   bool   server_admin_chat;                             
00186   char   server_name[NETWORK_NAME_LENGTH];              
00187   char   server_password[NETWORK_PASSWORD_LENGTH];      
00188   char   rcon_password[NETWORK_PASSWORD_LENGTH];        
00189   char   admin_password[NETWORK_PASSWORD_LENGTH];       
00190   bool   server_advertise;                              
00191   uint8  lan_internet;                                  
00192   char   client_name[NETWORK_CLIENT_NAME_LENGTH];       
00193   char   default_company_pass[NETWORK_PASSWORD_LENGTH]; 
00194   char   connect_to_ip[NETWORK_HOSTNAME_LENGTH];        
00195   char   network_id[NETWORK_SERVER_ID_LENGTH];          
00196   bool   autoclean_companies;                           
00197   uint8  autoclean_unprotected;                         
00198   uint8  autoclean_protected;                           
00199   uint8  autoclean_novehicles;                          
00200   uint8  max_companies;                                 
00201   uint8  max_clients;                                   
00202   uint8  max_spectators;                                
00203   Year   restart_game_year;                             
00204   uint8  min_active_clients;                            
00205   uint8  server_lang;                                   
00206   bool   reload_cfg;                                    
00207   char   last_host[NETWORK_HOSTNAME_LENGTH];            
00208   uint16 last_port;                                     
00209   bool   no_http_content_downloads;                     
00210 #else /* ENABLE_NETWORK */
00211 #endif
00212 };
00213 
00215 struct GameCreationSettings {
00216   uint32 generation_seed;                  
00217   Year   starting_year;                    
00218   uint8  map_x;                            
00219   uint8  map_y;                            
00220   byte   land_generator;                   
00221   byte   oil_refinery_limit;               
00222   byte   snow_line_height;                 
00223   byte   tgen_smoothness;                  
00224   byte   tree_placer;                      
00225   byte   heightmap_rotation;               
00226   byte   se_flat_world_height;             
00227   byte   town_name;                        
00228   byte   landscape;                        
00229   byte   water_borders;                    
00230   uint16 custom_town_number;               
00231   byte   variety;                          
00232   byte   custom_sea_level;                 
00233   byte   min_river_length;                 
00234   byte   river_route_random;               
00235   byte   amount_of_rivers;                 
00236 };
00237 
00239 struct ConstructionSettings {
00240   bool   build_on_slopes;                  
00241   bool   autoslope;                        
00242   uint16 max_bridge_length;                
00243   uint16 max_tunnel_length;                
00244   bool   signal_side;                      
00245   bool   extra_dynamite;                   
00246   bool   road_stop_on_town_road;           
00247   bool   road_stop_on_competitor_road;     
00248   uint8  raw_industry_construction;        
00249   uint8  industry_platform;                
00250   bool   freeform_edges;                   
00251   uint8  extra_tree_placement;             
00252   uint8  command_pause_level;              
00253 
00254   uint32 terraform_per_64k_frames;         
00255   uint16 terraform_frame_burst;            
00256   uint32 clear_per_64k_frames;             
00257   uint16 clear_frame_burst;                
00258 };
00259 
00261 struct AISettings {
00262   bool   ai_in_multiplayer;                
00263   bool   ai_disable_veh_train;             
00264   bool   ai_disable_veh_roadveh;           
00265   bool   ai_disable_veh_aircraft;          
00266   bool   ai_disable_veh_ship;              
00267 };
00268 
00270 struct ScriptSettings {
00271   uint32 script_max_opcode_till_suspend;   
00272 };
00273 
00275 struct OPFSettings {
00276   uint16 pf_maxlength;                     
00277   byte   pf_maxdepth;                      
00278 };
00279 
00281 struct NPFSettings {
00287   uint32 npf_max_search_nodes;
00288   uint32 maximum_go_to_depot_penalty;      
00289 
00290   uint32 npf_rail_firstred_penalty;        
00291   uint32 npf_rail_firstred_exit_penalty;   
00292   uint32 npf_rail_lastred_penalty;         
00293   uint32 npf_rail_station_penalty;         
00294   uint32 npf_rail_slope_penalty;           
00295   uint32 npf_rail_curve_penalty;           
00296   uint32 npf_rail_depot_reverse_penalty;   
00297   uint32 npf_rail_pbs_cross_penalty;       
00298   uint32 npf_rail_pbs_signal_back_penalty; 
00299   uint32 npf_buoy_penalty;                 
00300   uint32 npf_water_curve_penalty;          
00301   uint32 npf_road_curve_penalty;           
00302   uint32 npf_crossing_penalty;             
00303   uint32 npf_road_drive_through_penalty;   
00304   uint32 npf_road_dt_occupied_penalty;     
00305   uint32 npf_road_bay_occupied_penalty;    
00306 };
00307 
00309 struct YAPFSettings {
00310   bool   disable_node_optimization;        
00311   uint32 max_search_nodes;                 
00312   uint32 maximum_go_to_depot_penalty;      
00313   bool   ship_use_yapf;                    
00314   bool   road_use_yapf;                    
00315   bool   rail_use_yapf;                    
00316   uint32 road_slope_penalty;               
00317   uint32 road_curve_penalty;               
00318   uint32 road_crossing_penalty;            
00319   uint32 road_stop_penalty;                
00320   uint32 road_stop_occupied_penalty;       
00321   uint32 road_stop_bay_occupied_penalty;   
00322   bool   rail_firstred_twoway_eol;         
00323   uint32 rail_firstred_penalty;            
00324   uint32 rail_firstred_exit_penalty;       
00325   uint32 rail_lastred_penalty;             
00326   uint32 rail_lastred_exit_penalty;        
00327   uint32 rail_station_penalty;             
00328   uint32 rail_slope_penalty;               
00329   uint32 rail_curve45_penalty;             
00330   uint32 rail_curve90_penalty;             
00331   uint32 rail_depot_reverse_penalty;       
00332   uint32 rail_crossing_penalty;            
00333   uint32 rail_look_ahead_max_signals;      
00334   int32  rail_look_ahead_signal_p0;        
00335   int32  rail_look_ahead_signal_p1;        
00336   int32  rail_look_ahead_signal_p2;        
00337   uint32 rail_pbs_cross_penalty;           
00338   uint32 rail_pbs_station_penalty;         
00339   uint32 rail_pbs_signal_back_penalty;     
00340   uint32 rail_doubleslip_penalty;          
00341 
00342   uint32 rail_longer_platform_penalty;           
00343   uint32 rail_longer_platform_per_tile_penalty;  
00344   uint32 rail_shorter_platform_penalty;          
00345   uint32 rail_shorter_platform_per_tile_penalty; 
00346 };
00347 
00349 struct PathfinderSettings {
00350   uint8  pathfinder_for_trains;            
00351   uint8  pathfinder_for_roadvehs;          
00352   uint8  pathfinder_for_ships;             
00353   bool   new_pathfinding_all;              
00354 
00355   bool   roadveh_queue;                    
00356   bool   forbid_90_deg;                    
00357 
00358   bool   reverse_at_signals;               
00359   byte   wait_oneway_signal;               
00360   byte   wait_twoway_signal;               
00361 
00362   bool   reserve_paths;                    
00363   byte   wait_for_pbs_path;                
00364   byte   path_backoff_interval;            
00365 
00366   OPFSettings  opf;                        
00367   NPFSettings  npf;                        
00368   YAPFSettings yapf;                       
00369 };
00370 
00372 struct OrderSettings {
00373   bool   improved_load;                    
00374   bool   gradual_loading;                  
00375   bool   selectgoods;                      
00376   bool   no_servicing_if_no_breakdowns;    
00377   bool   serviceathelipad;                 
00378 };
00379 
00381 struct VehicleSettings {
00382   uint8  max_train_length;                 
00383   uint8  smoke_amount;                     
00384   uint8  train_acceleration_model;         
00385   uint8  roadveh_acceleration_model;       
00386   uint8  train_slope_steepness;            
00387   uint8  roadveh_slope_steepness;          
00388   bool   wagon_speed_limits;               
00389   bool   disable_elrails;                  
00390   UnitID max_trains;                       
00391   UnitID max_roadveh;                      
00392   UnitID max_aircraft;                     
00393   UnitID max_ships;                        
00394   uint8  plane_speed;                      
00395   uint8  freight_trains;                   
00396   bool   dynamic_engines;                  
00397   bool   never_expire_vehicles;            
00398   byte   extend_vehicle_life;              
00399   byte   road_side;                        
00400   uint8  plane_crashes;                    
00401 };
00402 
00404 struct EconomySettings {
00405   bool   inflation;                        
00406   bool   bribe;                            
00407   bool   smooth_economy;                   
00408   bool   allow_shares;                     
00409   uint8  feeder_payment_share;             
00410   byte   dist_local_authority;             
00411   bool   exclusive_rights;                 
00412   bool   fund_buildings;                   
00413   bool   fund_roads;                       
00414   bool   give_money;                       
00415   bool   mod_road_rebuild;                 
00416   bool   multiple_industry_per_town;       
00417   uint8  town_growth_rate;                 
00418   uint8  larger_towns;                     
00419   uint8  initial_city_size;                
00420   TownLayoutByte town_layout;              
00421   bool   allow_town_roads;                 
00422   TownFoundingByte found_town;             
00423   bool   station_noise_level;              
00424   uint16 town_noise_population[3];         
00425   bool   allow_town_level_crossings;       
00426   bool   infrastructure_maintenance;       
00427 };
00428 
00429 struct LinkGraphSettings {
00430   uint16 recalc_interval;                     
00431   DistributionTypeByte distribution_pax;      
00432   DistributionTypeByte distribution_mail;     
00433   DistributionTypeByte distribution_armoured; 
00434   DistributionTypeByte distribution_default;  
00435   uint8 accuracy;                             
00436   uint8 demand_size;                          
00437   uint8 demand_distance;                      
00438   uint8 short_path_saturation;                
00439 
00440   inline DistributionType GetDistributionType(CargoID cargo) const {
00441     if (IsCargoInClass(cargo, CC_PASSENGERS)) {
00442       return this->distribution_pax;
00443     } else if (IsCargoInClass(cargo, CC_MAIL)) {
00444       return this->distribution_mail;
00445     } else if (IsCargoInClass(cargo, CC_ARMOURED)) {
00446       return this->distribution_armoured;
00447     } else {
00448       return this->distribution_default;
00449     }
00450   }
00451 };
00452 
00454 struct StationSettings {
00455   bool   modified_catchment;               
00456   bool   adjacent_stations;                
00457   bool   distant_join_stations;            
00458   bool   never_expire_airports;            
00459   byte   station_spread;                   
00460 };
00461 
00463 struct VehicleDefaultSettings {
00464   bool   servint_ispercent;                
00465   uint16 servint_trains;                   
00466   uint16 servint_roadveh;                  
00467   uint16 servint_aircraft;                 
00468   uint16 servint_ships;                    
00469 };
00470 
00472 struct CompanySettings {
00473   bool engine_renew;                       
00474   int16 engine_renew_months;               
00475   uint32 engine_renew_money;               
00476   bool renew_keep_length;                  
00477   VehicleDefaultSettings vehicle;          
00478 };
00479 
00481 struct GameSettings {
00482   DifficultySettings   difficulty;         
00483   GameCreationSettings game_creation;      
00484   ConstructionSettings construction;       
00485   AISettings           ai;                 
00486   ScriptSettings       script;             
00487   class AIConfig      *ai_config[MAX_COMPANIES]; 
00488   class GameConfig    *game_config;        
00489   PathfinderSettings   pf;                 
00490   OrderSettings        order;              
00491   VehicleSettings      vehicle;            
00492   EconomySettings      economy;            
00493   LinkGraphSettings    linkgraph;          
00494   StationSettings      station;            
00495   LocaleSettings       locale;             
00496 };
00497 
00499 struct ClientSettings {
00500   GUISettings          gui;                
00501   NetworkSettings      network;            
00502   CompanySettings      company;            
00503   MusicSettings        music;              
00504 };
00505 
00507 extern ClientSettings _settings_client;
00508 
00510 extern GameSettings _settings_game;
00511 
00513 extern GameSettings _settings_newgame;
00514 
00516 extern VehicleDefaultSettings _old_vds;
00517 
00522 static inline GameSettings &GetGameSettings()
00523 {
00524   return (_game_mode == GM_MENU) ? _settings_newgame : _settings_game;
00525 }
00526 
00527 #endif /* SETTINGS_TYPE_H */