settings_type.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef SETTINGS_TYPE_H
#define SETTINGS_TYPE_H
 
#include "timer/timer_game_calendar.h"
#include "economy_type.h"
#include "town_type.h"
#include "transport_type.h"
#include "network/network_type.h"
#include "company_type.h"
#include "cargotype.h"
#include "linkgraph/linkgraph_type.h"
#include "zoom_type.h"
#include "openttd.h"
#include "rail_gui.h"
#include "signal_type.h"
#include "timetable.h"
 
/* Used to validate sizes of "max" value in settings. */
const size_t MAX_SLE_UINT8 = UINT8_MAX;
const size_t MAX_SLE_UINT16 = UINT16_MAX;
const size_t MAX_SLE_UINT32 = UINT32_MAX;
const size_t MAX_SLE_UINT = UINT_MAX;
const size_t MAX_SLE_INT8 = INT8_MAX;
const size_t MAX_SLE_INT16 = INT16_MAX;
const size_t MAX_SLE_INT32 = INT32_MAX;
const size_t MAX_SLE_INT = INT_MAX;
 
enum SettingsProfile {
  SP_BEGIN = 0,
  SP_EASY = SP_BEGIN,                       
  SP_MEDIUM,                                
  SP_HARD,                                  
 
  SP_END,                                   
 
  SP_CUSTOM = SP_END,                       
  SP_SAVED_HIGHSCORE_END,                   
 
  SP_MULTIPLAYER = SP_SAVED_HIGHSCORE_END,  
  SP_HIGHSCORE_END,                         
};
 
enum IndustryDensity {
  ID_FUND_ONLY, 
  ID_MINIMAL,   
  ID_VERY_LOW,  
  ID_LOW,       
  ID_NORMAL,    
  ID_HIGH,      
 
  ID_CUSTOM,    
 
  ID_END,       
};
 
enum TimekeepingUnits : uint8_t {
  TKU_CALENDAR = 0,
  TKU_WALLCLOCK,
};
 
enum UseRelayService : uint8_t {
  URS_NEVER = 0,
  URS_ASK,
  URS_ALLOW,
};
 
enum ParticipateSurvey : uint8_t {
  PS_ASK = 0,
  PS_NO,
  PS_YES,
};
 
enum RightClickClose : uint8_t {
  RCC_NO = 0,
  RCC_YES,
  RCC_YES_EXCEPT_STICKY,
};
 
struct DifficultySettings {
  uint8_t competitor_start_time;            
  uint8_t competitor_intelligence;          
 
  uint8_t max_no_competitors;               
  uint16_t competitors_interval;             
  uint8_t number_towns;                     
  uint8_t industry_density;                 
  uint32_t max_loan;                         
  uint8_t initial_interest;                 
  uint8_t vehicle_costs;                    
  uint8_t competitor_speed;                 
  uint8_t vehicle_breakdowns;               
  uint8_t subsidy_multiplier;               
  uint16_t subsidy_duration;                 
  uint8_t construction_cost;                
  uint8_t terrain_type;                     
  uint8_t quantity_sea_lakes;               
  bool   economy;                          
  bool   line_reverse_mode;                
  bool   disasters;                        
  uint8_t town_council_tolerance;           
  bool   infinite_money;                   
};
 
enum ViewportScrollMode {
  VSM_VIEWPORT_RMB_FIXED, 
  VSM_MAP_RMB_FIXED,      
  VSM_MAP_RMB,            
  VSM_MAP_LMB,            
  VSM_END,                
};
 
enum ScrollWheelScrollingSetting {
  SWS_ZOOM_MAP = 0,       
  SWS_SCROLL_MAP = 1,     
  SWS_OFF = 2             
};
 
struct GUISettings {
  bool   sg_full_load_any;                 
  bool   lost_vehicle_warn;                
  uint8_t  order_review_system;              
  bool   vehicle_income_warn;              
  bool   old_vehicle_warn;                 
  bool   show_finances;                    
  bool   sg_new_nonstop;                   
  bool   new_nonstop;                      
  uint8_t  stop_location;                    
  uint8_t  auto_scrolling;                   
  uint8_t errmsg_duration;                  
  uint16_t hover_delay_ms;                   
  bool   link_terraform_toolbar;           
  uint8_t  smallmap_land_colour;             
  uint8_t  linkgraph_colours;                
  uint8_t  scroll_mode;                      
  bool   smooth_scroll;                    
  bool   measure_tooltip;                  
  uint8_t liveries;                         
  bool   prefer_teamchat;                  
  uint8_t  advanced_vehicle_list;            
  uint8_t  loading_indicators;               
  uint8_t  default_rail_type;                
  uint8_t  toolbar_pos;                      
  uint8_t  statusbar_pos;                    
  uint8_t  window_snap_radius;               
  uint8_t  window_soft_limit;                
  ZoomLevel zoom_min;                      
  ZoomLevel zoom_max;                      
  ZoomLevel sprite_zoom_min;               
  uint32_t autosave_interval;              
  bool   threaded_saves;                   
  bool   keep_all_autosave;                
  bool   autosave_on_exit;                 
  bool   autosave_on_network_disconnect;   
  uint8_t  date_format_in_default_names;     
  uint8_t max_num_autosaves;                
  bool   population_in_label;              
  uint8_t  right_mouse_btn_emulation;        
  uint8_t  scrollwheel_scrolling;            
  uint8_t  scrollwheel_multiplier;           
  bool   timetable_arrival_departure;      
  RightClickClose  right_click_wnd_close;  
  bool   pause_on_newgame;                 
  SignalGUISettings signal_gui_mode;       
  SignalCycleSettings cycle_signal_types;  
  SignalType default_signal_type;          
  TimerGameCalendar::Year coloured_news_year; 
  TimetableMode timetable_mode;            
  bool   quick_goto;                       
  bool   auto_euro;                        
  uint8_t drag_signals_density;             
  bool   drag_signals_fixed_distance;      
  TimerGameCalendar::Year semaphore_build_before; 
  uint8_t news_message_timeout;             
  bool   show_track_reservation;           
  uint8_t station_numtracks;                
  uint8_t station_platlength;               
  bool   station_dragdrop;                 
  bool   station_show_coverage;            
  bool   persistent_buildingtools;         
  bool   expenses_layout;                  
  uint32_t last_newgrf_count;                
  uint8_t missing_strings_threshold;        
  uint8_t  graph_line_thickness;             
  uint8_t  osk_activation;                   
  Colours starting_colour;                 
  Colours starting_colour_secondary;       
  bool   show_newgrf_name;                 
  bool   show_cargo_in_vehicle_lists;      
  bool   auto_remove_signals;              
  uint16_t refresh_rate;                     
  uint16_t fast_forward_speed_limit;         
 
  uint16_t console_backlog_timeout;          
  uint16_t console_backlog_length;           
 
  uint8_t  station_gui_group_order;          
  uint8_t  station_gui_sort_by;              
  uint8_t  station_gui_sort_order;           
  uint16_t network_chat_box_width_pct;       
  uint8_t  network_chat_box_height;          
  uint16_t network_chat_timeout;             
 
  uint8_t  developer;                        
  bool   show_date_in_logs;                
  bool   newgrf_developer_tools;           
  bool   ai_developer_tools;               
  bool   scenario_developer;               
  uint8_t  settings_restriction_mode;        
  bool   newgrf_show_old_versions;         
  uint8_t  newgrf_default_palette;           
 
  bool   scale_bevels;                     
 
  bool UserIsAllowedToChangeNewGRFs() const
  {
    return this->scenario_developer || this->newgrf_developer_tools;
  }
};
 
struct SoundSettings {
  bool   news_ticker;                      
  bool   news_full;                        
  bool   new_year;                         
  bool   confirm;                          
  bool   click_beep;                       
  bool   disaster;                         
  bool   vehicle;                          
  bool   ambient;                          
};
 
struct MusicSettings {
  uint8_t playlist;     
  uint8_t music_vol;    
  uint8_t effect_vol;   
  uint8_t custom_1[33]; 
  uint8_t custom_2[33]; 
  bool playing;      
  bool shuffle;      
};
 
struct LocaleSettings {
  uint8_t      currency;                        
  uint8_t      units_velocity;                  
  uint8_t      units_velocity_nautical;         
  uint8_t      units_power;                     
  uint8_t      units_weight;                    
  uint8_t      units_volume;                    
  uint8_t      units_force;                     
  uint8_t      units_height;                    
  std::string digit_group_separator;            
  std::string digit_group_separator_currency;   
  std::string digit_decimal_separator;          
};
 
struct NewsSettings {
  uint8_t arrival_player;                                 
  uint8_t arrival_other;                                  
  uint8_t accident;                                       
  uint8_t accident_other;                                 
  uint8_t company_info;                                   
  uint8_t open;                                           
  uint8_t close;                                          
  uint8_t economy;                                        
  uint8_t production_player;                              
  uint8_t production_other;                               
  uint8_t production_nobody;                              
  uint8_t advice;                                         
  uint8_t new_vehicles;                                   
  uint8_t acceptance;                                     
  uint8_t subsidies;                                      
  uint8_t general;                                        
};
 
struct NetworkSettings {
  uint16_t      sync_freq;                                
  uint8_t       frame_freq;                               
  uint16_t      commands_per_frame;                       
  uint16_t      commands_per_frame_server;                
  uint16_t      max_commands_in_queue;                    
  uint16_t      bytes_per_frame;                          
  uint16_t      bytes_per_frame_burst;                    
  uint16_t      max_init_time;                            
  uint16_t      max_join_time;                            
  uint16_t      max_download_time;                        
  uint16_t      max_password_time;                        
  uint16_t      max_lag_time;                             
  bool        pause_on_join;                            
  uint16_t      server_port;                              
  uint16_t      server_admin_port;                        
  bool        server_admin_chat;                        
  ServerGameType server_game_type;                      
  std::string server_invite_code;                       
  std::string server_invite_code_secret;                
  std::string server_name;                              
  std::string server_password;                          
  NetworkAuthorizedKeys server_authorized_keys; 
  std::string rcon_password;                            
  NetworkAuthorizedKeys rcon_authorized_keys; 
  bool allow_insecure_admin_login; 
  std::string admin_password;                           
  NetworkAuthorizedKeys admin_authorized_keys; 
  std::string client_name;                              
  std::string client_secret_key; 
  std::string client_public_key; 
  std::string connect_to_ip;                            
  bool        autoclean_companies;                      
  uint8_t       autoclean_protected; 
  uint8_t       autoclean_novehicles;                     
  uint8_t       max_companies;                            
  uint8_t       max_clients;                              
  TimerGameCalendar::Year restart_game_year;            
  uint16_t      restart_hours;                          
  uint8_t       min_active_clients;                       
  bool        reload_cfg;                               
  std::string last_joined;                              
  UseRelayService use_relay_service;                    
  ParticipateSurvey participate_survey;                 
 
  bool AdminAuthenticationConfigured() const { return !this->admin_password.empty() || !this->admin_authorized_keys.empty(); }
};
 
struct GameCreationSettings {
  uint32_t generation_seed;                  
  TimerGameCalendar::Year starting_year;   
  TimerGameCalendar::Year ending_year;     
  uint8_t  map_x;                            
  uint8_t  map_y;                            
  uint8_t land_generator;                   
  uint8_t oil_refinery_limit;               
  uint8_t snow_line_height;                 
  uint8_t snow_coverage;                    
  uint8_t desert_coverage;                  
  uint8_t heightmap_height;                 
  uint8_t tgen_smoothness;                  
  uint8_t tree_placer;                      
  uint8_t heightmap_rotation;               
  uint8_t se_flat_world_height;             
  uint8_t town_name;                        
  uint8_t landscape;                        
  uint8_t water_borders;                    
  uint16_t custom_town_number;               
  uint16_t custom_industry_number;           
  uint8_t variety;                          
  uint8_t custom_terrain_type;              
  uint8_t custom_sea_level;                 
  uint8_t min_river_length;                 
  uint8_t river_route_random;               
  uint8_t amount_of_rivers;                 
};
 
struct ConstructionSettings {
  uint8_t  map_height_limit;                 
  bool   build_on_slopes;                  
  bool   autoslope;                        
  uint16_t max_bridge_length;                
  uint8_t max_bridge_height;                
  uint16_t max_tunnel_length;                
  uint8_t train_signal_side;                
  bool   extra_dynamite;                   
  bool   road_stop_on_town_road;           
  bool   road_stop_on_competitor_road;     
  bool   crossing_with_competitor;         
  uint8_t  raw_industry_construction;        
  uint8_t  industry_platform;                
  bool   freeform_edges;                   
  uint8_t  extra_tree_placement;             
  uint8_t  command_pause_level;              
 
  uint32_t terraform_per_64k_frames;         
  uint16_t terraform_frame_burst;            
  uint32_t clear_per_64k_frames;             
  uint16_t clear_frame_burst;                
  uint32_t tree_per_64k_frames;              
  uint16_t tree_frame_burst;                 
  uint32_t build_object_per_64k_frames;      
  uint16_t build_object_frame_burst;         
};
 
struct AISettings {
  bool   ai_in_multiplayer;                
  bool   ai_disable_veh_train;             
  bool   ai_disable_veh_roadveh;           
  bool   ai_disable_veh_aircraft;          
  bool   ai_disable_veh_ship;              
};
 
struct ScriptSettings {
  uint32_t script_max_opcode_till_suspend;   
  uint32_t script_max_memory_megabytes;      
};
 
struct YAPFSettings {
  bool   disable_node_optimization;        
  uint32_t max_search_nodes;                 
  uint32_t maximum_go_to_depot_penalty;      
  uint32_t road_slope_penalty;               
  uint32_t road_curve_penalty;               
  uint32_t road_crossing_penalty;            
  uint32_t road_stop_penalty;                
  uint32_t road_stop_occupied_penalty;       
  uint32_t road_stop_bay_occupied_penalty;   
  bool   rail_firstred_twoway_eol;         
  uint32_t rail_firstred_penalty;            
  uint32_t rail_firstred_exit_penalty;       
  uint32_t rail_lastred_penalty;             
  uint32_t rail_lastred_exit_penalty;        
  uint32_t rail_station_penalty;             
  uint32_t rail_slope_penalty;               
  uint32_t rail_curve45_penalty;             
  uint32_t rail_curve90_penalty;             
  uint32_t rail_depot_reverse_penalty;       
  uint32_t rail_crossing_penalty;            
  uint32_t rail_look_ahead_max_signals;      
  int32_t  rail_look_ahead_signal_p0;        
  int32_t  rail_look_ahead_signal_p1;        
  int32_t  rail_look_ahead_signal_p2;        
  uint32_t rail_pbs_cross_penalty;           
  uint32_t rail_pbs_station_penalty;         
  uint32_t rail_pbs_signal_back_penalty;     
  uint32_t rail_doubleslip_penalty;          
 
  uint32_t rail_longer_platform_penalty;           
  uint32_t rail_longer_platform_per_tile_penalty;  
  uint32_t rail_shorter_platform_penalty;          
  uint32_t rail_shorter_platform_per_tile_penalty; 
  uint32_t ship_curve45_penalty;                   
  uint32_t ship_curve90_penalty;                   
};
 
struct PathfinderSettings {
  bool   roadveh_queue;                    
  bool   forbid_90_deg;                    
 
  bool   reverse_at_signals;               
  uint8_t wait_oneway_signal;               
  uint8_t wait_twoway_signal;               
 
  bool   reserve_paths;                    
  uint8_t wait_for_pbs_path;                
  uint8_t path_backoff_interval;            
 
  YAPFSettings yapf;                       
};
 
struct OrderSettings {
  bool   improved_load;                    
  bool   gradual_loading;                  
  bool   selectgoods;                      
  bool   no_servicing_if_no_breakdowns;    
  bool   serviceathelipad;                 
  bool   station_length_loading_penalty;   
};
 
struct VehicleSettings {
  uint8_t  max_train_length;                 
  uint8_t  smoke_amount;                     
  uint8_t  train_acceleration_model;         
  uint8_t  roadveh_acceleration_model;       
  uint8_t  train_slope_steepness;            
  uint8_t  roadveh_slope_steepness;          
  bool   wagon_speed_limits;               
  bool   disable_elrails;                  
  UnitID max_trains;                       
  UnitID max_roadveh;                      
  UnitID max_aircraft;                     
  UnitID max_ships;                        
  uint8_t  plane_speed;                      
  uint8_t  freight_trains;                   
  bool   dynamic_engines;                  
  bool   never_expire_vehicles;            
  uint8_t extend_vehicle_life;              
  uint8_t road_side;                        
  uint8_t  plane_crashes;                    
};
 
struct EconomySettings {
  bool   inflation;                        
  bool   bribe;                            
  EconomyType type;                        
  uint8_t  feeder_payment_share;             
  uint8_t dist_local_authority;             
  bool   exclusive_rights;                 
  bool   fund_buildings;                   
  bool   fund_roads;                       
  bool   give_money;                       
  bool   mod_road_rebuild;                 
  bool   multiple_industry_per_town;       
  uint8_t  town_growth_rate;                 
  uint8_t  larger_towns;                     
  uint8_t  initial_city_size;                
  TownLayout town_layout;                  
  TownCargoGenMode town_cargogen_mode;     
  bool   allow_town_roads;                 
  TownFounding found_town;                 
  bool   station_noise_level;              
  uint16_t town_noise_population[4];         
  bool   allow_town_level_crossings;       
  bool   infrastructure_maintenance;       
  TimekeepingUnits timekeeping_units;      
  uint16_t minutes_per_calendar_year;      
  uint16_t town_cargo_scale;               
  uint16_t industry_cargo_scale;           
};
 
struct LinkGraphSettings {
  uint16_t recalc_time;                     
  uint16_t recalc_interval;                 
  DistributionType distribution_pax;      
  DistributionType distribution_mail;     
  DistributionType distribution_armoured; 
  DistributionType distribution_default;  
  uint8_t accuracy;                         
  uint8_t demand_size;                      
  uint8_t demand_distance;                  
  uint8_t short_path_saturation;            
 
  inline DistributionType GetDistributionType(CargoID cargo) const
  {
    if (IsCargoInClass(cargo, CC_PASSENGERS)) return this->distribution_pax;
    if (IsCargoInClass(cargo, CC_MAIL)) return this->distribution_mail;
    if (IsCargoInClass(cargo, CC_ARMOURED)) return this->distribution_armoured;
    return this->distribution_default;
  }
};
 
struct StationSettings {
  bool   modified_catchment;               
  bool   serve_neutral_industries;         
  bool   distant_join_stations;            
  bool   never_expire_airports;            
  uint8_t station_spread;                  
};
 
struct VehicleDefaultSettings {
  bool   servint_ispercent;                
  uint16_t servint_trains;                   
  uint16_t servint_roadveh;                  
  uint16_t servint_aircraft;                 
  uint16_t servint_ships;                    
};
 
struct CompanySettings {
  bool engine_renew;                       
  int16_t engine_renew_months;               
  uint32_t engine_renew_money;               
  bool renew_keep_length;                  
  VehicleDefaultSettings vehicle;          
};
 
struct GameSettings {
  DifficultySettings   difficulty;         
  GameCreationSettings game_creation;      
  ConstructionSettings construction;       
  AISettings           ai;                 
  ScriptSettings       script;             
  class AIConfig      *ai_config[MAX_COMPANIES]; 
  class GameConfig    *game_config;        
  PathfinderSettings   pf;                 
  OrderSettings        order;              
  VehicleSettings      vehicle;            
  EconomySettings      economy;            
  LinkGraphSettings    linkgraph;          
  StationSettings      station;            
  LocaleSettings       locale;             
};
 
struct ClientSettings {
  GUISettings          gui;                
  NetworkSettings      network;            
  CompanySettings      company;            
  SoundSettings        sound;              
  MusicSettings        music;              
  NewsSettings         news_display;       
};
 
extern ClientSettings _settings_client;
 
extern GameSettings _settings_game;
 
extern GameSettings _settings_newgame;
 
extern VehicleDefaultSettings _old_vds;
 
inline GameSettings &GetGameSettings()
{
  return (_game_mode == GM_MENU) ? _settings_newgame : _settings_game;
}
 
#endif /* SETTINGS_TYPE_H */