metadata_util¶

Quelle: base/tealdef/scripts/metadata_util.d.tl

Hinweise

Typen von /scripts/metadata_util.tl (MetadataUtil): typisierter Zugriff auf die frei belegbaren metadata-Tabellen von Konstruktionsbeschreibungen, gebauten Konstruktionen, Unterkonstruktionen und Spielstand-Skripten. Jede Funktion des Spiels registriert ihren eigenen Schlüssel und liest und schreibt nur diesen.

Beispiel

-- Accessor registrieren (base/content/game_mechanics/game_mechanics/emission/emission_config_metadata.tl)
constructionDesc = metadata_util.constructionDesc.register("emissionConfig") as MetadataAccessor<ConstructionDescMetadata, EmissionConfigMeta>,
-- Metadaten-Tabelle aus mehreren Accessors bauen (base/content/gui/gui/construction/construction_react_util.tl)
metadata = metadata_util.constructionDesc.make({company_metadata.constructionDesc.make(companyMeta)}),

Globale Namen¶

Typen

Name	Definition	Beschreibung
`ConstructionDescMetadata`	`hier deklariert, definiert in ConstructionDescMetadata`	Typ der `metadata`-Tabelle einer Konstruktionsbeschreibung. Die API deklariert ihren Eintrag `emissionConfig` (`noise`, `pollution`). Andere Einträge werden über die Accessors von `MetadataUtil` gelesen und geschrieben.
`ConstructionInstanceMetadata`	`hier deklariert, definiert in ConstructionInstanceMetadata`	Undurchsichtiger Typ der Metadaten, die bei einer gebauten Konstruktion gespeichert sind.
`SubconstructionInstanceMetadata`	`hier deklariert, definiert in SubconstructionInstanceMetadata`	Undurchsichtiger Typ der Metadaten, die bei einer Unterkonstruktion gespeichert sind.
`SavegameScriptMetadata`	`hier deklariert, definiert in SavegameScriptMetadata`	Undurchsichtiger Typ der Metadaten, die ein Game-Script im Spielstand speichert (Rückgabe des Events `storeSavegameMetadata`).

MetadataAccessor¶

record global base/tealdef/scripts/metadata_util.d.tl:3

global record MetadataAccessor<C, T>

Hinweise

Typisierter Zugriff auf einen Schlüssel einer Metadaten-Tabelle, den MetadataTypeUtil.register(key) liefert. C ist die Art der Metadaten-Tabelle, T der Typ, der unter dem Schlüssel liegt.

Funktionen

set(container : C, value : T) base/tealdef/scripts/metadata_util.d.tl:4

Hinweise

Speichert value unter dem Schlüssel dieses Accessors in der Metadaten-Tabelle container.

get(container : C) : T base/tealdef/scripts/metadata_util.d.tl:5

Hinweise

Liest den Schlüssel dieses Accessors aus der Metadaten-Tabelle container.

Rückgabe T: Der gespeicherte Wert oder nil, wenn container nil ist oder unter dem Schlüssel nichts steht.

make(value : T) : function(C) base/tealdef/scripts/metadata_util.d.tl:8

creates a function that will insert into the container

Rückgabe function(C)

MetadataUtil¶

record global base/tealdef/scripts/metadata_util.d.tl:16

global record MetadataUtil

Laden: local metadata_util = ug_require "::/scripts/metadata_util.tl" as MetadataUtil

Hinweise

Accessor-Fabriken für die vier Arten von Metadaten-Tabellen. ug_require "/scripts/metadata_util.tl" gibt sie zurück.

Felder

Name	Typ	Beschreibung
`constructionDesc`	`MetadataTypeUtil<ConstructionDescMetadata>`	Accessor-Fabrik für die Metadaten von Konstruktionsbeschreibungen. 19-mal im Basisspiel verwendet
`constructionInstance`	`MetadataTypeUtil<ConstructionInstanceMetadata>`	Accessor-Fabrik für die Metadaten gebauter Konstruktionen. 3-mal im Basisspiel verwendet
`subconstructionInstance`	`MetadataTypeUtil<SubconstructionInstanceMetadata>`	Accessor-Fabrik für die Metadaten von Unterkonstruktionen. 2-mal im Basisspiel verwendet
`savegameScript`	`MetadataTypeUtil<SavegameScriptMetadata>`	Accessor-Fabrik für die Metadaten von Spielstand-Skripten. 2-mal im Basisspiel verwendet

MetadataUtil.MetadataTypeUtil¶

record base/tealdef/scripts/metadata_util.d.tl:17

record MetadataTypeUtil<C>

Hinweise

Accessor-Fabrik für eine Art von Metadaten-Tabelle C.

Im Basisspiel verwendet: 5-mal in 1 Datei

base/content/scripts/scripts/metadata_util.tl:35

local function makeUtil() : MetadataUtil.MetadataTypeUtil<any>

Funktionen

register<T>(key : string) : MetadataAccessor<C, T> base/tealdef/scripts/metadata_util.d.tl:18

Hinweise

Erzeugt einen Accessor, der den angegebenen Schlüssel in Metadaten-Tabellen dieser Art liest und schreibt.

Parameter	Typ	Beschreibung
`key`	`string`	Der Schlüssel, unter dem die Spielfunktion ihre Daten ablegt, zum Beispiel `"emissionConfig"`.

Rückgabe MetadataAccessor<C, T>: Ein Accessor mit get, set und make.

make(uses : {function(C)}) : C base/tealdef/scripts/metadata_util.d.tl:19

Hinweise

Baut eine neue Metadaten-Tabelle und ruft jede übergebene Funktion (meist aus accessor.make(value)) darauf auf.

Parameter	Typ	Beschreibung
`uses`	`{function(C)}`	Funktionen, die jeweils einen Wert in die Tabelle eintragen.

Rückgabe C: Die gefüllte Metadaten-Tabelle.