OpenTTD: src/settings_type.h File Reference

OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

Data Structures | Enumerations | Functions | Variables
settings_type.h File Reference

Types related to global configuration settings. More...

`#include "date_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"`

Go to the source code of this file.

## Data Structures
struct | DifficultySettings
| Settings related to the difficulty of the game. More...
struct | GUISettings
| Settings related to the GUI and other stuff that is not saved in the savegame. More...
struct | SoundSettings
| Settings related to sound effects. More...
struct | MusicSettings
| Settings related to music. More...
struct | LocaleSettings
| Settings related to currency/unit systems. More...
struct | NewsSettings
| Settings related to news. More...
struct | NetworkSettings
| All settings related to the network. More...
struct | GameCreationSettings
| Settings related to the creation of games. More...
struct | ConstructionSettings
| Settings related to construction in-game. More...
struct | AISettings
| Settings related to the AI. More...
struct | ScriptSettings
| Settings related to scripts. More...
struct | OPFSettings
| Settings related to the old pathfinder. More...
struct | NPFSettings
| Settings related to the new pathfinder. More...
struct | YAPFSettings
| Settings related to the yet another pathfinder. More...
struct | PathfinderSettings
| Settings related to all pathfinders. More...
struct | OrderSettings
| Settings related to orders. More...
struct | VehicleSettings
| Settings related to vehicles. More...
struct | EconomySettings
| Settings related to the economy. More...
struct | LinkGraphSettings
struct | StationSettings
| Settings related to stations. More...
struct | VehicleDefaultSettings
| Default settings for vehicles. More...
struct | CompanySettings
| Settings that can be set per company. More...
struct | GameSettings
| All settings together for the game. More...
struct | ClientSettings
| All settings that are only important for the local client. More...

## Enumerations
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 }
| Settings profiles and highscore tables. More...
enum | IndustryDensity { ID_FUND_ONLY, ID_MINIMAL, ID_VERY_LOW, ID_LOW, ID_NORMAL, ID_HIGH, ID_END }
| Available industry map generation densities. More...

## Functions
static GameSettings & | GetGameSettings ()
| Get the settings-object applicable for the current situation: the newgame settings when we're in the main menu and otherwise the settings of the current game.

## Variables
ClientSettings | _settings_client
| The current settings for this game.
GameSettings | _settings_game
| The current settings for this game.
GameSettings | _settings_newgame
| The settings values that are used for new games and/or modified in config file.
VehicleDefaultSettings | _old_vds
| Old vehicle settings, which were game settings before, and are company settings now.

## Detailed Description

Types related to global configuration settings.

Definition in file settings_type.h.

## Enumeration Type Documentation

enum IndustryDensity

Available industry map generation densities.

Enumerator:

  ID_FUND_ONLY | The game does not build industries.
  ID_MINIMAL | Start with just the industries that must be present.
  ID_VERY_LOW | Very few industries at game start.
  ID_LOW | Few industries at game start.
  ID_NORMAL | Normal amount of industries at game start.
  ID_HIGH | Many industries at game start.
  ID_END | Number of industry density settings.

Definition at line 43 of file settings_type.h.

enum SettingsProfile

Settings profiles and highscore tables.

Enumerator:

  SP_EASY | Easy difficulty.
  SP_MEDIUM | Medium difficulty.
  SP_HARD | Hard difficulty.
  SP_END | End of setting profiles.
  SP_CUSTOM | No profile, special "custom" highscore.
  SP_SAVED_HIGHSCORE_END | End of saved highscore tables.
  SP_MULTIPLAYER | Special "multiplayer" highscore. Not saved, always specific to the current game.
  SP_HIGHSCORE_END | End of highscore tables.

Definition at line 27 of file settings_type.h.

## Variable Documentation

VehicleDefaultSettings _old_vds

Old vehicle settings, which were game settings before, and are company settings now.

(Needed for savegame conversion)

Definition at line 79 of file settings.cpp.

Referenced by AfterLoadGame().

ClientSettings _settings_client

The current settings for this game.

Definition at line 76 of file settings.cpp.

Referenced by AddNewsItem(), AfterLoadGame(), AIDebugWindow::AIDebugWindow(), ServerNetworkAdminSocketHandler::AllowConnection(), ServerNetworkGameSocketHandler::AllowConnection(), AmbientSoundEffectCallback(), AnimationBase< IndustryAnimationBase, IndustryTileSpec, Industry, int, GetSimpleIndustryCallback >::AnimateTile(), GameOptionsWindow::BuildDropDownList(), BuildLandLegend(), BuildOwnerLegend(), BuildRailClick_Remove(), CalcRaildirsDrawstyle(), CanBuildVehicleInfrastructure(), CcBuildBridge(), CcBuildRailTunnel(), CcBuildRoadTunnel(), CcRoadStop(), AnimationBase< IndustryAnimationBase, IndustryTileSpec, Industry, int, GetSimpleIndustryCallback >::ChangeAnimationFrame(), CheckMinActiveClients(), CheckOrders(), CheckPauseOnJoin(), BuildRailStationWindow::CheckSelectedSize(), CheckSoftLimit(), CheckTrainCollision(), CheckTrainStayInDepot(), ClearPathReservation(), CmdCompanyCtrl(), CommonRaiseLowerBigLand(), CompaniesYearlyLoop(), CompanyServiceInterval(), Order::ConvertFromOldSavegame(), CrashAirplane(), DisasterTick_Aircraft(), DisasterTick_Big_Ufo_Destroyer(), DisasterTick_Ufo(), DisasterTick_Zeppeliner(), DispatchRightClickEvent(), DistributeQueue(), DoAutosave(), GRFFileScanner::DoScan(), ClientNetworkContentSocketHandler::DownloadSelectedContent(), DoZoomInOutWindow(), DrawBridgeMiddle(), DrawCategories(), BaseGraphWindow::DrawGraph(), DrawTile_Road(), DrawTile_TunnelBridge(), DrawTrackBits(), TimetableWindow::DrawWidget(), MusicTrackSelectionWindow::DrawWidget(), MusicWindow::DrawWidget(), NetworkStartServerWindow::DrawWidget(), ScanProgressWindow::DrawWidget(), DrawYearColumn(), Blitter_32bppOptimized::Encode(), Blitter_8bppOptimized::Encode(), FloodVehicle(), GenerateDefaultSaveName(), GenerateRockyArea(), GenericPlaceSignals(), GetLogPrefix(), GetOrderCmdFromTile(), GetSmallMapContoursPixels(), GetSmallMapIndustriesPixels(), GetSmallMapOwnerPixels(), GetSmallMapRoutesPixels(), GetSmallMapVehiclesPixels(), HandleAutoscroll(), HandleAutoSignalPlacement(), HandleMouseEvents(), Vehicle::HandlePathfindingResult(), HandlePlacePushButton(), HandleViewportScroll(), HandleWindowDragging(), HandleZoomMessage(), IConsoleDebug(), IConsoleWarning(), InitializeMusic(), InitializeRailGUI(), InitializeWindowViewport(), LoadUnloadVehicle(), MaybeBarCrossingWithSound(), MaybeStartNewCompany(), MenuClickSettings(), NetworkAutoCleanCompanies(), NetworkCheckRestartMap(), NetworkClientPreferTeamChat(), NetworkDisconnect(), NetworkInitChatMessage(), NetworkMaxCompaniesReached(), NetworkMaxSpectatorsReached(), NetworkServer_Tick(), NetworkServerSendChat(), NetworkServerSetCompanyPassword(), NetworkStartUp(), NetworkUDPAdvertise(), NetworkUDPAdvertiseThread(), NetworkUDPInitialize(), NetworkUDPRemoveAdvertiseThread(), NetworkUpdateClientName(), TransparenciesWindow::OnClick(), BuildTreesWindow::OnClick(), SmallMapWindow::OnClick(), BuildRoadToolbarWindow::OnClick(), MusicTrackSelectionWindow::OnClick(), BuildDocksStationWindow::OnClick(), BuildAirportWindow::OnClick(), SaveLoadWindow::OnClick(), TimetableWindow::OnClick(), BuildRailToolbarWindow::OnClick(), BuildDocksDepotWindow::OnClick(), ScenarioEditorLandscapeGenerationWindow::OnClick(), MusicWindow::OnClick(), NetworkGameWindow::OnClick(), BuildRoadDepotWindow::OnClick(), BuildRoadStationWindow::OnClick(), NetworkStartServerWindow::OnClick(), BuildRailStationWindow::OnClick(), NetworkLobbyWindow::OnClick(), BuildSignalWindow::OnClick(), BuildRailDepotWindow::OnClick(), BuildRailWaypointWindow::OnClick(), IndustryCargoesWindow::OnClick(), GameOptionsWindow::OnDropdownSelect(), NetworkGameWindow::OnDropdownSelect(), NetworkStartServerWindow::OnDropdownSelect(), GameSettingsWindow::OnDropdownSelect(), ScenarioEditorToolbarWindow::OnDropdownSelect(), NetworkGameWindow::OnEditboxChanged(), NetworkStartServerWindow::OnEditboxChanged(), MainWindow::OnHotkey(), SelectGameWindow::OnInit(), MusicTrackSelectionWindow::OnInvalidateData(), MusicWindow::OnInvalidateData(), SaveLoadWindow::OnInvalidateData(), SelectCompanyLiveryWindow::OnInvalidateData(), NewGRFWindow::OnInvalidateData(), BuildSignalWindow::OnInvalidateData(), ExtraViewportWindow::OnMouseWheel(), SmallMapWindow::OnMouseWheel(), MainWindow::OnMouseWheel(), AfterNewGRFScan::OnNewGRFsScanned(), OnNewMonth(), OnNewYear(), CompanyFinancesWindow::OnPaint(), BuildDocksStationWindow::OnPaint(), BuildRoadStationWindow::OnPaint(), BuildRailStationWindow::OnPaint(), BuildRoadToolbarWindow::OnPlaceMouseUp(), BuildRailToolbarWindow::OnPlaceMouseUp(), BuildIndustryWindow::OnPlaceObject(), OrdersWindow::OnPlaceObject(), TimetableWindow::OnQueryTextFinished(), NetworkStartServerWindow::OnQueryTextFinished(), OrdersWindow::OrderClick_NearestDepot(), PlaceRail_Station(), PlayVehicleSound(), PopupMainToolbMenu(), PositionMainToolbar(), PositionNetworkChatWindow(), PositionNewsMessage(), PositionStatusbar(), AISettingsWindow::RebuildVisibleSettings(), ServerNetworkAdminSocketHandler::Receive_ADMIN_JOIN(), ServerNetworkGameSocketHandler::Receive_CLIENT_COMMAND(), ServerNetworkUDPSocketHandler::Receive_CLIENT_FIND_SERVER(), ServerNetworkGameSocketHandler::Receive_CLIENT_GAME_PASSWORD(), ServerNetworkGameSocketHandler::Receive_CLIENT_JOIN(), ServerNetworkGameSocketHandler::Receive_CLIENT_NEWGRFS_CHECKED(), ServerNetworkGameSocketHandler::Receive_CLIENT_RCON(), MasterNetworkUDPSocketHandler::Receive_MASTER_ACK_REGISTER(), ScriptScanner::RegisterScript(), ResetSignalVariant(), SaveOrLoad(), SearchLumberMillTrees(), StationViewWindow::SelectGroupBy(), StationViewWindow::SelectSortBy(), StationViewWindow::SelectSortOrder(), ServerNetworkGameSocketHandler::SendConfigUpdate(), ClientNetworkGameSocketHandler::SendJoin(), ServerNetworkGameSocketHandler::SendNeedCompanyPassword(), ServerNetworkGameSocketHandler::SendWelcome(), ServerNetworkAdminSocketHandler::SendWelcome(), ServerNetworkGameSocketHandler::ServerNetworkGameSocketHandler(), SetDefaultRailGui(), MusicTrackSelectionWindow::SetStringParameters(), GameOptionsWindow::SetStringParameters(), NetworkGameWindow::SetStringParameters(), NetworkStartServerWindow::SetStringParameters(), BuildSignalWindow::SetStringParameters(), GRFConfig::SetSuitablePalette(), SetTimetableParams(), SetupScreenshotViewport(), NWidgetLeaf::SetupSmallestSize(), ShowErrorMessage(), ShowMeasurementTooltips(), ShowNetworkLobbyWindow(), ShowNewspaper(), ShowSelectBaseStationIfNeeded(), ShowTicker(), SndPlayScreenCoordFx(), ToggleBoundingBoxes(), ToggleDirtyBlocks(), ToolbarFastForwardClick(), ToolbarOptionsClick(), TrainController(), IConsoleLine::Truncate(), TryPathReserve(), TryReserveRailTrack(), UnreserveRailTrack(), UpdateLevelCrossing(), ScanProgressWindow::UpdateNewGRFScanStatus(), TimetableWindow::UpdateSelectionStates(), UpdateViewportPosition(), Town::UpdateVirtCoord(), CompanyFinancesWindow::UpdateWidgetSize(), VehicleEnterDepot(), and VpSelectTilesWithMethod().

GameSettings _settings_game

The current settings for this game.

Definition at line 77 of file settings.cpp.

Referenced by _GenerateWorld(), AddInflation(), AffectSpeedByZChange(), AfterLoadGame(), AfterLoadVehicles(), AircraftController(), AircraftEventHandler_AtTerminal(), AutoslopeEnabled(), Subsidy::AwardTo(), BuildLandLegend(), BuildRailClick_Remove(), BuildTownHouse(), CalcEngineReliability(), CanBuildVehicleInfrastructure(), CanExpandRailStation(), CanFollowRoad(), AI::CanStartNew(), ChangeIndustryProduction(), CheckAllowRemoveRoad(), CheckAllowRemoveTunnelBridge(), CheckBridgeAvailability(), CheckBuildableTile(), CheckFlatLandRoadStop(), CheckforTownRating(), CheckIfAuthorityAllowsNewStation(), CheckIfCanLevelIndustryPlatform(), CheckIfIndustryTilesAreFree(), CheckIfTrainNeedsService(), CheckIndustryCloseDownProtection(), CheckNewIndustry_Farm(), CheckNewIndustry_Forest(), CheckNewIndustry_OilRefinery(), CheckNewIndustry_OilRig(), CheckNewTrain(), CheckNextTrainTile(), CheckOrders(), CheckRailSlope(), CheckRoadSlope(), CheckSwitchToEuro(), CheckTrainAttachment(), CheckTrainStayInDepot(), ChooseShipTrack(), ClampXYToMap(), ClickChangeMaxHlCheat(), CmdBuildAirport(), CmdBuildBridge(), CmdBuildDock(), CmdBuildIndustry(), CmdBuildRailStation(), CmdBuildRailWaypoint(), CmdBuildRoad(), CmdBuildRoadDepot(), CmdBuildRoadStop(), CmdBuildRoadVehicle(), CmdBuildSingleSignal(), CmdBuildTrainDepot(), CmdBuildTunnel(), CmdBuyShareInCompany(), CmdConvertRail(), CmdFoundTown(), CmdGiveMoney(), CmdInsertOrder(), CmdLevelLand(), CmdPlantTree(), CmdRefitVehicle(), CmdReverseTrainDirection(), CmdSellShareInCompany(), CmdTerraformLand(), CompaniesGenStatistics(), CompaniesMonthlyLoop(), Company::Company(), Train::ConsistChanged(), ConvertDisplaySpeedToKmhishSpeed(), ConvertDisplaySpeedToSpeed(), ConvertKmhishSpeedToDisplaySpeed(), ConvertSpeedToDisplaySpeed(), CreateNewIndustryHelper(), CreateRivers(), DeleteStaleLinks(), DeliverGoods(), DisplayVehicleSortDropDown(), DistanceFromEdgeDir(), DoCreateTown(), DoTrainPathfind(), LinkGraphOverlay::DrawContent(), CompanyInfrastructureWindow::DrawCountLine(), StationViewWindow::DrawEntries(), DrawRoadAsSnowDesert(), SmallMapWindow::DrawSmallMapColumn(), DrawTrainDetails(), TownViewWindow::DrawWidget(), CompanyInfrastructureWindow::DrawWidget(), VehicleDetailsWindow::DrawWidget(), ScenarioEditorToolbarWindow::DrawWidget(), ExtendTrainReservation(), FinaliseHouseArray(), FindClosestTrainDepot(), FindJoiningBaseStation(), FindSafePosition(), FindSpring(), FindStationsAroundTiles(), FindStationsNearby(), FindSubsidyIndustryCargoRoute(), FindSubsidyTownCargoRoute(), FindTownForIndustry(), FlatEmptyWorld(), FlowRiver(), FollowTrainReservation(), FormatBytes(), FormatNumber(), FormatString(), FreightWagonMult(), GamelogMode(), GamelogTestMode(), AI::GameLoop(), ScriptInstance::GameLoop(), GenerateIndustries(), GenerateLandscape(), GenerateTerrainPerlin(), GenerateTownName(), GenerateTowns(), GenerateTrees(), GetAirportNoiseLevelForTown(), GetAmplitude(), Station::GetCatchmentRadius(), GetClosestWaterDistance(), GetCompanyRailtypes(), GetCompanyRoadtypes(), GameConfig::GetConfig(), AIConfig::GetConfig(), IndustrySpec::GetConstructionCost(), RoadVehicle::GetCurrentMaxSpeed(), Train::GetCurrentMaxSpeed(), Train::GetCurveSpeedLimit(), TownViewWindow::GetDesiredInfoHeight(), GetDriveableTrackdirBits(), GetFreeUnitNumber(), GetGameSettings(), GetGlobalVariable(), GetIndustryGamePlayProbability(), Engine::GetLifeLengthInDays(), GetLoadAmount(), GetMaskOfTownActions(), GetNewEngine(), GetNewEngineID(), GetNumberOfIndustries(), GetOtherAqueductEnd(), GetRailTypeDropDownList(), GetRandomTreeType(), GetScaledIndustryGenerationProbability(), RoadVehicle::GetSlopeSteepness(), Train::GetSlopeSteepness(), GetSmallMapVegetationPixels(), GetSnowLine(), GetTerrainType(), TownScopeResolver::GetVariable(), GfxLoadSprites(), GlobalVarChangeInfo(), GrayscaleToMapHeights(), GrowTown(), GrowTownInTile(), GUIPlaceProcDragXY(), Vehicle::HandleBreakdown(), HasRailCatenaryDrawn(), HeightmapCallback(), HeightMapCoastLines(), HeightMapNormalize(), HeightMapSineTransform(), HighestSnowLine(), IndustryCargoesWindow::HousesCanAccept(), IndustriesChangeInfo(), InitializeGRFSpecial(), InitLoading(), int_noise(), AirportSpec::IsAvailable(), IsCommandAllowedWhilePaused(), Engine::IsEnabled(), ObjectSpec::IsEverAvailable(), IsInnerTile(), IsRoadAllowedHere(), IsValidTileForWaypoint(), IsVehicleTypeDisabled(), LoadNewGRF(), LoadSpriteTables(), LoadUnloadVehicle(), LowestSnowLine(), MakeLake(), Town::MaxTownNoise(), MaybeCrashAirplane(), MaybeStartNewCompany(), MayCompanyTakeOver(), MenuClickTown(), IndustryBuildData::MonthlyLoop(), Vehicle::NeedsServicing(), NetworkServerSetCompanyPassword(), NPFFindSafeTile(), NPFSaveTargetData(), TownViewWindow::OnClick(), BuildIndustryWindow::OnClick(), CreateScenarioWindow::OnClick(), LandInfoWindow::OnInit(), BuildTreesWindow::OnInit(), BuildIndustryWindow::OnInvalidateData(), BuildVehicleWindow::OnInvalidateData(), CompanyWindow::OnInvalidateData(), BuildAirportWindow::OnPaint(), BuildDocksStationWindow::OnPaint(), BuildRoadStationWindow::OnPaint(), BuildRailStationWindow::OnPaint(), ScenarioEditorToolbarWindow::OnPaint(), CreateScenarioWindow::OnQueryTextFinished(), OnTick_LinkGraph(), ParamSet(), ScriptInstance::Pause(), CargoPayment::PayTransfer(), CYapfCostRailT< Types >::PfCalcCost(), PlaceRail_Station(), PlaceRoad_BusStation(), PlaceRoad_TruckStation(), PlaceTreesRandomly(), SmallMapWindow::RebuildColourIndexIfNecessary(), ServerNetworkUDPSocketHandler::Receive_CLIENT_FIND_SERVER(), RecomputePrices(), RemoveAirport(), RemoveRoad(), ReplaceChain(), AI::ResetConfig(), ResetIndustries(), ResetNewGRFData(), ReverseTrainDirection(), RoadFindPathToDest(), ServerNetworkGameSocketHandler::SendNeedCompanyPassword(), ServerNetworkGameSocketHandler::SendWelcome(), ServerNetworkAdminSocketHandler::SendWelcome(), SetSettingValue(), SetStartingYear(), BuildIndustryWindow::SetStringParameters(), SetupScreenshotViewport(), SetYearEngineAgingStops(), StationViewWindow::ShowCargo(), Vehicle::ShowVisualEffect(), SplitGroundSpriteForOverlay(), StartupOneEngine(), StateGameLoop(), StationJoinerNeeded(), SubsidyMonthlyLoop(), TerraformTileHeight(), TestAutoslopeOnRailTile(), TGPGetMaxHeight(), TileAddWrap(), ToolbarScenDatePanel(), TownHouseChangeInfo(), TownLayoutAllows2x2HouseHere(), TownLayoutAllowsHouseHere(), TrainCheckIfLineEnds(), TrainController(), TrainDetailsCapacityTab(), TrainDetailsCargoTab(), TranslateXYToTileCoord(), TryPathReserve(), TryReserveSafeTrack(), Game::Uninitialize(), AI::Uninitialize(), UpdateAircraftSpeed(), UpdateLandscapingLimits(), RoadVehicle::UpdateSpeed(), Train::UpdateSpeed(), UpdateTownGrowRate(), CompanyInfrastructureWindow::UpdateWidgetSize(), IndustrySpec::UsesSmoothEconomy(), ViewportAddLandscape(), YapfRoadVehicleChooseTrack(), YapfRoadVehicleFindNearestDepot(), YapfShipCheckReverse(), YapfShipChooseTrack(), YapfTrainCheckReverse(), YapfTrainChooseTrack(), YapfTrainFindNearestDepot(), YapfTrainFindNearestSafeTile(), and LinkGraphJob::~LinkGraphJob().

GameSettings _settings_newgame

The settings values that are used for new games and/or modified in config file.

Definition at line 78 of file settings.cpp.

Referenced by _GenerateWorld(), GameConfig::GetConfig(), AIConfig::GetConfig(), SettingEntry::IsVisibleByRestrictionMode(), GenerateLandscapeWindow::OnClick(), CreateScenarioWindow::OnClick(), GenerateLandscapeWindow::OnDropdownSelect(), CreateScenarioWindow::OnDropdownSelect(), SelectGameWindow::OnInvalidateData(), GenerateLandscapeWindow::OnInvalidateData(), AfterNewGRFScan::OnNewGRFsScanned(), CreateScenarioWindow::OnPaint(), GenerateLandscapeWindow::OnQueryTextFinished(), CreateScenarioWindow::OnQueryTextFinished(), AI::ResetConfig(), SetNewLandscapeType(), GenerateLandscapeWindow::SetStringParameters(), CreateScenarioWindow::SetStringParameters(), StartNewGameWithoutGUI(), Game::Uninitialize(), and AI::Uninitialize().