2008-01-07 00:19:09 +00:00
/* $Id$ */
2009-08-21 20:21:05 +00:00
/*
* 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/>.
*/
2008-01-07 00:19:09 +00:00
/** @file settings_type.h Types related to global configuration settings. */
# ifndef SETTINGS_TYPE_H
# define SETTINGS_TYPE_H
# include "date_type.h"
2008-01-07 14:02:26 +00:00
# include "town_type.h"
2008-05-07 09:07:19 +00:00
# include "transport_type.h"
2008-05-29 20:21:28 +00:00
# include "network/core/config.h"
2009-01-12 17:11:45 +00:00
# include "company_type.h"
2008-01-07 00:19:09 +00:00
2008-05-25 22:36:44 +00:00
/** Settings related to the difficulty of the game */
struct DifficultySettings {
2008-05-26 00:31:36 +00:00
byte max_no_competitors ; ///< the number of competitors (AIs)
byte number_towns ; ///< the amount of towns
byte number_industries ; ///< the amount of industries
uint32 max_loan ; ///< the maximum initial loan
byte initial_interest ; ///< amount of interest (to pay over the loan)
byte vehicle_costs ; ///< amount of money spent on vehicle running cost
byte competitor_speed ; ///< the speed at which the AI builds
byte vehicle_breakdowns ; ///< likelihood of vehicles breaking down
byte subsidy_multiplier ; ///< amount of subsidy
byte construction_cost ; ///< how expensive is building
byte terrain_type ; ///< the mountainousness of the landscape
byte quantity_sea_lakes ; ///< the amount of seas/lakes
byte economy ; ///< how volatile is the economy
byte line_reverse_mode ; ///< reversing at stations or not
byte disasters ; ///< are disasters enabled
byte town_council_tolerance ; ///< minimum required town ratings to be allowed to demolish stuff
byte diff_level ; ///< the difficulty level
2008-01-13 13:36:01 +00:00
} ;
2008-05-25 19:17:03 +00:00
/** Settings related to the GUI and other stuff that is not saved in the savegame. */
struct GUISettings {
bool vehicle_speed ; ///< show vehicle speed
bool sg_full_load_any ; ///< new full load calculation, any cargo must be full read from pre v93 savegames
bool lost_train_warn ; ///< if a train can't find its destination, show a warning
uint8 order_review_system ; ///< perform order reviews on vehicles
2009-01-04 18:34:23 +00:00
bool vehicle_income_warn ; ///< if a vehicle isn't generating income, show a warning
2008-05-25 19:17:03 +00:00
bool status_long_date ; ///< always show long date in status bar
bool show_finances ; ///< show finances at end of year
bool sg_new_nonstop ; ///< ttdpatch compatible nonstop handling read from pre v93 savegames
bool new_nonstop ; ///< ttdpatch compatible nonstop handling
2009-04-12 14:11:14 +00:00
uint8 stop_location ; ///< what is the default stop location of trains?
2008-05-25 19:17:03 +00:00
bool autoscroll ; ///< scroll when moving mouse to the edge
byte errmsg_duration ; ///< duration of error message
2010-07-14 15:08:31 +00:00
byte hover_delay ; ///< time required to activate a hover event, in seconds
2008-05-25 19:17:03 +00:00
bool link_terraform_toolbar ; ///< display terraform toolbar when displaying rail, road, water and airport toolbars
2010-02-08 23:46:35 +00:00
uint8 smallmap_land_colour ; ///< colour used for land and heightmap at the smallmap
2008-05-25 19:17:03 +00:00
bool reverse_scroll ; ///< right-Click-Scrolling scrolls in the opposite direction
bool smooth_scroll ; ///< smooth scroll viewports
bool measure_tooltip ; ///< show a permanent tooltip when dragging tools
byte liveries ; ///< options for displaying company liveries, 0=none, 1=self, 2=all
2008-09-30 20:39:50 +00:00
bool prefer_teamchat ; ///< choose the chat message target with <ENTER>, true=all clients, false=your team
2008-05-25 19:17:03 +00:00
uint8 advanced_vehicle_list ; ///< use the "advanced" vehicle list
uint8 loading_indicators ; ///< show loading indicators
uint8 default_rail_type ; ///< the default rail type for the rail GUI
uint8 toolbar_pos ; ///< position of toolbars, 0=left, 1=center, 2=right
2010-11-13 23:40:36 +00:00
uint8 statusbar_pos ; ///< position of statusbar, 0=left, 1=center, 2=right
2008-05-25 19:17:03 +00:00
uint8 window_snap_radius ; ///< windows snap at each other if closer than this
2009-01-07 16:11:27 +00:00
uint8 window_soft_limit ; ///< soft limit of maximum number of non-stickied non-vital windows (0 = no limit)
2008-05-25 19:17:03 +00:00
bool always_build_infrastructure ; ///< always allow building of infrastructure, even when you do not have the vehicles for it
2008-05-25 22:36:44 +00:00
byte autosave ; ///< how often should we do autosaves?
2009-10-27 20:28:10 +00:00
bool threaded_saves ; ///< should we do threaded saves?
2008-05-25 19:17:03 +00:00
bool keep_all_autosave ; ///< name the autosave in a different way
bool autosave_on_exit ; ///< save an autosave when you quit the game, but do not ask "Do you really want to quit?"
2009-01-03 00:58:59 +00:00
uint8 date_format_in_default_names ; ///< should the default savegame/screenshot name use long dates (31th Dec 2008), short dates (31-12-2008) or ISO dates (2008-12-31)
2008-05-25 19:17:03 +00:00
byte max_num_autosaves ; ///< controls how many autosavegames are made before the game starts to overwrite (names them 0 to max_num_autosaves - 1)
bool population_in_label ; ///< show the population of a town in his label?
uint8 right_mouse_btn_emulation ; ///< should we emulate right mouse clicking?
uint8 scrollwheel_scrolling ; ///< scrolling using the scroll wheel?
uint8 scrollwheel_multiplier ; ///< how much 'wheel' per incoming event from the OS?
2009-11-25 16:17:06 +00:00
bool timetable_arrival_departure ; ///< show arrivals and departures in vehicle timetables
2009-01-02 22:42:05 +00:00
bool left_mouse_btn_scrolling ; ///< left mouse button scroll
2008-05-25 19:17:03 +00:00
bool pause_on_newgame ; ///< whether to start new games paused or not
bool enable_signal_gui ; ///< show the signal GUI when the signal button is pressed
2009-02-09 02:57:15 +00:00
Year coloured_news_year ; ///< when does newspaper become coloured?
2008-05-25 19:17:03 +00:00
bool timetable_in_ticks ; ///< whether to show the timetable in ticks rather than days
2009-01-04 14:51:49 +00:00
bool quick_goto ; ///< Allow quick access to 'goto button' in vehicle orders window
2008-05-25 19:17:03 +00:00
bool bridge_pillars ; ///< show bridge pillars for high bridges
bool auto_euro ; ///< automatically switch to euro in 2002
byte drag_signals_density ; ///< many signals density
Year semaphore_build_before ; ///< build semaphore signals automatically before this year
2008-06-05 11:26:38 +00:00
byte news_message_timeout ; ///< how much longer than the news message "age" should we keep the message in the history
2008-08-02 22:47:34 +00:00
bool show_track_reservation ; ///< highlight reserved tracks.
2008-08-02 22:49:23 +00:00
uint8 default_signal_type ; ///< the signal type to build by default.
uint8 cycle_signal_types ; ///< what signal types to cycle with the build signal tool.
2009-01-04 11:11:11 +00:00
byte station_numtracks ; ///< the number of platforms to default on for rail stations
byte station_platlength ; ///< the platform length, in tiles, for rail stations
bool station_dragdrop ; ///< whether drag and drop is enabled for stations
bool station_show_coverage ; ///< whether to highlight coverage area
2009-02-05 17:59:59 +00:00
bool persistent_buildingtools ; ///< keep the building tools active after usage
uint8 expenses_layout ; ///< layout of expenses window
2008-08-12 20:49:27 +00:00
uint16 console_backlog_timeout ; ///< the minimum amount of time items should be in the console backlog before they will be removed in ~3 seconds granularity.
uint16 console_backlog_length ; ///< the minimum amount of items in the console backlog before items will be removed.
2008-08-12 12:23:05 +00:00
# ifdef ENABLE_NETWORK
uint16 network_chat_box_width ; ///< width of the chat box in pixels
uint8 network_chat_box_height ; ///< height of the chat box in lines
# endif
2009-09-09 15:11:46 +00:00
2010-02-10 17:01:03 +00:00
uint8 developer ; ///< print non-fatal warnings in console (>= 1), copy debug output to console (== 2)
2009-09-09 15:11:46 +00:00
bool show_date_in_logs ; ///< whether to show dates in console logs
2010-11-07 21:46:41 +00:00
bool newgrf_developer_tools ; ///< activate NewGRF developer tools and allow modifying NewGRFs in an existing game
2010-04-03 17:22:24 +00:00
bool ai_developer_tools ; ///< activate AI developer tools
2010-11-07 21:46:41 +00:00
bool scenario_developer ; ///< activate scenario developer: allow modifying NewGRFs in an existing game
2010-07-31 14:40:50 +00:00
bool newgrf_show_old_versions ; ///< whether to show old versions in the NewGRF list
2010-11-07 21:46:41 +00:00
/**
* Returns true when the user has sufficient privileges to edit newgrfs on a running game
* @ return whether the user has sufficient privileges to edit newgrfs in an existing game
*/
bool UserIsAllowedToChangeNewGRFs ( ) const
{
return this - > scenario_developer | | this - > newgrf_developer_tools ;
}
2008-06-05 11:26:38 +00:00
} ;
/** Settings related to currency/unit systems. */
struct LocaleSettings {
2008-05-25 22:36:44 +00:00
byte currency ; ///< currency we currently use
byte units ; ///< unit system we show everything
2009-04-23 21:05:00 +00:00
char * digit_group_separator ; ///< thousand separator for non-currencies
char * digit_group_separator_currency ; ///< thousand separator for currencies
2009-08-12 01:28:11 +00:00
char * digit_decimal_separator ; ///< decimal separator
2008-05-25 19:17:03 +00:00
} ;
2008-01-07 00:19:09 +00:00
2008-05-29 20:21:28 +00:00
/** All settings related to the network. */
struct NetworkSettings {
# ifdef ENABLE_NETWORK
2008-05-29 21:36:29 +00:00
uint16 sync_freq ; ///< how often do we check whether we are still in-sync
uint8 frame_freq ; ///< how often do we send commands to the clients
2010-08-19 08:59:36 +00:00
uint16 commands_per_frame ; ///< how many commands may be sent each frame_freq frames?
uint16 max_commands_in_queue ; ///< how many commands may there be in the incoming queue before dropping the connection?
2010-11-30 20:01:26 +00:00
uint16 bytes_per_frame ; ///< how many bytes may, over a long period, be received per frame?
uint16 bytes_per_frame_burst ; ///< how many bytes may, over a short period, be received?
2008-05-29 21:36:29 +00:00
uint16 max_join_time ; ///< maximum amount of time, in game ticks, a client may take to join
bool pause_on_join ; ///< pause the game when people join
uint16 server_port ; ///< port the server listens on
2010-10-17 17:35:42 +00:00
uint16 server_admin_port ; ///< port the server listens on for the admin network
2010-10-17 17:40:18 +00:00
bool server_admin_chat ; ///< allow private chat for the server to be distributed to the admin network
2008-05-29 21:36:29 +00:00
char server_name [ NETWORK_NAME_LENGTH ] ; ///< name of the server
2010-10-17 17:34:48 +00:00
char server_password [ NETWORK_PASSWORD_LENGTH ] ; ///< password for joining this server
char rcon_password [ NETWORK_PASSWORD_LENGTH ] ; ///< password for rconsole (server side)
2010-10-17 17:31:03 +00:00
char admin_password [ NETWORK_PASSWORD_LENGTH ] ; ///< password for the admin network
2008-05-29 21:36:29 +00:00
bool server_advertise ; ///< advertise the server to the masterserver
uint8 lan_internet ; ///< search on the LAN or internet for servers
2009-04-08 19:39:03 +00:00
char client_name [ NETWORK_CLIENT_NAME_LENGTH ] ; ///< name of the player (as client)
2008-05-29 21:36:29 +00:00
char default_company_pass [ NETWORK_PASSWORD_LENGTH ] ; ///< default password for new companies in encrypted form
char connect_to_ip [ NETWORK_HOSTNAME_LENGTH ] ; ///< default for the "Add server" query
2010-01-21 11:17:40 +00:00
char network_id [ NETWORK_SERVER_ID_LENGTH ] ; ///< network ID for servers
2008-05-29 21:36:29 +00:00
bool autoclean_companies ; ///< automatically remove companies that are not in use
uint8 autoclean_unprotected ; ///< remove passwordless companies after this many months
uint8 autoclean_protected ; ///< remove the password from passworded companies after this many months
2009-03-25 16:30:33 +00:00
uint8 autoclean_novehicles ; ///< remove companies with no vehicles after this many months
2008-05-29 21:36:29 +00:00
uint8 max_companies ; ///< maximum amount of companies
uint8 max_clients ; ///< maximum amount of clients
uint8 max_spectators ; ///< maximum amount of spectators
Year restart_game_year ; ///< year the server restarts
2008-09-30 20:39:50 +00:00
uint8 min_active_clients ; ///< minimum amount of active clients to unpause the game
2008-05-29 21:36:29 +00:00
uint8 server_lang ; ///< language of the server
bool reload_cfg ; ///< reload the config file before restarting
char last_host [ NETWORK_HOSTNAME_LENGTH ] ; ///< IP address of the last joined server
uint16 last_port ; ///< port of the last joined server
2010-02-03 18:42:23 +00:00
bool no_http_content_downloads ; ///< do not do content downloads over HTTP
2008-05-29 20:21:28 +00:00
# else /* ENABLE_NETWORK */
# endif
} ;
2008-05-25 19:17:03 +00:00
/** Settings related to the creation of games. */
struct GameCreationSettings {
uint32 generation_seed ; ///< noise seed for world generation
Year starting_year ; ///< starting date
uint8 map_x ; ///< X size of map
uint8 map_y ; ///< Y size of map
byte land_generator ; ///< the landscape generator
byte oil_refinery_limit ; ///< distance oil refineries allowed from map edge
byte snow_line_height ; ///< a number 0-15 that configured snow line height
byte tgen_smoothness ; ///< how rough is the terrain from 0-3
byte tree_placer ; ///< the tree placer algorithm
byte heightmap_rotation ; ///< rotation director for the heightmap
byte se_flat_world_height ; ///< land height a flat world gets in SE
2008-05-25 22:36:44 +00:00
byte town_name ; ///< the town name generator used for town names
byte landscape ; ///< the landscape we're currently in
byte snow_line ; ///< the snowline level in this game
2009-01-21 02:31:55 +00:00
byte water_borders ; ///< bitset of the borders that are water
2009-03-12 23:54:20 +00:00
uint16 custom_town_number ; ///< manually entered number of towns
2009-12-19 18:00:38 +00:00
byte variety ; ///< variety level applied to TGP
2010-09-20 18:56:35 +00:00
byte custom_sea_level ; ///< manually entered percentage of water in the map
2008-05-25 19:17:03 +00:00
} ;
2008-01-07 00:19:09 +00:00
2008-05-25 19:17:03 +00:00
/** Settings related to construction in-game */
struct ConstructionSettings {
bool build_on_slopes ; ///< allow building on slopes
bool autoslope ; ///< allow terraforming under things
bool longbridges ; ///< allow 100 tile long bridges
bool signal_side ; ///< show signals on right side
bool extra_dynamite ; ///< extra dynamite
bool road_stop_on_town_road ; ///< allow building of drive-through road stops on town owned roads
2009-03-02 22:57:47 +00:00
bool road_stop_on_competitor_road ; ///< allow building of drive-through road stops on roads owned by competitors
2008-05-25 19:17:03 +00:00
uint8 raw_industry_construction ; ///< type of (raw) industry construction (none, "normal", prospecting)
2010-08-28 18:37:49 +00:00
uint8 industry_platform ; ///< the amount of flat land around an industry
2009-01-21 02:31:55 +00:00
bool freeform_edges ; ///< allow terraforming the tiles at the map edges
2009-12-17 16:59:33 +00:00
uint8 extra_tree_placement ; ///< (dis)allow building extra trees in-game
2008-05-25 19:17:03 +00:00
} ;
2008-01-07 00:19:09 +00:00
2008-05-25 19:17:03 +00:00
/** Settings related to the AI. */
struct AISettings {
bool ai_in_multiplayer ; ///< so we allow AIs in multiplayer
bool ai_disable_veh_train ; ///< disable types for AI
bool ai_disable_veh_roadveh ; ///< disable types for AI
bool ai_disable_veh_aircraft ; ///< disable types for AI
bool ai_disable_veh_ship ; ///< disable types for AI
2009-01-12 17:11:45 +00:00
uint32 ai_max_opcode_till_suspend ; ///< max opcode calls till AI will suspend
2008-05-25 19:17:03 +00:00
} ;
2008-01-07 00:19:09 +00:00
2008-05-25 19:17:03 +00:00
/** Settings related to the old pathfinder. */
struct OPFSettings {
uint16 pf_maxlength ; ///< maximum length when searching for a train route for new pathfinder
byte pf_maxdepth ; ///< maximum recursion depth when searching for a train route for new pathfinder
} ;
2008-01-07 00:19:09 +00:00
2008-05-25 19:17:03 +00:00
/** Settings related to the new pathfinder. */
struct NPFSettings {
2008-01-07 00:19:09 +00:00
/**
* The maximum amount of search nodes a single NPF run should take . This
* limit should make sure performance stays at acceptable levels at the cost
2008-05-25 19:17:03 +00:00
* of not being perfect anymore .
2008-01-07 00:19:09 +00:00
*/
uint32 npf_max_search_nodes ;
2009-12-13 10:48:44 +00:00
uint32 maximum_go_to_depot_penalty ; ///< What is the maximum penalty that may be endured for going to a depot
2008-01-07 00:19:09 +00:00
2008-05-25 19:17:03 +00:00
uint32 npf_rail_firstred_penalty ; ///< the penalty for when the first signal is red (and it is not an exit or combo signal)
uint32 npf_rail_firstred_exit_penalty ; ///< the penalty for when the first signal is red (and it is an exit or combo signal)
uint32 npf_rail_lastred_penalty ; ///< the penalty for when the last signal is red
uint32 npf_rail_station_penalty ; ///< the penalty for station tiles
uint32 npf_rail_slope_penalty ; ///< the penalty for sloping upwards
uint32 npf_rail_curve_penalty ; ///< the penalty for curves
uint32 npf_rail_depot_reverse_penalty ; ///< the penalty for reversing in depots
2008-08-02 22:52:36 +00:00
uint32 npf_rail_pbs_cross_penalty ; ///< the penalty for crossing a reserved rail track
uint32 npf_rail_pbs_signal_back_penalty ; ///< the penalty for passing a pbs signal from the backside
2008-05-25 19:17:03 +00:00
uint32 npf_buoy_penalty ; ///< the penalty for going over (through) a buoy
uint32 npf_water_curve_penalty ; ///< the penalty for curves
uint32 npf_road_curve_penalty ; ///< the penalty for curves
uint32 npf_crossing_penalty ; ///< the penalty for level crossings
uint32 npf_road_drive_through_penalty ; ///< the penalty for going through a drive-through road stop
2009-12-04 20:52:19 +00:00
uint32 npf_road_dt_occupied_penalty ; ///< the penalty multiplied by the fill percentage of a drive-through road stop
uint32 npf_road_bay_occupied_penalty ; ///< the penalty multiplied by the fill percentage of a road bay
2008-05-25 19:17:03 +00:00
} ;
2008-01-07 00:19:09 +00:00
2008-05-25 19:17:03 +00:00
/** Settings related to the yet another pathfinder. */
struct YAPFSettings {
bool disable_node_optimization ; ///< whether to use exit-dir instead of trackdir in node key
uint32 max_search_nodes ; ///< stop path-finding when this number of nodes visited
2009-12-13 10:48:44 +00:00
uint32 maximum_go_to_depot_penalty ; ///< What is the maximum penalty that may be endured for going to a depot
2008-05-25 19:17:03 +00:00
bool ship_use_yapf ; ///< use YAPF for ships
bool road_use_yapf ; ///< use YAPF for road
bool rail_use_yapf ; ///< use YAPF for rail
uint32 road_slope_penalty ; ///< penalty for up-hill slope
uint32 road_curve_penalty ; ///< penalty for curves
uint32 road_crossing_penalty ; ///< penalty for level crossing
uint32 road_stop_penalty ; ///< penalty for going through a drive-through road stop
2009-12-04 20:52:19 +00:00
uint32 road_stop_occupied_penalty ; ///< penalty multiplied by the fill percentage of a drive-through road stop
uint32 road_stop_bay_occupied_penalty ; ///< penalty multiplied by the fill percentage of a road bay
2008-05-25 19:17:03 +00:00
bool rail_firstred_twoway_eol ; ///< treat first red two-way signal as dead end
uint32 rail_firstred_penalty ; ///< penalty for first red signal
uint32 rail_firstred_exit_penalty ; ///< penalty for first red exit signal
uint32 rail_lastred_penalty ; ///< penalty for last red signal
uint32 rail_lastred_exit_penalty ; ///< penalty for last red exit signal
uint32 rail_station_penalty ; ///< penalty for non-target station tile
uint32 rail_slope_penalty ; ///< penalty for up-hill slope
uint32 rail_curve45_penalty ; ///< penalty for curve
uint32 rail_curve90_penalty ; ///< penalty for 90-deg curve
uint32 rail_depot_reverse_penalty ; ///< penalty for reversing in the depot
uint32 rail_crossing_penalty ; ///< penalty for level crossing
uint32 rail_look_ahead_max_signals ; ///< max. number of signals taken into consideration in look-ahead load balancer
int32 rail_look_ahead_signal_p0 ; ///< constant in polynomial penalty function
int32 rail_look_ahead_signal_p1 ; ///< constant in polynomial penalty function
int32 rail_look_ahead_signal_p2 ; ///< constant in polynomial penalty function
2008-08-02 22:51:07 +00:00
uint32 rail_pbs_cross_penalty ; ///< penalty for crossing a reserved tile
2008-08-02 22:51:38 +00:00
uint32 rail_pbs_station_penalty ; ///< penalty for crossing a reserved station tile
2008-08-02 22:51:07 +00:00
uint32 rail_pbs_signal_back_penalty ; ///< penalty for passing a pbs signal from the backside
2008-08-02 22:51:23 +00:00
uint32 rail_doubleslip_penalty ; ///< penalty for passing a double slip switch
2008-05-25 19:17:03 +00:00
uint32 rail_longer_platform_penalty ; ///< penalty for longer station platform than train
uint32 rail_longer_platform_per_tile_penalty ; ///< penalty for longer station platform than train (per tile)
uint32 rail_shorter_platform_penalty ; ///< penalty for shorter station platform than train
uint32 rail_shorter_platform_per_tile_penalty ; ///< penalty for shorter station platform than train (per tile)
} ;
2008-01-07 00:19:09 +00:00
2008-05-25 19:17:03 +00:00
/** Settings related to all pathfinders. */
struct PathfinderSettings {
uint8 pathfinder_for_trains ; ///< the pathfinder to use for trains
uint8 pathfinder_for_roadvehs ; ///< the pathfinder to use for roadvehicles
uint8 pathfinder_for_ships ; ///< the pathfinder to use for ships
bool new_pathfinding_all ; ///< use the newest pathfinding algorithm for all
2008-01-07 00:19:09 +00:00
2008-05-25 19:17:03 +00:00
bool roadveh_queue ; ///< buggy road vehicle queueing
bool forbid_90_deg ; ///< forbid trains to make 90 deg turns
2008-01-07 00:19:09 +00:00
2008-05-25 19:17:03 +00:00
byte wait_oneway_signal ; ///< waitingtime in days before a oneway signal
byte wait_twoway_signal ; ///< waitingtime in days before a twoway signal
2008-01-07 00:19:09 +00:00
2008-08-02 22:53:51 +00:00
bool reserve_paths ; ///< always reserve paths regardless of signal type.
byte wait_for_pbs_path ; ///< how long to wait for a path reservation.
byte path_backoff_interval ; ///< ticks between checks for a free path.
2008-05-25 19:17:03 +00:00
OPFSettings opf ; ///< pathfinder settings for the old pathfinder
NPFSettings npf ; ///< pathfinder settings for the new pathfinder
YAPFSettings yapf ; ///< pathfinder settings for the yet another pathfinder
} ;
2008-01-07 00:19:09 +00:00
2008-05-25 19:17:03 +00:00
/** Settings related to orders. */
struct OrderSettings {
bool improved_load ; ///< improved loading algorithm
bool gradual_loading ; ///< load vehicles gradually
bool selectgoods ; ///< only send the goods to station if a train has been there
bool gotodepot ; ///< allow goto depot in orders
bool no_servicing_if_no_breakdowns ; ///< dont send vehicles to depot when breakdowns are disabled
bool timetabling ; ///< whether to allow timetabling
bool serviceathelipad ; ///< service helicopters at helipads automatically (no need to send to depot)
} ;
2008-01-07 00:19:09 +00:00
2008-05-25 19:17:03 +00:00
/** Settings related to vehicles. */
struct VehicleSettings {
bool mammoth_trains ; ///< allow very long trains
2010-08-05 12:09:08 +00:00
uint8 smoke_amount ; ///< amount of smoke/sparks locomotives produce
2009-01-23 20:53:43 +00:00
uint8 train_acceleration_model ; ///< realistic acceleration for trains
2010-03-06 12:56:57 +00:00
uint8 roadveh_acceleration_model ; ///< realistic acceleration for road vehicles
2009-12-31 10:41:03 +00:00
uint8 train_slope_steepness ; ///< Steepness of hills for trains when using realistic acceleration
2010-03-06 12:58:33 +00:00
uint8 roadveh_slope_steepness ; ///< Steepness of hills for road vehicles when using realistic acceleration
2008-05-25 19:17:03 +00:00
bool wagon_speed_limits ; ///< enable wagon speed limits
bool disable_elrails ; ///< when true, the elrails are disabled
2008-09-30 20:39:50 +00:00
UnitID max_trains ; ///< max trains in game per company
UnitID max_roadveh ; ///< max trucks in game per company
UnitID max_aircraft ; ///< max planes in game per company
UnitID max_ships ; ///< max ships in game per company
2008-05-25 19:17:03 +00:00
uint8 plane_speed ; ///< divisor for speed of aircraft
uint8 freight_trains ; ///< value to multiply the weight of cargo by
bool dynamic_engines ; ///< enable dynamic allocation of engine data
bool never_expire_vehicles ; ///< never expire vehicles
byte extend_vehicle_life ; ///< extend vehicle life by this many years
2008-05-25 22:36:44 +00:00
byte road_side ; ///< the side of the road vehicles drive on
2010-01-28 22:34:14 +00:00
uint8 plane_crashes ; ///< number of plane crashes, 0 = none, 1 = reduced, 2 = normal
2008-05-25 19:17:03 +00:00
} ;
2008-01-07 00:19:09 +00:00
2008-05-25 19:17:03 +00:00
/** Settings related to the economy. */
struct EconomySettings {
bool inflation ; ///< disable inflation
bool bribe ; ///< enable bribing the local authority
bool smooth_economy ; ///< smooth economy
bool allow_shares ; ///< allow the buying/selling of shares
2010-01-03 21:29:20 +00:00
uint8 feeder_payment_share ; ///< percentage of leg payment to virtually pay in feeder systems
2008-05-25 19:17:03 +00:00
byte dist_local_authority ; ///< distance for town local authority, default 20
bool exclusive_rights ; ///< allow buying exclusive rights
2008-09-30 20:39:50 +00:00
bool give_money ; ///< allow giving other companies money
2008-05-25 19:17:03 +00:00
bool mod_road_rebuild ; ///< roadworks remove unneccesary RoadBits
bool multiple_industry_per_town ; ///< allow many industries of the same type per town
uint8 town_growth_rate ; ///< town growth rate
uint8 larger_towns ; ///< the number of cities to build. These start off larger and grow twice as fast
uint8 initial_city_size ; ///< multiplier for the initial size of the cities compared to towns
2009-11-24 21:18:11 +00:00
TownLayoutByte town_layout ; ///< select town layout, @see TownLayout
2009-02-04 20:17:25 +00:00
bool allow_town_roads ; ///< towns are allowed to build roads (always allowed when generating world / in SE)
2009-11-24 21:18:11 +00:00
TownFoundingByte found_town ; ///< town founding, @see TownFounding
2008-05-25 19:17:03 +00:00
bool station_noise_level ; ///< build new airports when the town noise level is still within accepted limits
uint16 town_noise_population [ 3 ] ; ///< population to base decision on noise evaluation (@see town_council_tolerance)
2010-07-02 16:34:07 +00:00
bool allow_town_level_crossings ; ///< towns are allowed to build level crossings
2008-05-25 19:17:03 +00:00
} ;
2008-01-07 00:19:09 +00:00
2008-05-25 19:17:03 +00:00
/** Settings related to stations. */
struct StationSettings {
bool modified_catchment ; ///< different-size catchment areas
bool join_stations ; ///< allow joining of train stations
bool nonuniform_stations ; ///< allow nonuniform train stations
bool adjacent_stations ; ///< allow stations to be built directly adjacent to other stations
2009-01-08 16:35:45 +00:00
bool distant_join_stations ; ///< allow to join non-adjacent stations
2009-06-21 13:26:30 +00:00
bool never_expire_airports ; ///< never expire airports
2008-05-25 19:17:03 +00:00
byte station_spread ; ///< amount a station may spread
} ;
2008-04-29 21:31:29 +00:00
2009-05-26 21:59:49 +00:00
/** Default settings for vehicles. */
struct VehicleDefaultSettings {
bool servint_ispercent ; ///< service intervals are in percents
uint16 servint_trains ; ///< service interval for trains
uint16 servint_roadveh ; ///< service interval for road vehicles
uint16 servint_aircraft ; ///< service interval for aircraft
uint16 servint_ships ; ///< service interval for ships
} ;
2009-05-15 23:55:06 +00:00
/** Settings that can be set per company. */
struct CompanySettings {
bool engine_renew ; ///< is autorenew enabled
int16 engine_renew_months ; ///< months before/after the maximum vehicle age a vehicle should be renewed
uint32 engine_renew_money ; ///< minimum amount of money before autorenew is used
bool renew_keep_length ; ///< sell some wagons if after autoreplace the train is longer than before
2009-05-26 21:59:49 +00:00
VehicleDefaultSettings vehicle ; ///< default settings for vehicles
2009-05-15 23:55:06 +00:00
} ;
2008-05-29 15:13:28 +00:00
/** All settings together for the game. */
struct GameSettings {
2008-05-25 22:36:44 +00:00
DifficultySettings difficulty ; ///< settings related to the difficulty
2008-05-25 19:17:03 +00:00
GameCreationSettings game_creation ; ///< settings used during the creation of a game (map)
ConstructionSettings construction ; ///< construction of things in-game
AISettings ai ; ///< what may the AI do?
2009-01-12 17:11:45 +00:00
class AIConfig * ai_config [ MAX_COMPANIES ] ; ///< settings per company
2008-05-25 19:17:03 +00:00
PathfinderSettings pf ; ///< settings for all pathfinders
OrderSettings order ; ///< settings related to orders
VehicleSettings vehicle ; ///< options for vehicles
EconomySettings economy ; ///< settings to change the economy
StationSettings station ; ///< settings related to station management
2008-06-05 11:26:38 +00:00
LocaleSettings locale ; ///< settings related to used currency/unit system in the current game
2008-01-07 00:19:09 +00:00
} ;
2008-05-29 15:13:28 +00:00
/** All settings that are only important for the local client. */
struct ClientSettings {
GUISettings gui ; ///< settings related to the GUI
2008-05-29 20:21:28 +00:00
NetworkSettings network ; ///< settings related to the network
2009-05-15 23:55:06 +00:00
CompanySettings company ; ///< default values for per-company settings
2008-05-29 15:13:28 +00:00
} ;
/** The current settings for this game. */
extern ClientSettings _settings_client ;
/** The current settings for this game. */
extern GameSettings _settings_game ;
2008-01-07 00:19:09 +00:00
2008-05-29 15:13:28 +00:00
/** The settings values that are used for new games and/or modified in config file. */
extern GameSettings _settings_newgame ;
2008-01-07 00:19:09 +00:00
# endif /* SETTINGS_TYPE_H */