savegame_react_util¶

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

Hinweise

Spielstand-Helfer und Recipes der Seiten zum Laden, Speichern und für ein neues Spiel, geladen mit ug_require "/gui/menu/savegame_react_util.tl".

SavegameReactUtil¶

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

global record SavegameReactUtil

Laden: local savegame_react_util = ug_require "::/gui/menu/savegame_react_util.tl" as SavegameReactUtil

Hinweise

Spielstand-Helfer und Recipes für die Seiten des Hauptmenüs und des Pausenmenüs.

Felder

Name	Typ	Beschreibung
`SavegameCard`	`Recipe<SavegameCardParams>`	Kachel für eine Spielstandgruppe mit Screenshot, Speicherdatum und Info-Icons, dazu ein Laden-Button, sofern `save` nicht gesetzt ist.Im Spiel Spiel laden · Speicherdatum · Erforderliche Mods oder DLCs fehlen.Im Code: Load Game · Date Saved · Required mods or DLCs are missing. 4-mal im Basisspiel verwendet
`SavegameFilters`	`Recipe<SavegameFiltersParam>`	Textfeld zum Filtern und Combobox für die Sortierart in Spielstandlisten.Im Spiel Spielstände filtern ... · Name · DatumIm Code: Filter Savegames... · Name · Date 2-mal im Basisspiel verwendet
`SavegameSelectCard`	`Recipe<SavegameCardSelectParams>`	Detailansicht einer Spielstandgruppe auf der Laden-Seite mit den Spielständen der Gruppe, ihren Details, Buttons zum Laden, Teilen und Löschen sowie Tabs für Spieleinstellungen und Mods.Im Spiel Spiel laden · Spielstand löschen · Der Spielstand geht dauerhaft verloren.Im Code: Load Game · Delete Savegame · The savegame will be lost permanently. 1-mal im Basisspiel verwendet
`SavegameStorageBar`	`Recipe0`	Fortschrittsbalken mit dem belegten und dem gesamten Speicherplatz für Spielstände in MB.Im Spiel SpielspeicherIm Code: Game Storage 2-mal im Basisspiel verwendet
`LoadPreview`	`Recipe<LoadPreviewParam>`	Bild eines Spielstands (aus `app.getSavegameImage` oder der Screenshot in den Spielstanddaten) oder ein Lade- bzw. Fehlerbild. 1-mal im Basisspiel verwendet
`ScrollableAchievementsList`	`Recipe<ScrollableAchievementsListParams>`	Scrollbare Liste aller Erfolge mit Freischaltstatus und Fortschritt.Im Spiel FertigIm Code: Done 2-mal im Basisspiel verwendet

Funktionen

makeModIdList({string}) : {Mod.ModId} base/tealdef/gui/menu/savegame_react_util.d.tl:48

Aufruf: savegame_react_util.makeModIdList(…)

Hinweise

Wandelt Mod-Namen in Mod-Ids um.

Rückgabe {Mod.ModId}: Eine Mod.ModId pro Name.

Im Basisspiel verwendet: 4-mal in 1 Datei

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

local modIdList = savegame_react_util.makeModIdList(activeModsState:old())

makeModStringList({Mod.ModId}) : {string} base/tealdef/gui/menu/savegame_react_util.d.tl:49

Aufruf: savegame_react_util.makeModStringList(…)

Hinweise

Wandelt Mod-Ids in Mod-Namen um.

Rückgabe {string}: Den name jeder Mod-Id.

groupSaves(savegames : {SaveGameInfo}, filter : string, prefix : string, sortMode? : SavegameFiltersParam.SortMode, ascending? : boolean, saveTypeFilter? : SaveGameType) : {SaveGroup} base/tealdef/gui/menu/savegame_react_util.d.tl:50

Aufruf: savegame_react_util.groupSaves(…)

Hinweise

Gruppiert Spielstände nach ihrem Gruppennamen und sortiert die Gruppen.

Parameter	Typ	Beschreibung
`savegames`	`{SaveGameInfo}`	Zu gruppierende Spielstände, zum Beispiel aus `app.findAllSavegames(namespace)`.
`filter`	`string`	Wenn gesetzt, kommen nur Spielstände hinein, deren Name diesen Text enthält.
`prefix`	`string`	Wird als `groupName.prefix` jeder Gruppe gespeichert. Das Basisspiel nutzt `"!"` für normale und `"?"` für eingebaute Spielstände.
`sortMode?`	`SavegameFiltersParam.SortMode`	`"Name"` sortiert nach Gruppenname, sonst wird nach dem Zeitpunkt des neuesten Spielstands sortiert.
`ascending?`	`boolean`	Richtung der Sortierung.
`saveTypeFilter?`	`SaveGameType`	Wenn gesetzt, kommen nur Spielstände dieses Typs hinein.

Rückgabe {SaveGroup}: Die Gruppen. Innerhalb einer Gruppe stehen die Spielstände neueste zuerst. mostRecent ist der neueste manuelle Spielstand oder, wenn es keinen manuellen gibt, der neueste überhaupt.

Im Basisspiel verwendet: 5-mal in 3 Dateien

base/content/gui/gui/menu/load_game_page.tl:34

return savegame_react_util.groupSaves(app.findAllSavegames(saveGameNamespace), filterText, "!", sortMode, ascending)

base/content/gui/gui/menu/new_game_page.tl:25

local saveGroups = savegame_react_util.groupSaves(app.findAllSavegames(app.SaveGameNamespace.getSavemap()), "", "!", "Date", false)

base/content/gui/gui/menu/save_game_page.tl:163

return savegame_react_util.groupSaves(app.findAllSavegames(savegameNameSpace), filterText, "!", sortMode, ascending, api.type["enum"].SaveGameType.Manual)

getSaveGroupAndType(saveName : string) : string, SaveGameType, string, string base/tealdef/gui/menu/savegame_react_util.d.tl:51

Aufruf: savegame_react_util.getSaveGroupAndType(…)

group, type, ingame date, file timestamp

Hinweise

Zerlegt einen Spielstandnamen mit app.parseSavegameName.

Rückgabe string, SaveGameType, string, string: Gruppenname, Spielstandtyp, Datum im Spiel und Zeitstempel der Datei.

Im Basisspiel verwendet: 3-mal in 3 Dateien

base/content/gui/gui/menu/main_page.tl:411

local continueTitle = continueState:old().lastSaveGameId and savegame_react_util.getSaveGroupAndType(continueState:old().lastSaveGameId.saveGameName) or ""

base/content/gui/gui/menu/new_game_page.tl:135

local __, savetype = savegame_react_util.getSaveGroupAndType(group.mostRecent.saveName)

base/content/gui/gui/menu/progress_page.tl:54

title = savegame_react_util.getSaveGroupAndType(progressDataState:old().saveGameId.saveGameName)

checkForError(savegameData : SaveGameData) : {ErrorType}, string base/tealdef/gui/menu/savegame_react_util.d.tl:58

Aufruf: savegame_react_util.checkForError(…)

Hinweise

Prüft, ob sich ein Spielstand laden lässt.

Im Spiel Erforderliche Mods oder DLCs fehlen. · Die Kartengrösse bzw. das Kartenformat wird nicht unterstützt. · Der Spielstand konnte nicht geladen werden.Im Code: Required mods or DLCs are missing. · Map size or map format is not supported. · The savegame could not be loaded.

Parameter	Typ	Beschreibung
`savegameData`	`SaveGameData`	Spielstanddaten aus `app.getSavegameInfo`.

Rückgabe {ErrorType}, string: Die Liste der Fehler (leer, wenn keine) und einen übersetzten Fehlertext.

Im Basisspiel verwendet: 2-mal in 1 Datei

base/content/gui/gui/menu/main_page.tl:368

errorTypes, errorMsg = savegame_react_util.checkForError(dataContinueState:old())

getCampaignInfoSorted(campaign : ResName) : CampaignInfo base/tealdef/gui/menu/savegame_react_util.d.tl:86

Aufruf: savegame_react_util.getCampaignInfoSorted(…)

Hinweise

Sammelt die Missionen einer Kampagne, nach Reihenfolge sortiert und mit ihrer Verfügbarkeit, die sich aus den abgeschlossenen Missionen ergibt.

Parameter	Typ	Beschreibung
`campaign`	`ResName`	Ressourcenname der Kampagne.

Rückgabe CampaignInfo: Die Kampagneninfo, oder nil, wenn die Kampagne nicht gefunden wird.

Im Basisspiel verwendet: 3-mal in 2 Dateien

base/content/gui/gui/menu/campaign_page.tl:171

local campaignInfo = savegame_react_util.getCampaignInfoSorted(campaign)

base/content/gui/gui/menu/main_page.tl:434

local campaignInfo = savegame_react_util.getCampaignInfoSorted(continueState:old().recentCampaign.campaign)

SavegameReactUtil.SavegameCardParams¶

record base/tealdef/gui/menu/savegame_react_util.d.tl:4

record SavegameCardParams

Hinweise

Parameter von SavegameCard.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/menu/savegame_react_util.tl:244

savegame_react_util.SavegameCard = react.RegisterRecipe("SavegameCard", function(savegameCardParams : SavegameReactUtil.SavegameCardParams) : TreeNodeId

Felder

Name	Typ	Beschreibung
`saveGame`	`SaveGroup`	Spielstandgruppe, die die Kachel zeigt. Ihr neuester Spielstand wird geladen und angezeigt.
`saveGameNamespace`	`string`	Namespace des Spielstands (zum Beispiel `app.SaveGameNamespace.getSavemap()` für Karten).
`mapEditor`	`boolean`	Ob der Spielstand im Karten-Editor geladen wird (Button-Text „Load Map“).
`mapNewGame`	`boolean`	Ob die Kachel ein neues Spiel auf einer Karte startet (Button-Text „Play Map“).
`builtinSavegame`	`boolean`	Ob der Spielstand fest zum Spiel gehört. Ein Info-Icon zeigt dann, dass er sich nicht löschen lässt.
`modMap`	`boolean`	Ob die Karte aus einem Mod stammt. Zeigt ein Info-Icon.
`deluxeMap`	`boolean`	Ob das animierte Abzeichen „Deluxe“ erscheint.
`save`	`boolean`	Ob die Kachel auf der Speichern-Seite steht. Sie hat dann keinen Laden-Button.
`extraClass`	`string`	Zusätzliche Style-Klassen der Kachel.
`calloutContainerRef`	`ReactRefWrapApi0<CalloutApi>`	Callout-Container, den die Kachel nutzt.
`commonParams`	`CommonMenuParams`	Gemeinsame Parameter der Menüseite.

Funktionen

onClickMain(SaveGameData, SaveGameId) base/tealdef/gui/menu/savegame_react_util.d.tl:12

optional

onClickDetails(SaveGameData, SaveGameId) base/tealdef/gui/menu/savegame_react_util.d.tl:13

optional

onDoubleClickMain(SaveGameData, SaveGameId) base/tealdef/gui/menu/savegame_react_util.d.tl:14

optional

SavegameReactUtil.SavegameFiltersParam¶

record base/tealdef/gui/menu/savegame_react_util.d.tl:21

record SavegameFiltersParam

Hinweise

Parameter von SavegameFilters.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/menu/savegame_react_util.tl:703

savegame_react_util.SavegameFilters = react.RegisterRecipe("SavegameFilters", function(savegameCardParams : SavegameReactUtil.SavegameFiltersParam) : TreeNodeId

Felder

Name	Typ	Beschreibung
`sortMode`	`SortMode`	Aktuelle Sortierart.
`filterText`	`string`	Aktueller Filtertext.

Funktionen

setSortMode(mode : SortMode) base/tealdef/gui/menu/savegame_react_util.d.tl:27

Hinweise

Wird aufgerufen, wenn der Spieler eine andere Sortierart wählt.

setFilterText(text : string) base/tealdef/gui/menu/savegame_react_util.d.tl:29

Hinweise

Wird aufgerufen, während der Spieler im Filterfeld tippt.

SavegameReactUtil.SavegameFiltersParam.SortMode¶

enum base/tealdef/gui/menu/savegame_react_util.d.tl:22

enum SortMode

Hinweise

Sortierreihenfolge der Spielstandgruppen.

Im Basisspiel verwendet: 9-mal in 3 Dateien

base/content/gui/gui/menu/load_game_page.tl:33

local fetchSaveGames = function(filterText : string, sortMode : SavegameReactUtil.SavegameFiltersParam.SortMode, ascending : boolean) : {SaveGroup}

base/content/gui/gui/menu/save_game_page.tl:162

local fetchSaveGames = function(filterText : string, sortMode : SavegameReactUtil.SavegameFiltersParam.SortMode, ascending : boolean) : {SaveGroup}

base/content/gui/gui/menu/savegame_react_util.tl:121

function savegame_react_util.groupSaves(savegames : {SaveGameInfo}, filter : string, prefix : string, sortMode : SavegameReactUtil.SavegameFiltersParam.SortMode

Wert	Beschreibung
`"Name"`	Nach Gruppenname sortieren.Im Spiel NameIm Code: Name
`"Date"`	Nach dem Zeitpunkt des neuesten Spielstands sortieren.Im Spiel DatumIm Code: Date

SavegameReactUtil.SelectedSavegame¶

record base/tealdef/gui/menu/savegame_react_util.d.tl:32

record SelectedSavegame

Hinweise

Auf der Laden-Seite gewählter Spielstand.

Im Basisspiel verwendet: 7-mal in 3 Dateien

base/content/gui/gui/menu/advanced_settings.tl:14

savegameNameState : ReactStateT<SavegameReactUtil.SelectedSavegame>

base/content/gui/gui/menu/mod_selector_page.tl:41

savegameNameState : ReactStateT<SavegameReactUtil.SelectedSavegame>

base/content/gui/gui/menu/savegame_react_util.tl:880

local savegameNameState : ReactStateT<SavegameReactUtil.SelectedSavegame> = react.useState({

Felder

Name	Typ	Beschreibung
`saveGroup`	`GroupId`	Gruppe des gewählten Spielstands.
`savegameData`	`SaveGameData`	Daten des gewählten Spielstands, eventuell mit geänderten Mods und Einstellungen. `nil`, bis sie geladen sind.
`initialData`	`SaveGameData`	Daten des Spielstands, wie er gespeichert ist. Damit werden geänderte Mods und Einstellungen erkannt.
`index`	`integer`	Index des gewählten Spielstands innerhalb der Spielstände der Gruppe.

SavegameReactUtil.SavegameCardSelectParams¶

record base/tealdef/gui/menu/savegame_react_util.d.tl:39

record SavegameCardSelectParams

Hinweise

Parameter von SavegameSelectCard.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/menu/savegame_react_util.tl:848

savegame_react_util.SavegameSelectCard = react.RegisterRecipe("SavegameSelectCard", function(savegameCardParams : SavegameReactUtil.SavegameCardSelectParams) :

Felder

Name	Typ	Beschreibung
`selectedSavegame`	`SelectedSavegame`	Anfangs gewählter Spielstand.
`saveNameSpace`	`string`	Namespace der Spielstände.
`map`	`boolean`	Ob der Spielstand im Karten-Editor geladen wird.
`inPauseMenu`	`boolean`	Ob die Kachel im Pausenmenü steht. Wird an die Seite zur Mod-Auswahl weitergegeben.
`commonParams`	`CommonMenuParams`	Gemeinsame Parameter der Menüseite.

Funktionen

onDelete() base/tealdef/gui/menu/savegame_react_util.d.tl:45

Hinweise

Wird aufgerufen, wenn es die gewählte Gruppe nicht mehr gibt, zum Beispiel nachdem ihr letzter Spielstand gelöscht wurde.

SavegameReactUtil.ErrorType¶

enum base/tealdef/gui/menu/savegame_react_util.d.tl:53

enum ErrorType

Hinweise

Grund, warum sich ein Spielstand nicht so laden lässt, wie er ist.

Im Basisspiel verwendet: 3-mal in 2 Dateien

base/content/gui/gui/menu/main_page.tl:365

local errorTypes : {SavegameReactUtil.ErrorType} = {}

base/content/gui/gui/menu/savegame_react_util.tl:208

savegame_react_util.checkForError = function(savegameData : SaveGameData) : {SavegameReactUtil.ErrorType}, string

Wert	Beschreibung
`"ModMissing"`	Benötigte Mods oder DLCs fehlen.
`"CannotLoad"`	Die Spielstandinformationen ließen sich nicht lesen.
`"UnsupportedMapDimension"`	Kartengröße oder -format wird nicht unterstützt (nur auf Konsolen geprüft).

SavegameReactUtil.LoadPreviewParam¶

record base/tealdef/gui/menu/savegame_react_util.d.tl:65

record LoadPreviewParam

Hinweise

Parameter von LoadPreview.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/menu/savegame_react_util.tl:73

savegame_react_util.LoadPreview = react.RegisterRecipe("LoadPreview", function(param : SavegameReactUtil.LoadPreviewParam) : TreeNodeId

Felder

Name	Typ	Beschreibung
`saveGameData`	`SaveGameData`	Spielstanddaten. Ihr Screenshot wird genommen, wenn sich das Spielstandbild nicht laden lässt.
`saveGameId`	`SaveGameId`	Id des Spielstands, dessen Bild angezeigt wird.

SavegameReactUtil.ScrollableAchievementsListParams¶

record base/tealdef/gui/menu/savegame_react_util.d.tl:71

record ScrollableAchievementsListParams

Hinweise

Parameter von ScrollableAchievementsList.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/menu/savegame_react_util.tl:1551

savegame_react_util.ScrollableAchievementsList = react.RegisterRecipe("ScrollableAchievementsList", function(params : SavegameReactUtil.ScrollableAchievementsLi

Felder

Name	Typ	Beschreibung
`enableRightStickNavigation`	`boolean`	Ob die Liste mit den Eingabeaktionen `IA_SCROLL_UP` und `IA_SCROLL_DOWN` scrollt.

SavegameReactUtil.CampaignInfo¶

record base/tealdef/gui/menu/savegame_react_util.d.tl:76

record CampaignInfo

Hinweise

Missionen einer Kampagne mit ihrem Freischaltstatus, geliefert von getCampaignInfoSorted.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/menu/savegame_react_util.tl:1724

savegame_react_util.getCampaignInfoSorted = function(campaign : ResName) : SavegameReactUtil.CampaignInfo

Felder

Name	Typ	Beschreibung
`missionInfo`	`{MissionInfo}`	Missionen der Kampagne, nach ihrer `order` sortiert.
`desc`	`CampaignDesc`	Beschreibung der Kampagne.
`highestUnlocked`	`integer`	Position (in `missionInfo`) der zuletzt abgeschlossenen Mission. `0`, wenn keine abgeschlossen ist.

SavegameReactUtil.CampaignInfo.MissionInfo¶

record base/tealdef/gui/menu/savegame_react_util.d.tl:77

record MissionInfo

Hinweise

Eine Mission einer Kampagne.

Felder

Name	Typ	Beschreibung
`name`	`string`	Ressourcenname der Mission.
`desc`	`MissionDesc`	Beschreibung der Mission.
`enabled`	`boolean`	Ob sich die Mission starten lässt. Mit `unlockingProgression` sind nur die Missionen bis eine nach der zuletzt abgeschlossenen verfügbar.