OpenTTD Source: src/settings_type.h File Reference

OpenTTD Source 12.2

Data Structures | Enumerations | Functions | Variables
settings_type.h File Reference
`#include "date_type.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"`

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 | 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...
enum | UseRelayService { URS_NEVER = 0, URS_ASK, URS_ALLOW }
| Possible values for "userelayservice" setting.
enum | ViewportScrollMode { VSM_VIEWPORT_RMB_FIXED, VSM_MAP_RMB_FIXED, VSM_MAP_RMB, VSM_MAP_LMB, VSM_END }
| Settings relating to viewport/smallmap scrolling. 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
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
ClientSettings | _settings_client
| The current settings for this game.
GameSettings | _settings_game
| The current settings for this game. More...
GameSettings | _settings_newgame
| The settings values that are used for new games and/or modified in config file. More...
VehicleDefaultSettings | _old_vds
| Old vehicle settings, which were game settings before, and are company settings now. More...

## Detailed Description

Types related to global configuration settings.

Definition in file settings_type.h.

## Enumeration Type Documentation

## ◆ IndustryDensity

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 53 of file settings_type.h.

## ◆ SettingsProfile

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 37 of file settings_type.h.

## ◆ ViewportScrollMode

enum ViewportScrollMode

Settings relating to viewport/smallmap scrolling.

Enumerator
VSM_VIEWPORT_RMB_FIXED | Viewport moves with mouse movement on holding right mouse button, cursor position is fixed.
VSM_MAP_RMB_FIXED | Map moves with mouse movement on holding right mouse button, cursor position is fixed.
VSM_MAP_RMB | Map moves with mouse movement on holding right mouse button, cursor moves.
VSM_MAP_LMB | Map moves with mouse movement on holding left mouse button, cursor moves.
VSM_END | Number of scroll mode settings.

Definition at line 96 of file settings_type.h.

## Variable Documentation

## ◆ _old_vds

VehicleDefaultSettings _old_vds

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

(Needed for savegame conversion)

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

Definition at line 55 of file settings.cpp.

## ◆ _settings_game

GameSettings _settings_game

The current settings for this game.

The current settings for this game.

Definition at line 53 of file settings.cpp.

Referenced by AffectSpeedByZChange(), AfterNewGRFScan::AfterNewGRFScan(), AutoslopeEnabled(), Subsidy::AwardTo(), BuildLandLegend(), BuildTownHouse(), CalcEngineReliability(), CalculateDesertLine(), CalculateSnowLine(), CanBuildVehicleInfrastructure(), CanFollowRoad(), AI::CanStartNew(), CheckBridgeAvailability(), CheckBuildableTile(), CheckforTownRating(), CheckIfAuthorityAllowsNewStation(), CheckIfCanLevelIndustryPlatform(), CheckIfTrainNeedsService(), CheckIndustryCloseDownProtection(), CheckNewIndustry_Farm(), CheckNewIndustry_Forest(), CheckNewTrain(), CheckNextTrainTile(), CheckRailSlope(), CheckRoadSlope(), CheckSwitchToEuro(), CheckTrainAttachment(), CheckTrainStayInDepot(), ChooseShipTrack(), ClickChangeMaxHlCheat(), CmdBuildRailWaypoint(), CmdBuildRoadDepot(), CmdBuildTrainDepot(), CmdConvertRail(), CmdFoundTown(), CmdGiveMoney(), CmdLevelLand(), CmdTerraformLand(), CompaniesMonthlyLoop(), ConvertDisplaySpeedToKmhishSpeed(), ConvertDisplaySpeedToSpeed(), ConvertKmhishSpeedToDisplaySpeed(), ConvertSpeedToDisplaySpeed(), CreateRivers(), DeleteStaleLinks(), DisplayVehicleSortDropDown(), DistanceFromEdgeDir(), DoTrainPathfind(), LinkGraphOverlay::DrawContent(), StationViewWindow::DrawEntries(), DrawRoadAsSnowDesert(), ScenarioEditorToolbarWindow::DrawWidget(), ExistingRoadTypes(), ExtendTrainReservation(), FillStaticNetworkServerGameInfo(), FindClosestTrainDepot(), FindSafePosition(), FindSpring(), FindSubsidyIndustryCargoRoute(), FindTownForIndustry(), FlatEmptyWorld(), FlowRiver(), FollowTrainReservation(), ForAllStationsAroundTiles(), FormatBytes(), FormatNumber(), FreightWagonMult(), AI::GameLoop(), ScriptInstance::GameLoop(), GenerateLandscape(), GenerateTerrainPerlin(), GenerateTownName(), GenerateTrees(), GetAcceptanceAroundTiles(), GetAirportNoiseLevelForDistance(), GetAmplitude(), Station::GetCatchmentRadius(), GetCompanyRailtypes(), GetCompanyRoadTypes(), Train::GetCurrentMaxSpeed(), RoadVehicle::GetCurrentMaxSpeed(), GetFreeUnitNumber(), GetGlobalVariable(), GetIndustryGamePlayProbability(), Engine::GetLifeLengthInDays(), GetLoadAmount(), GetMaskOfTownActions(), GetNormalGrowthRate(), GetOtherAqueductEnd(), GetRailTypes(), GetRandomTreeType(), GetRoadTypes(), GetScaledIndustryGenerationProbability(), RoadVehicle::GetSlopeSteepness(), Train::GetSlopeSteepness(), GetSnowLine(), GetTerrainType(), GetTileCatchmentRadius(), TownScopeResolver::GetVariable(), GfxLoadSprites(), GrayscaleToMapHeights(), GUIPlaceProcDragXY(), HasRailCatenaryDrawn(), HeightMapCoastLines(), HeightMapNormalize(), HeightMapSineTransform(), HighestSnowLine(), IndustryCargoesWindow::HousesCanAccept(), InitializeGRFSpecial(), AirportSpec::IsAvailable(), Engine::IsEnabled(), ObjectSpec::IsEverAvailable(), IsVehicleTypeDisabled(), PATSChunkHandler::Load(), LoadNewGRF(), LoadSpriteTables(), LowestSnowLine(), MakeLake(), Town::MaxTownNoise(), MaybeStartNewCompany(), MayCompanyTakeOver(), IndustryBuildData::MonthlyLoop(), Vehicle::NeedsServicing(), NetworkServerSetCompanyPassword(), NPFFindSafeTile(), NPFSaveTargetData(), LandInfoWindow::OnInit(), BuildIndustryWindow::OnInvalidateData(), BuildVehicleWindow::OnInvalidateData(), CompanyWindow::OnInvalidateData(), HighScoreWindow::OnPaint(), BuildAirportWindow::OnPaint(), BuildDocksStationWindow::OnPaint(), BuildRoadStationWindow::OnPaint(), CompanyWindow::OnPaint(), ScenarioEditorToolbarWindow::OnPaint(), OnTick_LinkGraph(), ScriptInstance::Pause(), PopulateStationsNearby(), SmallMapWindow::RebuildColourIndexIfNecessary(), Station::RecomputeCatchment(), RemoveAirport(), AI::ResetConfig(), RoadVehAccelerationModelChanged(), PATSChunkHandler::Save(), ServerNetworkGameSocketHandler::SendNeedCompanyPassword(), ServerNetworkGameSocketHandler::SendWelcome(), ServerNetworkAdminSocketHandler::SendWelcome(), SetStartingYear(), SetYearEngineAgingStops(), StationViewWindow::ShowCargo(), Vehicle::ShowVisualEffect(), StartupOneEngine(), StateGameLoop_LinkGraphPauseControl(), StationJoinerNeeded(), SubsidyMonthlyLoop(), TerraformTileHeight(), TestAutoslopeOnRailTile(), TGPGetMaxHeight(), ToolbarScenDatePanel(), TownLayoutAllows2x2HouseHere(), TownLayoutAllowsHouseHere(), TryReserveSafeTrack(), AI::Uninitialize(), UpdateAircraftSpeed(), UpdateLandscapingLimits(), Train::UpdateSpeed(), RoadVehicle::UpdateSpeed(), UpdateTownGrowth(), IndustrySpec::UsesOriginalEconomy(), VehicleServiceInDepot(), YapfRoadVehicleChooseTrack(), YapfShipCheckReverse(), YapfShipChooseTrack(), YapfTrainCheckReverse(), YapfTrainChooseTrack(), YapfTrainFindNearestDepot(), YapfTrainFindNearestSafeTile(), and LinkGraphJob::~LinkGraphJob().

## ◆ _settings_newgame

GameSettings _settings_newgame

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

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

Definition at line 54 of file settings.cpp.

Referenced by GetMapHeightLimit(), NetworkCheckRestartMap(), CreateScenarioWindow::OnClick(), GenerateLandscapeWindow::OnDropdownSelect(), CreateScenarioWindow::OnDropdownSelect(), SelectGameWindow::OnInvalidateData(), GenerateLandscapeWindow::OnInvalidateData(), CreateScenarioWindow::OnPaint(), CreateScenarioWindow::OnQueryTextFinished(), AI::ResetConfig(), SetNewLandscapeType(), GenerateLandscapeWindow::SetStringParameters(), CreateScenarioWindow::SetStringParameters(), StartNewGameWithoutGUI(), AI::Uninitialize(), and ValidateSettings().