BaseConfig¶

Teil von type

Quelle: api/tealdef/api/type.d.tl

BaseConfig¶

record global api/tealdef/api/type.d.tl:3481

global record BaseConfig

Zugriff: api.type.BaseConfig

Base configuration of a single game

Felder

Name	Typ	Beschreibung
`animal`	`Animal`	Defines the properties of an animal
`locations`	`Locations`	Platzierung von Städten und Industrien bei der Kartenerstellung.
`settings`	`Settings`	Einstellungen der Grafikqualität (Sichtweiten und LOD-Skalierung je Qualitätsstufe).
`particles`	`Particles`	Partikeltexturen.
`water`	`Water`	Wassertexturen.
`emission`	`Emissions`	Grenzen für Lärm und Verschmutzung und Lärmeinstellungen der Städte. Lies sie mit `api.res.getBaseConfig().emission`.
`scaffold`	`{string : {string : {string}}}`	Modelle für Baustellen je Epoche, als Map von der Epoche zu einer Map vom Teil (`scaffold`, `crane`) zu einer Liste von `.mdl`-Dateien.
`costs`	`{string : number}`	Benannte Kostenwerte und Kostenfaktoren, als Map vom Schlüssel zu einer Zahl.
`advancedOptions`	`AdvancedOptions`	Erweiterte Spieloptionen (Wirkung der Wartung, Subventionen, Ressourcen für Wahrzeichen, Wiederaufforstung).
`economy`	`Economy`	Einnahmeskripte für Güter und Passagiere sowie Einstellungen zur Entwicklung von Städten und Industrien.
`terrain`	`Terrain`	Alte Einstellungen für das Geländemesh (veraltet).
`environment`	`ResName`	Ressourcenname der Umgebung (siehe `api.res.environmentRep`).
`economyId`	`ResName`	Ressourcenname der gewählten Wirtschaft (`.eco`). Das Basisspiel setzt ihn aus dem Eintrag `economy` der Spieleinstellungen.
`nameId`	`ResName`	Ressourcenname der gewählten Namensliste. Das Basisspiel setzt ihn aus dem Eintrag `nameList` der Spieleinstellungen.
`climate`	`ResName`	Ressourcenname des gewählten Klimas (`.clima`), z. B. `::/climates/temperate/temperate.clima`. Das Basisspiel setzt ihn aus dem Eintrag `climate` der Spieleinstellungen.
`trackCatenaryYearFrom`	`integer`	Jahr, ab dem die Elektrifizierung von Gleisen (Oberleitung) verfügbar ist (Basisspiel 1921).
`busLaneYearFrom`	`integer`	Jahr, ab dem Busspuren verfügbar sind (Basisspiel 1925).
`terrainToolMinStrength`	`number`	Minimale Stärke des Geländewerkzeugs (Basisspiel 5).
`terrainToolMaxStrength`	`number`	Maximale Stärke des Geländewerkzeugs (Basisspiel 100).
`enforceMainConnections`	`boolean`	Ob das Spiel prüft, ob Hauptverbindungen unterbrochen sind, und den Spieler dann warnt. So beschreibt es das Wiki (Basisspiel `true`).
`townDevelopInterval`	`number`	Abstand zwischen zwei Entwicklungsschritten der Städte (Basisspiel 60).
`chargeMaintenanceInterval`	`number`	Abstand, in dem Wartungskosten abgebucht werden (Basisspiel 60).
`simulateCargoWeight`	`boolean`	Ob das Gewicht der transportierten Güter simuliert wird (Basisspiel `true`).
`simPersonDestinationRecomputationProbability`	`number`	Wahrscheinlichkeit, mit der eine simulierte Person ihr Ziel neu berechnet (Basisspiel 1,0).
`townMajorStreetAngleRange`	`number`	Winkelbereich in Grad, in dem die Richtungen der Hauptstraßen einer Stadt zufällig gewählt werden (Basisspiel 0).
`townConnectionMaxBridgeLength`	`number`	Städte werden nur dann über Brücken verbunden, wenn der Abstand unter diesem Wert liegt (Basisspiel 250).
`maxVehicleCloneAmount`	`number`	Höchstzahl an Fahrzeugen, die auf einmal geklont werden können. Laut Wiki nutzt nur die Konsolenausgabe den Wert (Basisspiel 50).
`trainAccelerationFactor`	`number`	Faktor für die Beschleunigung von Zügen (Basisspiel 1,0).
`trainBrakeDeceleration`	`number`	Globale Bremsverzögerung von Zügen. Das Wiki nennt 2,5 als Standard und sagt, dass Züge mit kleineren Werten langsamer bremsen.
`terrainToolMinSize`	`number`	Minimale Pinselgröße des Geländewerkzeugs.
`terrainToolMaxSize`	`number`	Maximale Pinselgröße des Geländewerkzeugs im Spiel. Eine Größeneinheit deckt 4 m² ab (Basisspiel 32).
`terrainToolScale`	`number`	Faktor für die Pinselgrößen des Geländewerkzeugs, wenn sie im Baumenü aufgelistet werden.
`terrainToolMaxSizeEditor`	`number`	Maximale Pinselgröße des Geländewerkzeugs im Karten-Editor. Eine Größeneinheit deckt 4 m² ab (Basisspiel 256).
`terrainPainterMinSize`	`number`	Minimale Pinselgröße der Geländebemalung. Die GUI des Spiels nimmt den Wert auch als Minimum für das Geländewerkzeug.
`terrainPainterMaxSize`	`number`	Maximale Pinselgröße der Geländebemalung im Spiel. Eine Größeneinheit deckt 1 m² ab (Basisspiel 256).
`terrainPainterMaxSizeEditor`	`number`	Maximale Pinselgröße der Geländebemalung im Karten-Editor. Eine Größeneinheit deckt 1 m² ab (Basisspiel 256).
`terrainPainterScale`	`number`	Faktor für die Pinselgrößen der Geländebemalung.
`assetBrushMinSize`	`number`	Minimale Pinselgröße der Asset-Werkzeuge (Platzieren und Entfernen von Assets und Vegetation).
`assetBrushMaxSize`	`number`	Maximale Pinselgröße der Asset-Werkzeuge. Eine Größeneinheit deckt 1 m² ab (Basisspiel 256).
`assetBrushScale`	`number`	Faktor für die Pinselgrößen der Assets, wenn sie im Baumenü aufgelistet werden.
`treeCostYearMultipliers`	`{integer : number}`	Kostenfaktoren für Bäume nach Jahr, als Map vom Jahr zum Faktor. Die GUI wertet sie mit `api.engine.util.construction.getCostMultiplierForYear` aus.
`townInitialMajorStreetAngleRange`	`number`	Wie `townMajorStreetAngleRange` (Grad), gilt aber nur, wenn eine Stadt neu entsteht (Basisspiel 0).
`townCapacityScalingFactor`	`number`	Skalierungsfaktor für die Kapazität, den der Stadtbauer (`townBuilder.capacityScalingFactor`) beim Platzieren einer Stadt bekommt.
`sandboxMode`	`boolean`	Ob der Sandkastenmodus aktiv ist. Der Mod `urbangames_sandbox` setzt ihn auf `true`.
`noCosts`	`boolean`	Ob Bauen und Kaufen kostenlos ist. Der Mod `urbangames_no_costs` setzt es auf `true`.
`constructionScript`	`ScriptRef`	Skript, das Konstruktionen aus ihren Modulen baut.

BaseConfig.AdvancedOptions¶

record api/tealdef/api/type.d.tl:3483

record AdvancedOptions

Zugriff: api.type.BaseConfig.AdvancedOptions

Advanced gameplay option

Im Basisspiel verwendet: 3-mal in 2 Dateien

base/content/game_mechanics/game_mechanics/towns/town_util.tl:450

local advancedOptions : BaseConfig.AdvancedOptions = api.res.getBaseConfig().advancedOptions

base/content/game_mechanics/game_mechanics/towns/town_util_parallel.script.tl:33

local advancedOptions : BaseConfig.AdvancedOptions = api.res.getBaseConfig().advancedOptions

Felder

Name	Typ	Beschreibung
`trafficSpeedSensitivityScale`	`number`	Wie stark die Verkehrsbewertung der Städte auf die Verkehrsgeschwindigkeit reagiert. Wird an `api.engine.util.town.computeTownsTrafficSpeedMap` übergeben. Das Basisspiel setzt `1.0`.
`vehicleMaintenanceEmissionsEffect`	`number`	Wie stark die Fahrzeugwartung auf die Emissionen wirkt. Das Basisspiel setzt den Wert aus der Spieleinstellung für die Wirkung der Fahrzeugwartung (`0` bis `2`).
`vehicleMaintenancePerformanceEffect`	`number`	Wie stark die Fahrzeugwartung auf die Leistung wirkt. Das Basisspiel setzt den Wert aus der Spieleinstellung für die Wirkung der Fahrzeugwartung (`0` bis `2`).
`vehicleMaintenanceRunningCostsEffect`	`number`	Wie stark die Fahrzeugwartung auf die Betriebskosten wirkt. Das Basisspiel setzt den Wert aus der Spieleinstellung für die Wirkung der Fahrzeugwartung (`0` bis `2`).
`missionVehicleMaintenanceDisableRepair`	`boolean`	Schaltet die Reparatur von Fahrzeugen ab. Kampagnenmissionen setzen es.
`missionDisableTunnelBuilding`	`boolean`	Schaltet den Tunnelbau ab. Kampagnenmissionen setzen es.
`missionEmissionsScriptFactor`	`number`	Faktor auf die Lärm- und Verschmutzungsleistung, die das Emissionsskript an Entitäten setzt.
`simPersonHappinessDecayAtVehicle`	`number`	Wie schnell die Zufriedenheit von Sim-Personen im Fahrzeug sinkt. Kampagnenmissionen skalieren den Wert.
`simPersonHappinessDecayAtTerminal`	`number`	Wie schnell die Zufriedenheit von Sim-Personen beim Warten an einem Terminal sinkt. Kampagnenmissionen skalieren den Wert.
`subventionMode`	`integer`	Wie oft Subventionsangebote erscheinen. `0` schaltet sie ab.
`subventionRisk`	`integer`	Risikostufe der Subventionsangebote, von `0` bis `3`.
`subventionFinancialRewardMultiplier`	`number`	Multiplier for the financial reward of subsidies (subventions)
`landmarkResources`	`number`	Faktor für die Ressourcenmengen, die Wahrzeichen brauchen (`0`, `0.5`, `1`, `2` oder `4` je nach Spieleinstellung).
`isReforestationActive`	`boolean`	Ob die Wiederaufforstung aktiv ist. Im Karten-Editor schaltet das Basisspiel sie ab.

BaseConfig.Animal¶

record api/tealdef/api/type.d.tl:3505

record Animal

Zugriff: api.type.BaseConfig.Animal

Configuration for animal spawning

Felder

Name	Typ	Beschreibung
`populationDensityMultiplier`	`number`	Multiply the density (in square exemplars per square km) by this factor for all animals
`useLocalSpawning`	`boolean`	Spawning only looks at the existing population within localTileSize squared boxes instead of the entire map (results in density more similarly distributed to the actual scoring functions)
`localTileSize`	`number`	Size used for controlling local spawning
`notifyAnimalDespawn`	`boolean`	Add notification when a named animal despawns

Funktionen

new() : Animal api/tealdef/api/type.d.tl:3507

Aufruf: api.type.BaseConfig.Animal.new(…)

Creates a new object of type Animal

Rückgabe Animal

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/base/base/mod.script.tl:138

baseConfig.animal = fromTable(api.type.BaseConfig.Animal.new(), {

BaseConfig.Locations¶

record api/tealdef/api/type.d.tl:3521

record Locations

Zugriff: api.type.BaseConfig.Locations

Configuration for the placement of industry and towns on max generation

Im Basisspiel verwendet: 4-mal in 2 Dateien

base/content/gui/gui/map_editor/map_editor.tl:498

locations : BaseConfig.Locations

base/content/gui/gui/menu/new_game_or_map_settings_page.tl:385

locationsConfig : BaseConfig.Locations

Felder

Name	Typ	Beschreibung
`town`	`TownParamList`	Configuration for town spawning at map generation
`industry`	`IndustryParamList`	Configuration for industry spawning at map generation
`makeInitialStreets`	`boolean`	Add small streets at the edge of industries

Funktionen

new() : Locations api/tealdef/api/type.d.tl:3523

Aufruf: api.type.BaseConfig.Locations.new(…)

Creates a new object of type Locations

Rückgabe Locations

Im Basisspiel verwendet: 3-mal in 3 Dateien

base/content/base/base/mod.script.tl:122

baseConfig.locations = fromTable(api.type.BaseConfig.Locations.new(), {

base/content/gui/gui/map_editor/map_editor.tl:2105

local locations = api.type.BaseConfig.Locations.new()

base/content/gui/gui/menu/new_game_or_map_settings_page.tl:402

local locations = api.type.BaseConfig.Locations.new()

BaseConfig.Locations.IndustryParamList¶

record api/tealdef/api/type.d.tl:3526

record IndustryParamList

Zugriff: api.type.BaseConfig.Locations.IndustryParamList

Configuration parameters for industries

Felder

Name	Typ	Beschreibung
`absoluteMinimum`	`integer`	Spawning will ensure at least this number of industries is present on the map
`maxNumberPerArea`	`number`	Spawning will ensure that the density per square km will not exceed this number
`industryDensity`	`number`	Spawning will try to spawn this number of industries
`randomSize`	`boolean`	Productivity will be randomized slightly to induce more variation
`industryProductivity`	`number`	Scale the industry productivity by this factor

Funktionen

new() : IndustryParamList api/tealdef/api/type.d.tl:3528

Aufruf: api.type.BaseConfig.Locations.IndustryParamList.new(…)

Creates a new object of type IndustryParamList

Rückgabe IndustryParamList

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/base/base/mod.script.tl:128

industry = fromTable(api.type.BaseConfig.Locations.IndustryParamList.new(),{

BaseConfig.Locations.TownParamList¶

record api/tealdef/api/type.d.tl:3542

record TownParamList

Zugriff: api.type.BaseConfig.Locations.TownParamList

Configuration parameters for towns

Felder

Name	Typ	Beschreibung
`maxNumberPerArea`	`number`	Spawning will ensure at most this density per square km
`allowInRoughTerrain`	`boolean`	Town will be able to spawn in uneven and slightly unsuitable terrain, the resulting town might be smaller than it's target size
`townFrequency`	`number`	Number of towns per sqm
`populationDensity`	`number`	Population will be scaled by this factor

Funktionen

new() : TownParamList api/tealdef/api/type.d.tl:3544

Aufruf: api.type.BaseConfig.Locations.TownParamList.new(…)

Creates a new object of type TownParamList

Rückgabe TownParamList

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/base/base/mod.script.tl:123

town =  fromTable(api.type.BaseConfig.Locations.TownParamList.new(), {

BaseConfig.Terrain¶

record api/tealdef/api/type.d.tl:3567

record Terrain

Zugriff: api.type.BaseConfig.Terrain

Configuration for the terrain mesh (Deprecated)

Felder

Name	Typ	Beschreibung
`lodErrorMultiplier`	`number`	(Deprecated) Only used with legacy terrain, determines the quality of the terrain mesh

BaseConfig.Economy¶

record api/tealdef/api/type.d.tl:3573

record Economy

Zugriff: api.type.BaseConfig.Economy

Configures cargo relations and industry developement for a single game

Felder

Name	Typ	Beschreibung
`cargoIncomeScript`	`ScriptRef`	A script reference controlling the income of a given cargo given specific parameters
`passengerIncomeScript`	`ScriptRef`	A script reference controlling the income of a given passengers given specific parameters
`townDevelopment`	`TownDevelopment`	Controls the automatic development of towns
`industryDevelopment`	`IndustryDevelopment`	Controls the automatic developement of industries

Funktionen

new() : Economy api/tealdef/api/type.d.tl:3575

Aufruf: api.type.BaseConfig.Economy.new(…)

Creates a new empty economy

Rückgabe Economy

BaseConfig.Economy.TownDevelopment¶

record api/tealdef/api/type.d.tl:3578

record TownDevelopment

Zugriff: api.type.BaseConfig.Economy.TownDevelopment

Parameters for the town developement

Felder

Name	Typ	Beschreibung
`cargoNeedsPerTown`	`integer`	Number of initial cargo needs when the town ist first built
`townGrowthMinDistrictFraction`	`number`	The minimum a distric fraction (compared to other disctricts) can shrink

BaseConfig.Economy.IndustryDevelopment¶

record api/tealdef/api/type.d.tl:3585

record IndustryDevelopment

Zugriff: api.type.BaseConfig.Economy.IndustryDevelopment

Parameters for the industry developement

Felder

Name	Typ	Beschreibung
`spawnTargetTimeSpan`	`number`	Unused
`spawnProbabilityExponent`	`number`	Control the frequency at which enw industries appear
`spawnIndustries`	`boolean`	Control whether new industry might spawn on the map
`unusedTimeSpan`	`number`	Control the mean time after which an industry will begin closing after not being used
`closureCountdownTimeSpan`	`number`	Controls the grace period the player has to prevent closure
`closureProbability`	`number`	Controls how likely an unused industry has of being closed
`extendTimeSpan`	`number`	Control how often the industry will build new satellites

BaseConfig.Settings¶

record api/tealdef/api/type.d.tl:3613

record Settings

Zugriff: api.type.BaseConfig.Settings

Graphic settings for main quality modes, camera tool and cockpit

Felder

Name	Typ	Beschreibung
`geometryQualityOptions`	`{GeometryQualityOption}`	Quality settings for:

Funktionen

new() : Settings api/tealdef/api/type.d.tl:3615

Aufruf: api.type.BaseConfig.Settings.new(…)

Creates a new graphic settings parameters

Rückgabe Settings

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/base/base/mod.script.tl:146

baseConfig.settings =  fromTable(api.type.BaseConfig.Settings.new(), {

BaseConfig.Settings.GeometryQualityOption¶

record api/tealdef/api/type.d.tl:3618

record GeometryQualityOption

Zugriff: api.type.BaseConfig.Settings.GeometryQualityOption

Contains information about graphi quality of a single game

Felder

Name	Typ	Beschreibung
`viewNearFar`	`Vec2f`	Distance im meters of near and far plane
`fogStartEndFarPerc`	`Vec2f`	Unused
`lodDistanceScaling`	`number`	A factor multiplying all lod distances

Funktionen

new() : GeometryQualityOption api/tealdef/api/type.d.tl:3620

Aufruf: api.type.BaseConfig.Settings.GeometryQualityOption.new(…)

Creates a new GeometryQualityOption

Rückgabe GeometryQualityOption

Im Basisspiel verwendet: 6-mal in 1 Datei

base/content/base/base/mod.script.tl:148

fromTable(api.type.BaseConfig.Settings.GeometryQualityOption.new(), { viewNearFar = api.type.Vec2f.new(4.0, 7200.0), fogStartEndFarPerc = api.type.Vec2f.new(0.4

BaseConfig.Water¶

record api/tealdef/api/type.d.tl:3634

record Water

Zugriff: api.type.BaseConfig.Water

Configures water look and feel

Felder

Name	Typ	Beschreibung
`textures`	`Textures`	Configures water textures

BaseConfig.Water.Textures¶

record api/tealdef/api/type.d.tl:3636

record Textures

Zugriff: api.type.BaseConfig.Water.Textures

Configures water textures

Felder

Name	Typ	Beschreibung
`foamNormal`	`string`	Normal texture for water foam
`foamDetail`	`string`	Extra detail texture for water foam
`foam`	`string`	Albedo texture for water foam

BaseConfig.Particles¶

record api/tealdef/api/type.d.tl:3650

record Particles

Zugriff: api.type.BaseConfig.Particles

Hinweise

Einstellungen für das Rendern von Partikeln. Enthält die Texturen, die sich Partikeleffekte teilen.

Felder

Name	Typ	Beschreibung
`textures`	`Textures`	Gemeinsame Partikeltexturen.

BaseConfig.Particles.Textures¶

record api/tealdef/api/type.d.tl:3651

record Textures

Zugriff: api.type.BaseConfig.Particles.Textures

Hinweise

Gemeinsame Texturen der Partikeleffekte.

Felder

Name	Typ	Beschreibung
`noise0`	`string`	Erste Rauschtextur für Partikel (Basisspiel: `::/base/tex/particle_noise0.dds`).
`noise1`	`string`	Zweite Rauschtextur für Partikel (Basisspiel: `::/base/tex/particle_noise1.dds`).
`smoke`	`string`	Rauchtextur für Partikel (Basisspiel: `::/base/tex/particle_smoke.dds`).
`smokeNormal`	`string`	Normal Map zur Rauchtextur der Partikel (Basisspiel: `::/base/tex/particle_smoke_normal.dds`).

BaseConfig.Emissions¶

record api/tealdef/api/type.d.tl:3661

record Emissions

Zugriff: api.type.BaseConfig.Emissions

Hinweise

Einstellungen für Lärm und Verschmutzung der Emissionsebenen und dafür, wie Lärm auf Städte wirkt.

Details

Das Basisspiel übernimmt die Grenzen in seiner preRunFn aus /game_mechanics/emission/emission_config.tl (Lärm 63–85 dB, Verschmutzung 57–80). Skripte lesen sie mit api.res.getBaseConfig().emission.

Felder

Name	Typ	Beschreibung
`noiseLowerBoundDB`	`number`	Untere Grenze der Lärmskala in Dezibel und damit das Minimum beim Abtasten und Anzeigen von Lärm (Basisspiel 63).
`noiseUpperBoundDB`	`number`	Obere Grenze der Lärmskala in Dezibel und damit das Maximum beim Abtasten und Anzeigen von Lärm (Basisspiel 85).
`pollutionLowerBoundDB`	`number`	Untere Grenze der Verschmutzungsskala und damit das Minimum beim Abtasten und Anzeigen von Verschmutzung (Basisspiel 57).
`pollutionUpperBoundDB`	`number`	Obere Grenze der Verschmutzungsskala und damit das Maximum beim Abtasten und Anzeigen von Verschmutzung (Basisspiel 80).
`townNoiseResidentialAffected`	`boolean`	Ob Lärm auf Wohngebäude der Städte wirkt. Ist es gesetzt, nimmt `town_util.getNoiseLandUseTypes` `LandUseType.RESIDENTIAL` auf.
`townNoiseCommercialAffected`	`boolean`	Ob Lärm auf Gewerbegebäude der Städte wirkt. Ist es gesetzt, nimmt `town_util.getNoiseLandUseTypes` `LandUseType.COMMERCIAL` auf.
`townNoiseIndustrialAffected`	`boolean`	Ob Lärm auf Industriegebäude der Städte wirkt. Ist es gesetzt, nimmt `town_util.getNoiseLandUseTypes` `LandUseType.INDUSTRIAL` auf.