d9/dd3/settings__type_8h_source.html

/*

 * 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 "date_type.h"

#include "economy_type.h"

#include "town_type.h"

#include "transport_type.h"

#include "network/core/config.h"

#include "company_type.h"

#include "cargotype.h"

#include "linkgraph/linkgraph_type.h"

#include "zoom_type.h"

#include "openttd.h"


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_END,

};


struct DifficultySettings {

  byte   max_no_competitors;

  byte   number_towns;

  byte   industry_density;

  uint32 max_loan;

  byte   initial_interest;

  byte   vehicle_costs;

  byte   competitor_speed;

  byte   vehicle_breakdowns;

  byte   subsidy_multiplier;

  byte   construction_cost;

  byte   terrain_type;

  byte   quantity_sea_lakes;

  bool   economy;

  bool   line_reverse_mode;

  bool   disasters;

  byte   town_council_tolerance;

};


enum ViewportScrollMode {

  VSM_VIEWPORT_RMB_FIXED,

  VSM_MAP_RMB_FIXED,

  VSM_MAP_RMB,

  VSM_MAP_LMB,

  VSM_END,

};


struct GUISettings {

  bool   sg_full_load_any;

  bool   lost_vehicle_warn;

  uint8  order_review_system;

  bool   vehicle_income_warn;

  bool   show_finances;

  bool   sg_new_nonstop;

  bool   new_nonstop;

  uint8  stop_location;

  uint8  auto_scrolling;

  byte   errmsg_duration;

  uint16 hover_delay_ms;

  bool   link_terraform_toolbar;

  uint8  smallmap_land_colour;

  uint8  scroll_mode;

  bool   smooth_scroll;

  bool   measure_tooltip;

  byte   liveries;

  bool   prefer_teamchat;

  uint8  advanced_vehicle_list;

  uint8  loading_indicators;

  uint8  default_rail_type;

  uint8  toolbar_pos;

  uint8  statusbar_pos;

  uint8  window_snap_radius;

  uint8  window_soft_limit;

  ZoomLevel zoom_min;

  ZoomLevel zoom_max;

  byte   autosave;

  bool   threaded_saves;

  bool   keep_all_autosave;

  bool   autosave_on_exit;

  bool   autosave_on_network_disconnect;

  uint8  date_format_in_default_names;

  byte   max_num_autosaves;

  bool   population_in_label;

  uint8  right_mouse_btn_emulation;

  uint8  scrollwheel_scrolling;

  uint8  scrollwheel_multiplier;

  bool   timetable_arrival_departure;

  bool   right_mouse_wnd_close;

  bool   pause_on_newgame;

  bool   enable_signal_gui;

  Year   coloured_news_year;

  bool   timetable_in_ticks;

  bool   quick_goto;

  bool   auto_euro;

  byte   drag_signals_density;

  bool   drag_signals_fixed_distance;

  Year   semaphore_build_before;

  byte   news_message_timeout;

  bool   show_track_reservation;

  uint8  default_signal_type;

  uint8  cycle_signal_types;

  byte   station_numtracks;

  byte   station_platlength;

  bool   station_dragdrop;

  bool   station_show_coverage;

  bool   persistent_buildingtools;

  bool   expenses_layout;

  uint32 last_newgrf_count;

  byte   missing_strings_threshold;

  uint8  graph_line_thickness;

  uint8  osk_activation;

  byte   starting_colour;

  bool   show_newgrf_name;

  bool   auto_remove_signals;


  uint16 console_backlog_timeout;

  uint16 console_backlog_length;


  uint8  station_gui_group_order;

  uint8  station_gui_sort_by;

  uint8  station_gui_sort_order;

  uint16 network_chat_box_width_pct;

  uint8  network_chat_box_height;

  uint16 network_chat_timeout;


  uint8  developer;

  bool   show_date_in_logs;

  bool   newgrf_developer_tools;

  bool   ai_developer_tools;

  bool   scenario_developer;

  uint8  settings_restriction_mode;

  bool   newgrf_show_old_versions;

  uint8  newgrf_default_palette;


  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 {

  byte playlist;

  byte music_vol;

  byte effect_vol;

  byte custom_1[33];

  byte custom_2[33];

  bool playing;

  bool shuffle;

};


struct LocaleSettings {

  byte   currency;

  byte   units_velocity;

  byte   units_power;

  byte   units_weight;

  byte   units_volume;

  byte   units_force;

  byte   units_height;

  char  *digit_group_separator;

  char  *digit_group_separator_currency;

  char  *digit_decimal_separator;

};


struct NewsSettings {

  uint8 arrival_player;

  uint8 arrival_other;

  uint8 accident;

  uint8 company_info;

  uint8 open;

  uint8 close;

  uint8 economy;

  uint8 production_player;

  uint8 production_other;

  uint8 production_nobody;

  uint8 advice;

  uint8 new_vehicles;

  uint8 acceptance;

  uint8 subsidies;

  uint8 general;

};


struct NetworkSettings {

  uint16 sync_freq;

  uint8  frame_freq;

  uint16 commands_per_frame;

  uint16 max_commands_in_queue;

  uint16 bytes_per_frame;

  uint16 bytes_per_frame_burst;

  uint16 max_init_time;

  uint16 max_join_time;

  uint16 max_download_time;

  uint16 max_password_time;

  uint16 max_lag_time;

  bool   pause_on_join;

  uint16 server_port;

  uint16 server_admin_port;

  bool   server_admin_chat;

  char   server_name[NETWORK_NAME_LENGTH];

  char   server_password[NETWORK_PASSWORD_LENGTH];

  char   rcon_password[NETWORK_PASSWORD_LENGTH];

  char   admin_password[NETWORK_PASSWORD_LENGTH];

  bool   server_advertise;

  char   client_name[NETWORK_CLIENT_NAME_LENGTH];

  char   default_company_pass[NETWORK_PASSWORD_LENGTH];

  char   connect_to_ip[NETWORK_HOSTNAME_LENGTH];

  char   network_id[NETWORK_SERVER_ID_LENGTH];

  bool   autoclean_companies;

  uint8  autoclean_unprotected;

  uint8  autoclean_protected;

  uint8  autoclean_novehicles;

  uint8  max_companies;

  uint8  max_clients;

  uint8  max_spectators;

  Year   restart_game_year;

  uint8  min_active_clients;

  uint8  server_lang;

  bool   reload_cfg;

  char   last_host[NETWORK_HOSTNAME_LENGTH];

  uint16 last_port;

  bool   no_http_content_downloads;

};


struct GameCreationSettings {

  uint32 generation_seed;

  Year   starting_year;

  Year   ending_year;

  uint8  map_x;

  uint8  map_y;

  byte   land_generator;

  byte   oil_refinery_limit;

  byte   snow_line_height;

  byte   tgen_smoothness;

  byte   tree_placer;

  byte   heightmap_rotation;

  byte   se_flat_world_height;

  byte   town_name;

  byte   landscape;

  byte   water_borders;

  uint16 custom_town_number;

  byte   variety;

  byte   custom_sea_level;

  byte   min_river_length;

  byte   river_route_random;

  byte   amount_of_rivers;

};


struct ConstructionSettings {

  uint8  max_heightlevel;

  bool   build_on_slopes;

  bool   autoslope;

  uint16 max_bridge_length;

  byte   max_bridge_height;

  uint16 max_tunnel_length;

  byte   train_signal_side;

  bool   extra_dynamite;

  bool   road_stop_on_town_road;

  bool   road_stop_on_competitor_road;

  uint8  raw_industry_construction;

  uint8  industry_platform;

  bool   freeform_edges;

  uint8  extra_tree_placement;

  uint8  command_pause_level;


  uint32 terraform_per_64k_frames;

  uint16 terraform_frame_burst;

  uint32 clear_per_64k_frames;

  uint16 clear_frame_burst;

  uint32 tree_per_64k_frames;

  uint16 tree_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 {

  uint8  settings_profile;

  uint32 script_max_opcode_till_suspend;

  uint32 script_max_memory_megabytes;

};


struct NPFSettings {

  uint32 npf_max_search_nodes;

  uint32 maximum_go_to_depot_penalty;


  uint32 npf_rail_firstred_penalty;

  uint32 npf_rail_firstred_exit_penalty;

  uint32 npf_rail_lastred_penalty;

  uint32 npf_rail_station_penalty;

  uint32 npf_rail_slope_penalty;

  uint32 npf_rail_curve_penalty;

  uint32 npf_rail_depot_reverse_penalty;

  uint32 npf_rail_pbs_cross_penalty;

  uint32 npf_rail_pbs_signal_back_penalty;

  uint32 npf_buoy_penalty;

  uint32 npf_water_curve_penalty;

  uint32 npf_road_curve_penalty;

  uint32 npf_crossing_penalty;

  uint32 npf_road_drive_through_penalty;

  uint32 npf_road_dt_occupied_penalty;

  uint32 npf_road_bay_occupied_penalty;

};


struct YAPFSettings {

  bool   disable_node_optimization;

  uint32 max_search_nodes;

  uint32 maximum_go_to_depot_penalty;

  bool   ship_use_yapf;

  bool   road_use_yapf;

  bool   rail_use_yapf;

  uint32 road_slope_penalty;

  uint32 road_curve_penalty;

  uint32 road_crossing_penalty;

  uint32 road_stop_penalty;

  uint32 road_stop_occupied_penalty;

  uint32 road_stop_bay_occupied_penalty;

  bool   rail_firstred_twoway_eol;

  uint32 rail_firstred_penalty;

  uint32 rail_firstred_exit_penalty;

  uint32 rail_lastred_penalty;

  uint32 rail_lastred_exit_penalty;

  uint32 rail_station_penalty;

  uint32 rail_slope_penalty;

  uint32 rail_curve45_penalty;

  uint32 rail_curve90_penalty;

  uint32 rail_depot_reverse_penalty;

  uint32 rail_crossing_penalty;

  uint32 rail_look_ahead_max_signals;

  int32  rail_look_ahead_signal_p0;

  int32  rail_look_ahead_signal_p1;

  int32  rail_look_ahead_signal_p2;

  uint32 rail_pbs_cross_penalty;

  uint32 rail_pbs_station_penalty;

  uint32 rail_pbs_signal_back_penalty;

  uint32 rail_doubleslip_penalty;


  uint32 rail_longer_platform_penalty;

  uint32 rail_longer_platform_per_tile_penalty;

  uint32 rail_shorter_platform_penalty;

  uint32 rail_shorter_platform_per_tile_penalty;

  uint32 ship_curve45_penalty;

  uint32 ship_curve90_penalty;

};


struct PathfinderSettings {

  uint8  pathfinder_for_trains;

  uint8  pathfinder_for_roadvehs;

  uint8  pathfinder_for_ships;

  bool   new_pathfinding_all;


  bool   roadveh_queue;

  bool   forbid_90_deg;


  bool   reverse_at_signals;

  byte   wait_oneway_signal;

  byte   wait_twoway_signal;


  bool   reserve_paths;

  byte   wait_for_pbs_path;

  byte   path_backoff_interval;


  NPFSettings  npf;

  YAPFSettings yapf;

};


struct OrderSettings {

  bool   improved_load;

  bool   gradual_loading;

  bool   selectgoods;

  bool   no_servicing_if_no_breakdowns;

  bool   serviceathelipad;

};


struct VehicleSettings {

  uint8  max_train_length;

  uint8  smoke_amount;

  uint8  train_acceleration_model;

  uint8  roadveh_acceleration_model;

  uint8  train_slope_steepness;

  uint8  roadveh_slope_steepness;

  bool   wagon_speed_limits;

  bool   disable_elrails;

  UnitID max_trains;

  UnitID max_roadveh;

  UnitID max_aircraft;

  UnitID max_ships;

  uint8  plane_speed;

  uint8  freight_trains;

  bool   dynamic_engines;

  bool   never_expire_vehicles;

  byte   extend_vehicle_life;

  byte   road_side;

  uint8  plane_crashes;

};


struct EconomySettings {

  bool   inflation;

  bool   bribe;

  EconomyType type;

  bool   allow_shares;

  uint8  min_years_for_shares;

  uint8  feeder_payment_share;

  byte   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  town_growth_rate;

  uint8  larger_towns;

  uint8  initial_city_size;

  TownLayout town_layout;

  TownCargoGenMode town_cargogen_mode;

  bool   allow_town_roads;

  TownFounding found_town;

  bool   station_noise_level;

  uint16 town_noise_population[3];

  bool   allow_town_level_crossings;

  bool   infrastructure_maintenance;

};


struct LinkGraphSettings {

  uint16 recalc_time;

  uint16 recalc_interval;

  DistributionType distribution_pax;

  DistributionType distribution_mail;

  DistributionType distribution_armoured;

  DistributionType distribution_default;

  uint8 accuracy;

  uint8 demand_size;

  uint8 demand_distance;

  uint8 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   adjacent_stations;

  bool   distant_join_stations;

  bool   never_expire_airports;

  byte   station_spread;

};


struct VehicleDefaultSettings {

  bool   servint_ispercent;

  uint16 servint_trains;

  uint16 servint_roadveh;

  uint16 servint_aircraft;

  uint16 servint_ships;

};


struct CompanySettings {

  bool engine_renew;

  int16 engine_renew_months;

  uint32 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;


static inline GameSettings &GetGameSettings()

{

  return (_game_mode == GM_MENU) ? _settings_newgame : _settings_game;

}


#endif /* SETTINGS_TYPE_H */