new_game_react_util¶

Quelle: base/tealdef/gui/menu/new_game_react_util.d.tl

Hinweise

Helfer der Einstellungsseiten „neues Spiel“ und „neue Karte“, geladen mit ug_require "/gui/menu/new_game_react_util.tl".

NewGameReactUtil¶

record global base/tealdef/gui/menu/new_game_react_util.d.tl:3

global record NewGameReactUtil

Laden: local new_game_react_util = ug_require "::/gui/menu/new_game_react_util.tl" as NewGameReactUtil

Hinweise

Helfer zum Aufbau der Einstellungsseiten für ein neues Spiel bzw. eine neue Karte.

Funktionen

makeDefaultBaseModParams() : {string : Index} base/tealdef/gui/menu/new_game_react_util.d.tl:4

Aufruf: new_game_react_util.makeDefaultBaseModParams(…)

Hinweise

Gibt den Standardindex jedes Skriptparameters des Basisspiels zurück (Mod "").

Rückgabe {string : Index}: Parameterschlüssel, die auf den Index ihres Standardwerts zeigen.

makeDefaultConfigDictForClimate(climate : string) : {{string, string}} base/tealdef/gui/menu/new_game_react_util.d.tl:5

Aufruf: new_game_react_util.makeDefaultConfigDictForClimate(…)

Hinweise

Baut das Standard-Config-Dictionary für ein Klima.

Parameter	Typ	Beschreibung
`climate`	`string`	Name der Klima-Ressource.

Rückgabe {{string, string}}: Liste von Paaren {key, value}: climate, economy und nameList (Standardwirtschaft und Standard-Namensliste des Klimas). Leer und mit einem geloggten Fehler, wenn es das Klima nicht gibt.

gatherMapConfig(configDict : {{string, string}}) : MapConfig base/tealdef/gui/menu/new_game_react_util.d.tl:16

Aufruf: new_game_react_util.gatherMapConfig(…)

Hinweise

Sucht das Klima eines Config-Dictionarys und die Geländegeneratoren, die dazu passen.

Parameter	Typ	Beschreibung
`configDict`	`{{string, string}}`	Config-Dictionary (Paare `{key, value}`) mit einem Eintrag `climate`.

Rückgabe MapConfig: Die Klimabeschreibung und die sichtbaren Geländegeneratoren dieses Klimas, die weder nur für den Editor noch Import-Generatoren sind, sortiert nach order.

autoActivateConfigDictMods(activeMods : {string}, initialConfigDict : {{string, string}}) : {string} base/tealdef/gui/menu/new_game_react_util.d.tl:18

Aufruf: new_game_react_util.autoActivateConfigDictMods(…)

Hinweise

Ergänzt eine Liste aktiver Mods um die Mods, auf die Werte des Config-Dictionarys verweisen.

Parameter	Typ	Beschreibung
`activeMods`	`{string}`	Namen der aktiven Mods.
`initialConfigDict`	`{{string, string}}`	Config-Dictionary. Ein Wert der Form `<mod>::...` setzt den Mod `<mod>` voraus.

Rückgabe {string}: Eine Kopie von activeMods mit den benötigten Mods.

prepareState(initialConfigDict : {{string, string}}, possibleGenerators : {NewGameReactUtil.Generator}, initial : integer, autoActivateMods : boolean) : StatesBundle base/tealdef/gui/menu/new_game_react_util.d.tl:26

Aufruf: new_game_react_util.prepareState(…)

Hinweise

Liest die zuletzt genutzten Einstellungen für ein neues Spiel aus der App-Konfiguration (mainMenuState) und ergänzt sie.

Parameter	Typ	Beschreibung
`initialConfigDict`	`{{string, string}}`	Config-Dictionary der Karte. Damit werden die Mods, die sie braucht, automatisch aktiviert.
`possibleGenerators`	`{NewGameReactUtil.Generator}`	Verfügbare Geländegeneratoren. Ist der gespeicherte Generator nicht dabei, wird der letzte genommen.
`initial`	`integer`	Wenn gesetzt, wird ein neuer zufälliger Seed erzeugt.
`autoActivateMods`	`boolean`	Wenn gesetzt (oder wenn `initial` gesetzt ist), werden aktive Mods entfernt, die nicht mehr installiert oder unsichtbar sind. Mods, die das Config-Dictionary braucht oder die mit `autoActivate` markiert sind, kommen hinzu.

Rückgabe StatesBundle: Die Anfangszustände. Fehlende Parameter des Basisspiels bekommen ihren Standardindex.

searchBuildAndAddScriptParamComp(settings : {NewGameReactUtil.SettingsEntry}, activeModsParamsState : ReactStateT<{string : {string : integer}}>, key : string, addSpacer? : boolean, filterTags? : {string}, otherKeysToSet? : {string}) : TreeNodeId base/tealdef/gui/menu/new_game_react_util.d.tl:41

Aufruf: new_game_react_util.searchBuildAndAddScriptParamComp(…)

Hinweise

Baut das Steuerelement für einen Skriptparameter des Basisspiels und hängt es an settings an.

Parameter	Typ	Beschreibung
`settings`	`{NewGameReactUtil.SettingsEntry}`	Liste, an die der Eintrag angehängt wird.
`activeModsParamsState`	`ReactStateT<{string : {string : integer}}>`	Parameterzustand. Gelesen und geschrieben werden die Werte des Basisspiels (`[""]`).
`key`	`string`	Schlüssel des Skriptparameters, zum Beispiel `"map.size"`.
`addSpacer?`	`boolean`	Ob das Steuerelement einen Abstandhalter bekommt.
`filterTags?`	`{string}`	Tags, mit denen die plattformspezifische Variante des Parameters gewählt wird (siehe `getFilterTags`).
`otherKeysToSet?`	`{string}`	Weitere Parameterschlüssel, die auf denselben Werteindex gesetzt werden.

Rückgabe TreeNodeId

Details

Wird der Parameter nicht gefunden, kommt nichts hinzu.

addNamesSettingsEntry(settings : {NewGameReactUtil.SettingsEntry}, configDictState : ReactStateT<{{string, string}}>) base/tealdef/gui/menu/new_game_react_util.d.tl:48

Aufruf: new_game_react_util.addNamesSettingsEntry(…)

Hinweise

Fügt die Einstellung „Names“ hinzu, eine Combobox mit allen Namenslisten. Sie setzt den Eintrag nameList des Config-Dictionarys.

Im Spiel Namen · Ändere die Region, aus der die Namen von Städten, Strassen und Einwohnern stammen sollen.Im Code: Names · Change the region from which the names of towns, roads and residents should originate.

addStartYearSettingsEntry(settings : {NewGameReactUtil.SettingsEntry}, mapState : ReactStateT<GameMap>, mapParamsState : ReactStateT<NewGameReactUtil.NewGameState>) base/tealdef/gui/menu/new_game_react_util.d.tl:50

Aufruf: new_game_react_util.addStartYearSettingsEntry(…)

Hinweise

Fügt den Schieberegler „Start Year“ hinzu, der startYearIndex der Kartenparameter setzt.

Im Spiel Startjahr · Das Startjahr beeinflusst das Erscheinungsbild der Städte und die verfügbaren Fahrzeuge.Im Code: Start Year · The start year affects the appearance of towns and which vehicles are available.

Details

Ein geändertes Startjahr setzt die Kartenvorschau nicht zurück.

addTutorialSettingsEntry(settings : {NewGameReactUtil.SettingsEntry}, activeModsParamsState : ReactStateT<{string : {string : integer}}>, filterTags : {string}) base/tealdef/gui/menu/new_game_react_util.d.tl:51

Aufruf: new_game_react_util.addTutorialSettingsEntry(…)

Hinweise

Fügt das Steuerelement für den Skriptparameter guideSystemConfig.tutorial hinzu.

addSeedSettingsEntry(settings : {NewGameReactUtil.SettingsEntry}, mapState : ReactStateT<GameMap>, mapParamsState : ReactStateT<NewGameReactUtil.NewGameState>) base/tealdef/gui/menu/new_game_react_util.d.tl:53

Aufruf: new_game_react_util.addSeedSettingsEntry(…)

Hinweise

Fügt das Textfeld „Seed“ mit einem Button hinzu, der einen zufälligen Seed erzeugt.

Im Spiel Zufallswert · Ändere den Startwert, um völlig unterschiedliche Karten zu generieren.Im Code: Seed · Change the random seed to generate completely different maps.

Details

Ein geänderter Seed setzt mapState auf nil, die Kartenvorschau wird also neu erzeugt.

addMapSizeSettingsEntry(settings : {NewGameReactUtil.SettingsEntry}, activeModsParamsState : ReactStateT<{string : {string : integer}}>, filterTags? : {string}) base/tealdef/gui/menu/new_game_react_util.d.tl:54

Aufruf: new_game_react_util.addMapSizeSettingsEntry(…)

Hinweise

Fügt das Steuerelement für den Skriptparameter map.size hinzu.

addMapFormatSettingsEntry(settings : {NewGameReactUtil.SettingsEntry}, activeModsParamsState : ReactStateT<{string : {string : integer}}>, filterTags? : {string}) base/tealdef/gui/menu/new_game_react_util.d.tl:55

Aufruf: new_game_react_util.addMapFormatSettingsEntry(…)

Hinweise

Fügt das Steuerelement für den Skriptparameter map.format hinzu.

addInitialWeatherSettingsEntry(settings : {NewGameReactUtil.SettingsEntry}, activeModsParamsState : ReactStateT<{string : {string : integer}}>, filterTags? : {string}) base/tealdef/gui/menu/new_game_react_util.d.tl:57

Aufruf: new_game_react_util.addInitialWeatherSettingsEntry(…)

Hinweise

Fügt das Steuerelement für den Skriptparameter weatherConfig.dynamicWeather hinzu.

addInitialTimeOfDaySettingsEntry(settings : {NewGameReactUtil.SettingsEntry}, activeModsParamsState : ReactStateT<{string : {string : integer}}>, filterTags? : {string}) base/tealdef/gui/menu/new_game_react_util.d.tl:58

Aufruf: new_game_react_util.addInitialTimeOfDaySettingsEntry(…)

Hinweise

Fügt das Steuerelement für den Skriptparameter gameTimeConfig.timeOfDayMode hinzu.

addGeneratorSettingsEntry(settings : {NewGameReactUtil.SettingsEntry}, possibleGenerators : {NewGameReactUtil.Generator}, mapState : ReactStateT<GameMap>, mapParamsState : ReactStateT<NewGameReactUtil.NewGameState>) base/tealdef/gui/menu/new_game_react_util.d.tl:60

Aufruf: new_game_react_util.addGeneratorSettingsEntry(…)

Hinweise

Fügt die Combobox „Generator“ zur Wahl des Geländegenerators hinzu. Gibt es nur einen Generator, kommt nichts hinzu.

Im Spiel Generator · Wähle den Generator zur Erstellung des Geländes.Im Code: Generator · This setting controls which generator is used to generate the terrain.

Details

Ein geänderter Generator setzt mapState auf nil, die Kartenvorschau wird also neu erzeugt.

addTerrainParameterSettingsEntry(settings : {NewGameReactUtil.SettingsEntry}, mapState : ReactStateT<GameMap>, mapParamsState : ReactStateT<NewGameReactUtil.NewGameState>, mapGenParamsState : ReactStateT<{string : integer}>) base/tealdef/gui/menu/new_game_react_util.d.tl:65

Aufruf: new_game_react_util.addTerrainParameterSettingsEntry(…)

Hinweise

Fügt ein Steuerelement pro Parameter des gewählten Geländegenerators hinzu. Die Werte landen in mapGenParamsState.

Details

Ein geänderter Wert setzt mapState auf nil, die Kartenvorschau wird also neu erzeugt.

getYearValues() : {integer} base/tealdef/gui/menu/new_game_react_util.d.tl:70

Aufruf: new_game_react_util.getYearValues(…)

Hinweise

Gibt die wählbaren Startjahre zurück.

Rückgabe {integer}: Die Jahre 1900 bis 2020 in Zehnerschritten.

getYearScriptParam() : ScriptParam base/tealdef/gui/menu/new_game_react_util.d.tl:71

Aufruf: new_game_react_util.getYearScriptParam(…)

Hinweise

Gibt den Skriptparameter für den Schieberegler des Startjahrs zurück.

Im Spiel StartjahrIm Code: Start Year

Rückgabe ScriptParam: Ein Schieberegler-Parameter mit dem Schlüssel startYear, den Werten "1900" bis "2020" in Zehnerschritten und dem Standardindex 1.

getInitialTimeOfDayValues() : {integer} base/tealdef/gui/menu/new_game_react_util.d.tl:73

Aufruf: new_game_react_util.getInitialTimeOfDayValues(…)

Hinweise

Start-Tageszeit für jeden Wert des Parameters gameTimeConfig.timeOfDayMode.

Rückgabe {integer}: Sekunden seit Mitternacht, indiziert wie die Parameterwerte.

getInitialCloudCoverageValues() : {number} base/tealdef/gui/menu/new_game_react_util.d.tl:74

Aufruf: new_game_react_util.getInitialCloudCoverageValues(…)

Hinweise

Anfängliche Bewölkung für jeden Wert des Parameters weatherConfig.dynamicWeather.

Rückgabe {number}: Bewölkung von 0 bis 1, indiziert wie die Parameterwerte.

calculateSeedString(maxLen : integer) : string base/tealdef/gui/menu/new_game_react_util.d.tl:76

Aufruf: new_game_react_util.calculateSeedString(…)

Hinweise

Erzeugt einen zufälligen Seed aus Buchstaben und Ziffern.

Parameter	Typ	Beschreibung
`maxLen`	`integer`	Höchstlänge. Das Basisspiel übergibt 10, was einen Seed mit 10 Zeichen ergibt.

Rückgabe string

Im Basisspiel verwendet: 3-mal in 1 Datei

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

setSeed(new_game_react_util.calculateSeedString(10))

getFilterTags() : {string} base/tealdef/gui/menu/new_game_react_util.d.tl:78

Aufruf: new_game_react_util.getFilterTags(…)

Hinweise

Gibt die Tags zurück, mit denen die Varianten der Skriptparameter für die aktuelle Plattform gewählt werden.

Rückgabe {string}: Die Tags von getPlatformFilterTags, dazu "experimentalMapFeatures", wenn diese Option der App-Konfiguration aktiv ist.

Im Basisspiel verwendet: 2-mal in 1 Datei

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

local filterTags = new_game_react_util.getFilterTags()

getPlatformFilterTags() : {string} base/tealdef/gui/menu/new_game_react_util.d.tl:79

Aufruf: new_game_react_util.getPlatformFilterTags(…)

Hinweise

Gibt das Plattform-Tag für die Varianten der Skriptparameter zurück.

Rückgabe {string}: {"console"} auf Konsolen, {"desktop"} auf dem Desktop.

findConfigDictIndex<K, V>(dict : {{K, V}}, key : K) : integer base/tealdef/gui/menu/new_game_react_util.d.tl:81

Aufruf: new_game_react_util.findConfigDictIndex(…)

Hinweise

Sucht die Position eines Schlüssels in einem Config-Dictionary (einer Liste von Paaren {key, value}).

Rückgabe integer: Den Index des Paars, oder 0, wenn der Schlüssel fehlt.

NewGameReactUtil.Generator¶

record base/tealdef/gui/menu/new_game_react_util.d.tl:7

record Generator

Hinweise

Ein Geländegenerator, der für eine neue Karte angeboten wird.

Im Basisspiel verwendet: 10-mal in 2 Dateien

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

possibleGenerators : {NewGameReactUtil.Generator},

base/content/gui/gui/menu/new_game_react_util.tl:82

new_game_react_util.prepareState = function(initialConfigDict : {{string, string}}, possibleGenerators : {NewGameReactUtil.Generator},

Felder

Name	Typ	Beschreibung
`name`	`string`	Ressourcenname des Geländegenerators.
`order`	`integer`	Sortierreihenfolge aus der Definition des Generators.

NewGameReactUtil.MapConfig¶

record base/tealdef/gui/menu/new_game_react_util.d.tl:12

record MapConfig

Hinweise

Ergebnis von gatherMapConfig.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/menu/new_game_react_util.tl:203

new_game_react_util.gatherMapConfig = function(configDict : {{string, string}}) : NewGameReactUtil.MapConfig

Felder

Name	Typ	Beschreibung
`possibleGenerators`	`{Generator}`	Geländegeneratoren, die für das Klima verfügbar sind, nach `order` sortiert.
`climateDesc`	`ClimateDesc`	Beschreibung des gewählten Klimas.

NewGameReactUtil.StatesBundle¶

record base/tealdef/gui/menu/new_game_react_util.d.tl:20

record StatesBundle

Hinweise

Anfangswerte der Zustände auf der Seite für ein neues Spiel, geliefert von prepareState.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/menu/new_game_react_util.tl:83

initial : integer, autoActivateMods : boolean) : NewGameReactUtil.StatesBundle

Felder

Name	Typ	Beschreibung
`mapParamsState`	`NewGameReactUtil.NewGameState`	Startjahr, Geländegenerator und Seed.
`mapGenParamsState`	`{string : integer}`	Gewählter Werteindex pro Parameterschlüssel des Geländegenerators.
`activeModsState`	`{string}`	Namen der aktiven Mods.
`activeModsParamsState`	`{string : {string : integer}}`	Gewählter Werteindex pro Skriptparameterschlüssel, pro Mod-Name (`""` ist das Basisspiel).

NewGameReactUtil.NewGameState¶

record base/tealdef/gui/menu/new_game_react_util.d.tl:28

record NewGameState

Hinweise

Grundeinstellungen einer neuen Karte, in der App-Konfiguration als mainMenuState.newGameState gespeichert.

Im Basisspiel verwendet: 13-mal in 2 Dateien

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

mapParamsState : ReactStateT<NewGameReactUtil.NewGameState>,

base/content/gui/gui/menu/new_game_react_util.tl:84

local readAndPatchState = function() : NewGameReactUtil.NewGameState

Felder

Name	Typ	Beschreibung
`startYearIndex`	`integer`	Index in `getYearValues()`.
`terrainGenerator`	`string`	Ressourcenname des gewählten Geländegenerators.
`seed`	`string`	Seed-String für den Kartengenerator.

NewGameReactUtil.SettingsEntry¶

record base/tealdef/gui/menu/new_game_react_util.d.tl:34

record SettingsEntry

Hinweise

Eine Zeile der Einstellungsliste auf der Seite für ein neues Spiel.

Im Basisspiel verwendet: 25-mal in 2 Dateien

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

settings : {NewGameReactUtil.SettingsEntry}

base/content/gui/gui/menu/new_game_react_util.tl:276

settings : {NewGameReactUtil.SettingsEntry},

Felder

Name	Typ	Beschreibung
`title`	`string`	Titel der Einstellung.
`description`	`string`	Beschreibung, die im Hinweisfeld erscheint, wenn die Zeile überfahren wird oder den Fokus hat.
`hintIdKey`	`string`	Schlüssel, der die Zeile mit ihrem Hinweis verbindet. Die Helfer nutzen `"hintIdKey" .. title`.
`element`	`TreeNodeId`	Das Steuerelement der Einstellung.