builtin

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

Beispiel

-- from base/content/gui/gui/main/main_mod_button_area.tl
local builtin = ug_require "::/gui/main/builtin.lua" as Builtin

return builtin.FloatingLayout {
    children = {
        builtin.ScrollArea {
            horizontalPolicy = builtin.type.ScrollBarPolicy.Simple,
            verticalPolicy = builtin.type.ScrollBarPolicy.AlwaysOff,
            content = builtin.Component {
                meta = { class = "scroll-area-content" },
                layout = builtin.BoxLayout {
                    orientation = builtin.type.Orientation.Horizontal,
                    children = children,
                },
            },
        },
    },
}

Inhalt

Seite	Beschreibung
Builtin.Type	Enums und Hilfsklassen der eingebauten Widgets, erreichbar als builtin.type (kleingeschrieben).
Builtin.ShaderQuadParam	Parameter eines Shader-Quads, eines Bilds mit Licht- und Mauseffekten.

Builtin

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

global record Builtin

Hinweise

Die eingebaute Widget-Bibliothek, die ug_require "::/gui/main/builtin.lua" zurückgibt: Recipes für Layouts, Text, Bilder, Buttons, Eingabefelder, Fenster, Diagramme und die Werkzeug- und Renderer-Komponenten des Spiels. Die meisten Widget-Parameter sind Engine-Klassen. Eine Parametertabelle darf deshalb nur die deklarierten Felder enthalten, ein unbekannter Schlüssel löst einen Fehler aus. Die Enums liegen in builtin.type.

Felder

Name	Typ	Beschreibung
type	Type	Die Enums und Hilfsklassen (builtin.type.Orientation, builtin.type.ScrollBarPolicy, ...).
FloatingLayout	Recipe<FloatingLayoutParam>	Layout, das seine Kinder übereinanderlegt und jedes innerhalb des Layouts positioniert.
FloatingLayoutChild	Recipe<FloatingLayoutChildParam>	Hülle, die ein Kind in einem Floating-Layout platziert.
AbsoluteLayoutChild	Recipe<AbsoluteLayoutChildParam>	Hülle für ein Kind eines absoluten Layouts.
BoxLayout	Recipe<BoxLayoutParam>	Layout, das seine Kinder in einer Zeile oder Spalte anordnet.
FlowLayout	Recipe<FlowLayoutParam>	Layout, das die Kinder in einer Zeile anordnet und in die nächste Zeile umbricht, wenn der Platz ausgeht.
Chart	Recipe<ChartParam>
Series	Recipe<SeriesParam>	Datenreihe eines Diagramms.
List	Recipe<ListParam>	Liste mit auswählbaren Einträgen.
ScrollArea	Recipe<ScrollAreaParam>	Scrollbarer Bereich um einen Inhaltsknoten.
Component	Recipe<ComponentParam>	Container-Knoten um ein Layout. Gestylt wird er über seine Style-Klassen.
TextView	Recipe<TextViewParam>	Einfaches Textlabel.
RichTextView	Recipe<RichTextViewParam>	Formatierter Text (HTML oder Markdown).
KeybindingHintDisplay	Recipe<KeybindingHintDisplayParam>	Zeigt die Taste oder den Gamepad-Knopf einer Eingabeaktion.
ParticleSystem2d	Recipe<ParticleSystem2dParam>	2D-Partikeleffekt in der GUI.
ImageView	Recipe<ImageViewParam>	Bild, wahlweise ein animiertes Sprite-Sheet.
ShaderQuad	Recipe<ShaderQuadParam>	Bild, das mit einem GUI-Shader gezeichnet wird (Licht-, Wellen- und Glanzeffekte).
Button	Recipe<ButtonParam>	Druckknopf.
ToggleButton	Recipe<ToggleButtonParam>	Button mit einem An- und einem Aus-Zustand.
ToggleButtonGroup	Recipe<ToggleButtonGroupParam>	Gruppe von Toggle-Buttons, von denen einer ausgewählt werden kann.
ToolButton	Recipe<ToolButtonParam>	Button, der ein Werkzeug (Fenster oder Baumodus) öffnet und schließt.
DoubleSpinBox	RecipeWithApi<DoubleSpinBoxParam, DoubleSpinBoxApi>	Zahlenfeld mit Schritten. Stellt DoubleSpinBoxApi bereit.
TextInputField	Recipe<TextInputFieldParam>	Einzeiliges Texteingabefeld.
Slider	Recipe<SliderParam>	Schieberegler für Ganzzahlen.
ColorPicker	Recipe<ColorPickerParam>	Farbauswahl.
ColorChooser	Recipe<ColorChooserParam>	Farbpalette mit Farbfeldern.
ColorChooserButton	Recipe<ColorChooserButtonParam>	Button, der eine Farbpalette öffnet.
GradientLegend	Recipe<GradientLegendParam>	Farblegende, z. B. von Karten-Layern.
ProgressBar	Recipe<ProgressBarParam>	Fortschrittsbalken.
CheckBox	Recipe<CheckBoxParam>	Checkbox mit optionaler Beschriftung. Die Werte sind 0, 1 und -1 (unbestimmt).
ComboBox	Recipe<ComboBoxParam>	Dropdown-Liste.
ComboBoxItem	Recipe<ComboBoxItemParam>	Eintrag einer Combobox.
NativeFileDialogButton	Recipe<NativeFileDialogButtonParam>	Button, der einen Dateidialog öffnet.
DropComponent	Recipe<DropComponentParam>	Bereich, der Dateien annimmt, die von außerhalb des Spiels hineingezogen werden.
RadialMenuChild	Recipe<RadialMenuChildParam>	Eintrag eines Kreismenüs. 1-mal im Basisspiel verwendet
RadialMenu	Recipe<RadialMenuParam>	Kreisförmiges Menü (Gamepad).
TabWidget	Recipe<TabWidgetParam>	Widget mit Registerkarten. Die Steps verborgener Registerkarten sind angehalten.
TabWidgetChild	Recipe<TabWidgetChildParam>	Eine Registerkarte eines Tab-Widgets.
Row	Recipe<RowParam>	Zeile eines Tabellen-Layouts.
TableLayout	Recipe<TableLayoutParam>	Layout, das Zeilen aus Zellen in Spalten ausrichtet.
ColumnDesc	Recipe<ColumnDescParam>	Spaltenbeschreibung einer Datentabelle.
DataTable	RecipeWithApi<DataTableParam, DataTableApi>	Sortierbare Tabelle mit einem Zellen-Recipe pro Spalte. Stellt DataTableApi bereit.
Window	Recipe<WindowParam>	Fenster mit Titelleiste. Meist über die API des Fenster-Containers oder über ein Werkzeug geöffnet.
WindowContainerDelegate	RecipeWithApi<WindowContainerDelegateParam, WindowAPI>	Der Container, der die Fenster des Spiels enthält. Stellt WindowAPI bereit.
ToolStack	RecipeWithApi<ToolStackParam, ToolStackAPI>	Stapel von Werkzeugen (Fenster, Baumodi). Nur das oberste Werkzeug ist aktiv, die anderen ruhen. Stellt ToolStackAPI bereit.
HudIconManagerConfig	Recipe<HudIconManagerConfigParam<any>>	Konfiguriert die HUD-Symbole eines Karten-Layers.
UseDefaultHudIcon	Recipe<HudIconParam>	Zeigt das Standard-HUD-Symbol des Spiels für die Entität.
HudIconChildConfig	Recipe<HudIconChildConfigParam>	Umhüllt einen HUD-Symbol-Knoten.
RendererComponent	RecipeWithApi<RendererComponentParam, RenderComponentAPI>	Die 3D-Spielansicht. Stellt RenderComponentAPI bereit.
EntityRendererComponent	Recipe<EntityRendererComponentParams>	Ansicht, die eine einzelne Entität rendert.
EdgeRenderable	Recipe<EdgeRenderableParam>	Zeichnet in der 3D-Ansicht farbige Linien entlang von Kanten.
MissionArrowRenderable	Recipe<MissionArrowRenderableParam>	Zeichnet Missionspfeile in der 3D-Ansicht.
ActionDescriptor	Recipe<ActionDescriptorParam>	Beschreibt die aktuelle Action der 3D-Ansicht.
ConstructionAction	Recipe<ConstructionActionParam>	Bau-Action in der 3D-Ansicht (Platzieren, Ändern oder Abreißen).
SimpleInputActions	Recipe<SimpleInputActionsParam>	Registriert einfache Eingabeaktionen.
Selector	Recipe<SelectorParam>	Entitäts-Selektor in der 3D-Ansicht.
NodeViewer	Recipe<NodeViewerParam>
LineViewer	Recipe<LineViewerParam>	Zeichnet Linien und Haltestellen in der 3D-Ansicht.
ProposalViewer	Recipe<ProposalViewerParam>	Zeigt eine Vorschau eines Bauvorschlags in der 3D-Ansicht.
MapPreviewComp	Recipe<MapPreviewCompParam>	Kartenvorschau.
LayerConfig	Recipe<LayerConfig>	Konfiguriert den aktiven Karten-Layer.
RailroadCrossingComp	Recipe<RailroadCrossingCompParam>
SignalComp	Recipe<SignalCompParam>
ReactAdapterGuestContainer	RecipeWithApi0<ReactAdapterGuestContainerAPI>

Funktionen

WithComponentParams(WithComponentParamsParam, ?any) : TreeNodeId base/tealdef/scripts/builtin.d.tl:646

Hinweise

Umhüllt einen Knoten mit den Einstellungen oben. Wird intern für meta-Felder verwendet.

Rückgabe TreeNodeId

AbsoluteLayout({TreeNodeId}) : TreeNodeId base/tealdef/scripts/builtin.d.tl:671

Die Spieldateien enthalten hierzu noch keine Beschreibung.

Rückgabe TreeNodeId

ActionTooltip<T>(ActionTooltipParam<T>) : TreeNodeId base/tealdef/scripts/builtin.d.tl:1383

Hinweise

Erzeugt einen Tooltip, der während einer Action am Mauszeiger erscheint.

Rückgabe TreeNodeId

FullScreenComponent<T>(FullScreenComponentParam<T>) : TreeNodeId base/tealdef/scripts/builtin.d.tl:1422

Hinweise

Erzeugt ein Vollbild-Overlay aus einem Recipe und seinem Parameter.

Rückgabe TreeNodeId

Verschachtelte Records auf eigenen Seiten: Type, ShaderQuadParam

Builtin.WithComponentParamsParam

record base/tealdef/scripts/builtin.d.tl:634

record WithComponentParamsParam

Hinweise

Einstellungen, die durch Umhüllen auf einen Knoten angewendet werden. React erzeugt diese Hülle aus meta-Feldern wie tooltip, tag oder enabled. Setze diese Felder in meta, das Recipe ist nicht zum direkten Aufruf gedacht.

Felder

Name	Typ	Beschreibung
id	string	Element-ID, wie sie api.gui.byId verwendet.
tag	string	Tag. Die Kontexthilfe sucht ihre Hilfeseite über das Tag.
tooltip	string	Text des Tooltips.
tooltipModifierInputAction	string	append this IA's key to the tooltip (regardless of what the key currently does)
forceFocusable	boolean	Macht den Knoten fokussierbar.
disableFocusableRecursive	boolean	Macht den Knoten und seine Kinder nicht fokussierbar.
enabled	boolean	False deaktiviert den Knoten.
item	TreeNodeId	Der umhüllte Knoten.
styleSheet	StyleSheet	Stylesheet für den Knoten.

Builtin.FloatingLayoutParam

record base/tealdef/scripts/builtin.d.tl:648

record FloatingLayoutParam

Hinweise

Parameter eines Floating-Layouts, in dem die Kinder übereinander liegen.

Felder

Name	Typ	Beschreibung
id	string	Element-ID.
focusTraversalOrientation	Type.Orientation	Richtung, in der der Gamepad-Fokus zwischen den Kindern wandert.
children	{TreeNodeId}	Kinder. Umhülle sie mit FloatingLayoutChild, um ihre Position festzulegen.

Builtin.FloatingLayoutChildParam

record base/tealdef/scripts/builtin.d.tl:654

record FloatingLayoutChildParam

Hinweise

Platzierung eines Kinds in einem Floating-Layout.

Felder

Name	Typ	Beschreibung
h	number	Waagrechte Position als Anteil des freien Platzes (0 links, 0,5 Mitte, 1 rechts). Mit -1 füllt das Kind die Breite.
v	number	Senkrechte Position als Anteil des freien Platzes (0 oben, 0,5 Mitte, 1 unten). Mit -1 füllt das Kind die Höhe.
overflowMode	boolean	Ob das Kind das Elternelement verlassen darf. Das Basisspiel übergibt hier einen Wert von builtin.type.FloatingLayoutOverflowMode, obwohl das Feld als boolean deklariert ist.
localKey	string	Schlüssel, der die Identität des Kinds zwischen zwei Renderings erhält.
item	TreeNodeId	Der Kindknoten (Pflicht).

Builtin.AbsoluteLayoutChildParam

record base/tealdef/scripts/builtin.d.tl:666

record AbsoluteLayoutChildParam

Hinweise

Ein Kind eines absoluten Layouts.

Felder

Name	Typ	Beschreibung
localKey	string	Schlüssel, der die Identität des Kinds zwischen zwei Renderings erhält.
item	TreeNodeId	Der Kindknoten (Pflicht).

Builtin.BoxLayoutParam

record base/tealdef/scripts/builtin.d.tl:674

record BoxLayoutParam

Hinweise

Parameter eines Box-Layouts.

Felder

Name	Typ	Beschreibung
id	string	Element-ID.
children	{TreeNodeId}	Kinder in ihrer Reihenfolge.
child	TreeNodeId	shortcut to setting children =
orientation	Type.Orientation	Waagrechte oder senkrechte Anordnung.

Builtin.FlowLayoutParam

record base/tealdef/scripts/builtin.d.tl:683

record FlowLayoutParam

Hinweise

Parameter eines Flow-Layouts.

Felder

Name	Typ	Beschreibung
children	{TreeNodeId}	Kinder in ihrer Reihenfolge.

Builtin.ChartParam

record base/tealdef/scripts/builtin.d.tl:689

record ChartParam

Hinweise

Parameter eines Diagramms.

Felder

Name	Typ	Beschreibung
xAxisMarkers	{number}	X-Werte, an denen Achsenmarken gezeichnet werden.
yAxisMarkers	{number}	Y-Werte, an denen Achsenmarken gezeichnet werden.
xAxisMin	number	Kleinster angezeigter X-Wert.
xAxisMax	number	Größter angezeigter X-Wert.
yAxisMin	number	Kleinster angezeigter Y-Wert.
yAxisMax	number	Größter angezeigter Y-Wert.

Funktionen

xAxisLabelFormatter(number) : string base/tealdef/scripts/builtin.d.tl:690

Hinweise

Gibt den Beschriftungstext für einen Wert der X-Achse zurück.

Rückgabe string

yAxisLabelFormatter(number) : string base/tealdef/scripts/builtin.d.tl:691

Hinweise

Gibt den Beschriftungstext für einen Wert der Y-Achse zurück.

Rückgabe string

Builtin.SeriesParam

record base/tealdef/scripts/builtin.d.tl:700

record SeriesParam

Hinweise

Eine Datenreihe eines Diagramms.

Felder

Name	Typ	Beschreibung
label	string	Name der Datenreihe.
type	Type	Diagrammtyp.
color	{Vec4f}	Farbe(n) der Datenreihe.
lineWidth	number	Linienbreite.
xValues	{number}	X-Werte.
yValues	{number}	Y-Werte, einer pro X-Wert.
gradientFill	boolean	adds a color gradient below the line (only available for Type LINE at the moment)

Builtin.SeriesParam.Type

enum base/tealdef/scripts/builtin.d.tl:701

enum Type

Hinweise

Diagrammtyp einer Datenreihe.

Im Basisspiel verwendet: 2-mal in 2 Dateien

base/content/game_mechanics/game_mechanics/finance/finances_charts.tl:21

chartType : Builtin.SeriesParam.Type

base/content/gui/gui/entity_window/maintenance_station/maintenance_station_eow.script.tl:37

types : {Builtin.SeriesParam.Type}

Wert	Beschreibung
"LINE"	Linie.
"LINE_STEP"	Stufenlinie.
"STACKED_LINE"	Linie, auf die vorige Datenreihe gestapelt.
"BAR"	Balken.
"STACKED_BAR"	Balken, auf die vorige Datenreihe gestapelt.

Builtin.ListParam

record base/tealdef/scripts/builtin.d.tl:722

record ListParam

Hinweise

Parameter einer Liste mit auswählbaren Einträgen.

Felder

Name	Typ	Beschreibung
drawBackground	boolean	Zeichnet den Hintergrund der Liste.
orientation	Type.Orientation	Waagrechte oder senkrechte Liste.
behavior	Type.ListBehavior	Auswahlverhalten.
cycle	boolean	Springt beim Navigieren vom letzten Eintrag zum ersten.
deselectAllowed	boolean	Erlaubt, die Auswahl des ausgewählten Eintrags aufzuheben.
emitSignalOnReselect	boolean	Ruft onSelect erneut auf, wenn der ausgewählte Eintrag noch einmal ausgewählt wird.
horizontalScrollBarPolicy	Type.ScrollBarPolicy	Wann die waagrechte Bildlaufleiste erscheint.
verticalScrollBarPolicy	Type.ScrollBarPolicy	Wann die senkrechte Bildlaufleiste erscheint.
disableGamepadNavigation	boolean	Keine Navigation in der Liste mit dem Gamepad.
disableMouseScrolling	boolean	Kein Scrollen mit dem Mausrad.
children	{TreeNodeId}	Die Einträge.
selectionIndex	integer	Index des ausgewählten Eintrags.
keepSelectedVisible	boolean	Scrollt so, dass der ausgewählte Eintrag sichtbar bleibt.

Funktionen

onHover(integer) base/tealdef/scripts/builtin.d.tl:731

Hinweise

Wird mit dem Index des Eintrags unter dem Mauszeiger aufgerufen.

onSelect(integer) base/tealdef/scripts/builtin.d.tl:732

Hinweise

Wird mit dem Index des ausgewählten Eintrags aufgerufen.

onActivate(integer) base/tealdef/scripts/builtin.d.tl:733

Hinweise

Wird mit dem Index des ausgelösten Eintrags aufgerufen.

Builtin.ScrollAreaParam

record base/tealdef/scripts/builtin.d.tl:749

record ScrollAreaParam

Hinweise

Parameter eines Scrollbereichs.

Felder

Name	Typ	Beschreibung
content	TreeNodeId	Der gescrollte Knoten.
horizontalPolicy	Type.ScrollBarPolicy	Wann die waagrechte Bildlaufleiste erscheint.
verticalPolicy	Type.ScrollBarPolicy	Wann die senkrechte Bildlaufleiste erscheint.
disableGamepadNavigation	boolean	Kein Scrollen mit dem Gamepad.
disableMouseScrolling	boolean	Kein Scrollen mit dem Mausrad.

Funktionen

onScroll(Vec2i, Vec2i) base/tealdef/scripts/builtin.d.tl:755

Hinweise

Wird aufgerufen, wenn sich die Scrollposition ändert.

Builtin.ComponentParam

record base/tealdef/scripts/builtin.d.tl:760

record ComponentParam

Hinweise

Parameter einer Komponente, des einfachen gestylten Containers.

Felder

Name	Typ	Beschreibung
layout	TreeNodeId	Layout-Knoten mit dem Inhalt der Komponente.
name	string	Name der Komponente.
mouseTransparent	boolean	Lässt Mausereignisse durch.

Builtin.TextViewParam

record base/tealdef/scripts/builtin.d.tl:768

record TextViewParam

Hinweise

Parameter einer Textanzeige.

Felder

Name	Typ	Beschreibung
text	string	Der Text.
inlineHintSupport	boolean
useUnicodeCompatibilityFont	boolean	Verwendet die Schrift mit größerer Unicode-Abdeckung (die Sprachauswahl nutzt sie).
tooltipWhenClipped	string	Tooltip, der erscheint, wenn der Text nicht hineinpasst.

Builtin.RichTextViewParam

record base/tealdef/scripts/builtin.d.tl:777

record RichTextViewParam

Hinweise

Parameter einer Anzeige für formatierten Text.

Felder

Name	Typ	Beschreibung
text	string	Der Text.
isHtml	boolean	Der Text ist HTML.
isMarkdown	boolean	Der Text ist Markdown.

Builtin.KeybindingHintDisplayParam

record base/tealdef/scripts/builtin.d.tl:785

record KeybindingHintDisplayParam

Hinweise

Parameter eines Tastenhinweises.

Felder

Name	Typ	Beschreibung
inputAction	string	Eingabeaktion, deren Taste angezeigt wird, z. B. "IA_SELECT".
source	ReactRefWrap	Knoten, zu dem der Hinweis gehört.
sourceId	string	Element-ID des Knotens, zu dem der Hinweis gehört.

Builtin.ParticleSystem2dParam

record base/tealdef/scripts/builtin.d.tl:793

record ParticleSystem2dParam

Hinweise

Parameter eines 2D-Partikelsystem-Widgets.

Felder

Name	Typ	Beschreibung
emitters	{Builtin.Type.ParticleSystem2dEmitter}	Die Emitter. Sub-Emitter verweisen über den Index auf sie.

Builtin.ImageViewParam

record base/tealdef/scripts/builtin.d.tl:799

record ImageViewParam

Hinweise

Parameter einer Bildanzeige.

Im Basisspiel verwendet: 3-mal in 2 Dateien

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

local continueImage : Builtin.ImageViewParam = {

base/content/gui/gui/menu/menu_icon_react_util.tl:141

local imageParam : Builtin.ImageViewParam = (img is string) and {

Felder

Name	Typ	Beschreibung
meta	Meta	Allgemeine Knoteneinstellungen.
path	string	Bilddatei, z. B. "::/gui/builtin/checkbox/checked_16.tga".
scaling	Type.ImageViewScaling	Wie das Bild skaliert wird.
data	{integer}
data_native	Vector<integer>
flippedHorizontally	boolean	Spiegelt das Bild.
size	Vec2i
coord	Vec2i	Raster der Frames in einem Sprite-Sheet, Spalten und Zeilen (z. B. 6, 6 für 36 Frames).
numFrames	integer	Anzahl der Frames im Sprite-Sheet.
frame	integer	Frame, der angezeigt wird.
reverseAnimation	boolean	Spielt die Frames rückwärts ab.
animationSpeed	integer	Geschwindigkeit der Animation. Bei 0 bleibt der feste frame stehen.
waitNCycles	integer	Pause in Animationszyklen zwischen zwei Durchläufen der Animation.
stopOnLastFrame	boolean	Hält beim letzten Frame an, statt die Animation zu wiederholen.
animationFrameBottomToTop	boolean	Die Frames sind von unten nach oben im Sheet angeordnet.
rotation	number	Drehung des Bilds.

Builtin.ButtonParam

record base/tealdef/scripts/builtin.d.tl:859

record ButtonParam

Hinweise

Parameter eines Buttons.

Felder

Name	Typ	Beschreibung
content	TreeNodeId	Inhalt des Buttons, z. B. eine Textanzeige.

Funktionen

onClick() base/tealdef/scripts/builtin.d.tl:861

Hinweise

Wird aufgerufen, wenn der Button angeklickt oder ausgelöst wird.

Builtin.ToggleButtonParam

record base/tealdef/scripts/builtin.d.tl:866

record ToggleButtonParam

use initialValue if your ToggleButton is dumb (not referring to an external state) use value AND onValueChange your ToggleButton refers to a state (in the parent recipe of the checkBox)

Felder

Name	Typ	Beschreibung
content	TreeNodeId	Inhalt des Buttons.
initialValue	integer	Startwert, wenn der Button seinen Zustand selbst verwaltet.
value	integer	Aktueller Wert, wenn ein übergeordneter Zustand den Button steuert (zusammen mit onValueChange).

Funktionen

onValueChange(integer) base/tealdef/scripts/builtin.d.tl:868

Hinweise

Wird mit dem neuen Wert aufgerufen, 0 (aus) oder 1 (an).

Builtin.ToggleButtonGroupChildParam

record base/tealdef/scripts/builtin.d.tl:873

record ToggleButtonGroupChildParam

Hinweise

Ein Button einer Toggle-Button-Gruppe.

Im Basisspiel verwendet: 11-mal in 9 Dateien

base/content/game_mechanics/game_mechanics/company/company.tl:524

local buttons : {Builtin.ToggleButtonGroupChildParam} = {}

base/content/game_mechanics/game_mechanics/notifications/gui/notification_log.tl:392

local filterButtons : {Builtin.ToggleButtonGroupChildParam} = {

base/content/gui/gui/entity_window/line/line.tl:49

local items : {Builtin.ToggleButtonGroupChildParam} = {}

base/content/gui/gui/entity_window/line/line_eow.script.tl:461

local items : {Builtin.ToggleButtonGroupChildParam} = {}

base/content/gui/gui/game_bar/game_bar_widgets.tl:206

local buttons : {Builtin.ToggleButtonGroupChildParam} = {}

base/content/gui/gui/main/menu_category_util.tl:125

local createButtonParam = function(object : MenuCategoryUtil.FilterObject, isMajor : boolean, addDefaultTooltip : boolean) : Builtin.ToggleButtonGroupChildParam

… und 3 weitere Dateien.

Felder

Name	Typ	Beschreibung
content	TreeNodeId	Inhalt des Buttons.
meta	Meta	all transferred to ToggleButton inside ToggleButtonGroup!

Builtin.ToggleButtonGroupParam

record base/tealdef/scripts/builtin.d.tl:878

record ToggleButtonGroupParam

Hinweise

Parameter einer Gruppe von Toggle-Buttons, von denen einer ausgewählt ist.

Felder

Name	Typ	Beschreibung
buttons	{ToggleButtonGroupChildParam}	Die Buttons.
deselectAllowed	boolean	default is false
layout	Layout	default is "Horizontal"
separators	{integer : TreeNodeId}	Knoten, die zwischen den Buttons eingefügt werden, nach Position.
use -1 to avoid any selection at all (only working if deselectAllowed is set to true)
initialSelected	integer
selected	integer	Index des ausgewählten Buttons. -1 wählt keinen aus (nur mit deselectAllowed).

Funktionen

onValueChange(index : integer, value : integer) base/tealdef/scripts/builtin.d.tl:886

Hinweise

Wird mit dem Index des neu ausgewählten Buttons aufgerufen.

Builtin.ToggleButtonGroupParam.Layout

enum base/tealdef/scripts/builtin.d.tl:879

enum Layout

Hinweise

Anordnung der Buttons.

Wert	Beschreibung
"Horizontal"	default, horizontal aligned buttins with individual widths
"Vertical"	vertical aligned buttons with individual heights
"Flow"	horizontal aligned buttons with individual widths, but wrapping to next line if not enough space
"Uniform"	horizontal aligned buttons with equal widths, filling the available space

Builtin.ToolButtonParam

record base/tealdef/scripts/builtin.d.tl:896

record ToolButtonParam

Hinweise

Parameter eines Werkzeug-Buttons, der ein Werkzeug auf den Werkzeug-Stack legt.

Felder

Name	Typ	Beschreibung
rendererComponentId	string	defaults to "mainView"
toolDefinition	IReactToolDefinition	Werkzeug, das der Button auf den Stack legt.
toolName	string	can be used instead of toolDefinition for cases where the definition is not available
toolVariant	string	Variante des Werkzeugs. Der Button erscheint aktiv, wenn diese Variante aktiv ist.
toolStack	ReactRefWrapApiT<ToolStackParam, ToolStackAPI>	Werkzeug-Stack, der verwendet wird.
text	string	Text des Buttons.
content	TreeNodeId	Inhalt des Buttons.

Funktionen

showFn() base/tealdef/scripts/builtin.d.tl:908

Die Spieldateien enthalten hierzu noch keine Beschreibung.

hideFn() base/tealdef/scripts/builtin.d.tl:909

Die Spieldateien enthalten hierzu noch keine Beschreibung.

Builtin.DoubleSpinBoxApi

record base/tealdef/scripts/builtin.d.tl:917

record DoubleSpinBoxApi

Hinweise

API eines Spinbox-Knotens.

Funktionen

startEditing(onStop : function()) base/tealdef/scripts/builtin.d.tl:918

Hinweise

Startet die Textbearbeitung. onStop wird aufgerufen, wenn sie endet.

Builtin.DoubleSpinBoxParam

record base/tealdef/scripts/builtin.d.tl:920

record DoubleSpinBoxParam

Hinweise

Parameter eines Zahlenfelds mit Schritten nach oben und unten.

Felder

Name	Typ	Beschreibung
min	number	nil: unbounded
max	number	nil: unbounded
step	number	Schrittweite.
value	number	Aktueller Wert.
virtualKeyboardTitle	string	Titel der Bildschirmtastatur.
virtualKeyboardDescription	string	Beschreibung auf der Bildschirmtastatur.
startInEditMode	boolean	Startet mit aktiver Textbearbeitung.

Funktionen

onValueChange(number) base/tealdef/scripts/builtin.d.tl:925

Hinweise

Wird mit dem neuen Wert aufgerufen.

onStopEditMode() base/tealdef/scripts/builtin.d.tl:930

Hinweise

Wird aufgerufen, wenn die Textbearbeitung endet.

Builtin.TextInputFieldParam

record base/tealdef/scripts/builtin.d.tl:935

record TextInputFieldParam

Hinweise

Parameter eines Texteingabefelds.

Felder

Name	Typ	Beschreibung
value	string	Aktueller Text.
resetValueOnCancel	boolean	show initialValue on cancelling (default true. Does not trigger onValueChange)
placeholderText	string	Text, der angezeigt wird, solange das Feld leer ist.
showVirtualKeyboardOnFocus	boolean	Öffnet die Bildschirmtastatur, wenn das Feld den Fokus bekommt.
virtualKeyboardTitle	string	Titel der Bildschirmtastatur.
virtualKeyboardDescription	string	Beschreibung auf der Bildschirmtastatur.
type	integer
passwordMode	boolean	Verbirgt die getippten Zeichen.
acceptOnFocusLoss	boolean	Übernimmt den Text, wenn das Feld den Fokus verliert.
deselectOnFocusLost	boolean	Hebt die Textauswahl auf, wenn das Feld den Fokus verliert.
focusOnStartEditing	boolean	Holt sich den Fokus, wenn die Bearbeitung beginnt.
popFocusOnStopEditing	boolean	Gibt den Fokus zurück, wenn die Bearbeitung endet.
maxLength	integer	Höchstzahl der Zeichen.
displayOnly	boolean	defaults to false

Funktionen

filter(string) : boolean base/tealdef/scripts/builtin.d.tl:939

Hinweise

Gibt false zurück, um einen Text abzulehnen.

Rückgabe boolean

onEditingModeChange(boolean) base/tealdef/scripts/builtin.d.tl:940

Hinweise

Wird aufgerufen, wenn die Bearbeitung beginnt (true) oder endet (false).

onTyping(string) base/tealdef/scripts/builtin.d.tl:941

Hinweise

Wird beim Tippen nach jeder Änderung mit dem Text aufgerufen.

onValueChange(string) base/tealdef/scripts/builtin.d.tl:942

Hinweise

Wird mit dem übernommenen Text aufgerufen.

onCancel() base/tealdef/scripts/builtin.d.tl:943

Hinweise

Wird aufgerufen, wenn die Bearbeitung abgebrochen wird.

Builtin.SliderParam

record base/tealdef/scripts/builtin.d.tl:959

record SliderParam

Hinweise

Parameter eines Schiebereglers.

Felder

Name	Typ	Beschreibung
min	integer	Kleinster Wert.
max	integer	Größter Wert.
step	integer	Schrittweite.
pageStep	integer	Größere Schrittweite.
horizontal	boolean	Waagrechter Schieberegler (sonst senkrecht).
drawGroove	boolean	Zeichnet die Führungsrille.
disableGamepadNavigation	boolean	Der Wert lässt sich nicht mit dem Gamepad ändern.
withTicks	boolean	defaults to false
stepsForDynamicKeyRepeatSpeed	integer	If range has at least that many steps, keeping keys pressed will increase repeat frequency. Default: 10, set -1 to disable entirely.
initialValue	integer	Startwert, wenn der Schieberegler seinen Zustand selbst verwaltet.
value	integer	Aktueller Wert, wenn ein übergeordneter Zustand den Schieberegler steuert.

Funktionen

onValueChange(newValue : integer) base/tealdef/scripts/builtin.d.tl:972

Hinweise

Wird mit dem neuen Wert aufgerufen.

Builtin.ColorPickerParam

record base/tealdef/scripts/builtin.d.tl:977

record ColorPickerParam

Hinweise

Parameter einer Farbauswahl.

Felder

Name	Typ	Beschreibung
color	Vec3f	Aktuelle Farbe (RGB).
showApplyButton	boolean	Zeigt einen Übernehmen-Button.

Funktionen

onValueChange(Vec3f) base/tealdef/scripts/builtin.d.tl:979

Hinweise

Wird mit der Farbe aufgerufen, während sie sich ändert.

onApply(Vec3f) base/tealdef/scripts/builtin.d.tl:980

Hinweise

Wird mit der Farbe aufgerufen, wenn der Übernehmen-Button gedrückt wird.

Builtin.ColorChooserParam

record base/tealdef/scripts/builtin.d.tl:984

record ColorChooserParam

Hinweise

Parameter einer Farbpalette mit festen Farbfeldern.

Felder

Name	Typ	Beschreibung
colors	{Vec3f}	Farben, aus denen gewählt wird.
useCustomColors	boolean

Funktionen

onValueChange(Vec3f) base/tealdef/scripts/builtin.d.tl:987

Hinweise

Wird mit der gewählten Farbe aufgerufen.

Builtin.ColorChooserButtonParam

record base/tealdef/scripts/builtin.d.tl:990

record ColorChooserButtonParam

Hinweise

Parameter eines Buttons, der eine Farbpalette öffnet.

Felder

Name	Typ	Beschreibung
colors	{Vec3f}	Farben, aus denen gewählt wird.
color	Vec3f	Aktuelle Farbe.
resetButton	boolean	Zeigt einen Zurücksetzen-Button.
innerResetButton	boolean
image	string	Bild auf dem Button.
toolTipPosition	integer	Position des Tooltips, ein Wert von builtin.type.ToolTipPosition.

Funktionen

onValueChange(Vec3f) base/tealdef/scripts/builtin.d.tl:993

Hinweise

Wird mit der gewählten Farbe aufgerufen.

Builtin.GradientLegendParam

record base/tealdef/scripts/builtin.d.tl:1004

record GradientLegendParam

Hinweise

Parameter einer Legende mit Farbverlauf.

Felder

Name	Typ	Beschreibung
colors	table	Farben des Verlaufs.
horizontal	boolean	Waagrechte Legende (sonst senkrecht).
discrete	boolean	Zeigt getrennte Farbstufen statt eines fließenden Verlaufs.
internalLabels	boolean

Builtin.ProgressBarParam

record base/tealdef/scripts/builtin.d.tl:1013

record ProgressBarParam

Hinweise

Parameter eines Fortschrittsbalkens.

Felder

Name	Typ	Beschreibung
value	number	must be in [0, 1]!
thresholds	{number}	must be in [0, 1]!
label	string	Text auf dem Balken.
applyGradient	boolean	defaults to true

Builtin.CheckBoxParam

record base/tealdef/scripts/builtin.d.tl:1024

record CheckBoxParam

use initialValue if your CheckBox is dumb (not referring to an external state) use value AND onValueChange your CheckBox refers to a state (in the parent recipe of the checkBox)

Felder

Name	Typ	Beschreibung
triStateSupport	boolean	nil defaults to false --> Note that this is only for toggling through when clicking, otherwise tristate is alwayws possible
initialValue	integer	Startwert, wenn die Checkbox ihren Zustand selbst verwaltet (0, 1 oder -1).
value	integer	Aktueller Wert, wenn ein übergeordneter Zustand die Checkbox steuert (0, 1 oder -1).
label	string	optional, click on text changes CheckBox state
moveBoxRight	boolean	default is false: Box is left, label is right

Funktionen

onValueChange(integer) base/tealdef/scripts/builtin.d.tl:1025

Hinweise

Wird mit dem neuen Wert aufgerufen, 0 (nicht angehakt), 1 (angehakt) oder -1 (unbestimmt).

Builtin.ComboBoxParam

record base/tealdef/scripts/builtin.d.tl:1033

record ComboBoxParam

Hinweise

Parameter einer Combobox (Dropdown-Liste).

Felder

Name	Typ	Beschreibung
value	integer | number | string	Wert des ausgewählten Eintrags.
items	{TreeNodeId}	Einträge, erzeugt mit ComboBoxItem.
compact	boolean	defaults to false, decides about visual appearance

Funktionen

onValueChange(newValue : integer | number | string) base/tealdef/scripts/builtin.d.tl:1036

Hinweise

Wird mit dem Wert des neu ausgewählten Eintrags aufgerufen.

onPopupChange(popupShown : boolean) base/tealdef/scripts/builtin.d.tl:1037

Hinweise

Wird aufgerufen, wenn die Dropdown-Liste aufgeht (true) oder sich schließt (false).

Builtin.ComboBoxItemParam

record base/tealdef/scripts/builtin.d.tl:1041

record ComboBoxItemParam

Hinweise

Ein Eintrag einer Combobox.

Felder

Name	Typ	Beschreibung
value	integer | number | string	Wert des Eintrags.
content	TreeNodeId	Inhalt, der für den Eintrag angezeigt wird.
available	boolean	False zeigt den Eintrag als nicht verfügbar.

Builtin.NativeFileDialogButtonParam

record base/tealdef/scripts/builtin.d.tl:1051

record NativeFileDialogButtonParam

Hinweise

Parameter eines Buttons, der den Dateidialog des Betriebssystems öffnet.

Felder

Name	Typ	Beschreibung
content	TreeNodeId	Inhalt des Buttons.
title	string	Titel des Dialogs.
filters	{{string, string}}	Dateitypfilter als Paare {label, extensions}. extensions ist eine kommagetrennte Liste ohne Punkte, zum Beispiel {{_("Images"), "png,jpg"}}.
intiialPath	string	Ordner, in dem sich der Dialog öffnet (der Feldname ist wirklich so geschrieben).

Funktionen

onOpen({string}) base/tealdef/scripts/builtin.d.tl:1053

Hinweise

Wird mit den ausgewählten Dateipfaden aufgerufen.

Builtin.DropComponentParam

record base/tealdef/scripts/builtin.d.tl:1061

record DropComponentParam

Hinweise

Parameter eines Bereichs, auf den man Dateien ziehen kann.

Felder

Name	Typ	Beschreibung
content	TreeNodeId	Inhalt des Bereichs.

Funktionen

onDrop({string}) base/tealdef/scripts/builtin.d.tl:1063

Hinweise

Wird mit den Pfaden der abgelegten Dateien aufgerufen.

Builtin.RadialMenuChildParam

record base/tealdef/scripts/builtin.d.tl:1068

record RadialMenuChildParam

Hinweise

Ein Eintrag eines Kreismenüs.

Felder

Name	Typ	Beschreibung
icon	string	Symbol des Eintrags.
tag	string	Tag des Eintrags.

Funktionen

onActivate() base/tealdef/scripts/builtin.d.tl:1070

Hinweise

Wird aufgerufen, wenn der Eintrag gewählt wird.

getInfoText() : string base/tealdef/scripts/builtin.d.tl:1071

Hinweise

Gibt den Text zurück, der angezeigt wird, solange der Eintrag hervorgehoben ist.

Rückgabe string

Builtin.RadialMenuParam

record base/tealdef/scripts/builtin.d.tl:1075

record RadialMenuParam

Hinweise

Parameter eines Kreismenüs.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/game_bar/game_bar.tl:1122

radialMenuRef : ReactRefWrapApiT<Builtin.RadialMenuParam, GameBar.RadialMenuApi>

Felder

Name	Typ	Beschreibung
mouseSupport	boolean	Erlaubt die Auswahl mit der Maus.
children	{TreeNodeId}	of type Builtin.RadialMenuChild

Funktionen

onHide() base/tealdef/scripts/builtin.d.tl:1076

Hinweise

Wird aufgerufen, wenn sich das Menü schließt.

getNoSelectionInfoText() : string base/tealdef/scripts/builtin.d.tl:1077

Hinweise

Gibt den Text zurück, der angezeigt wird, solange kein Eintrag hervorgehoben ist.

Rückgabe string

Builtin.TabWidgetParam

record base/tealdef/scripts/builtin.d.tl:1086

record TabWidgetParam

Hinweise

Parameter eines Tab-Widgets.

Felder

Name	Typ	Beschreibung
orientation	Type.TabOrientation	default: TabOrientation.North
deselectAllowed	boolean	default: false
indicatorsScrollable	boolean	default: true, works only with orientation = Type.North and Type.South
tabs	{TreeNodeId}	Registerkarten, erzeugt mit TabWidgetChild.
showIndicators	boolean	default: true
initialValue	integer | number | string	default: first child
value	integer | number | string	Index der aktiven Registerkarte.

Funktionen

onClose() base/tealdef/scripts/builtin.d.tl:1092

Hinweise

Wird aufgerufen, wenn das Tab-Widget geschlossen wird.

onValueChange(newValue : integer | number | string) base/tealdef/scripts/builtin.d.tl:1096

value of selected child, nil if nothing is selected (only if deselectAllowed == true)

Builtin.TabWidgetChildParam

record base/tealdef/scripts/builtin.d.tl:1099

record TabWidgetChildParam

Hinweise

Eine Registerkarte eines Tab-Widgets.

Felder

Name	Typ	Beschreibung
localKey	string	Schlüssel, der die Identität der Registerkarte zwischen zwei Renderings erhält.
indicator	TreeNodeId	Knoten, der in der Registerleiste angezeigt wird.
item	TreeNodeId	Inhalt der Registerkarte.
value	integer | number | string	must be not nil and must be unique within their TabWidget

Builtin.RowParam

record base/tealdef/scripts/builtin.d.tl:1112

record RowParam

Hinweise

Eine Zeile eines Tabellen-Layouts.

Felder

Name	Typ	Beschreibung
cells	{TreeNodeId}	Zellen der Zeile.

Builtin.TableLayoutParam

record base/tealdef/scripts/builtin.d.tl:1116

record TableLayoutParam

Hinweise

Parameter eines Tabellen-Layouts.

Felder

Name	Typ	Beschreibung
id	string	Element-ID.
columnWeights	{number}	Relative Breiten der Spalten, z. B. {3, 2}.
rows	{TreeNodeId}	instances of Builtin.Row

Builtin.TableCellParam

record base/tealdef/scripts/builtin.d.tl:1125

record TableCellParam

Hinweise

Parameter, die eine Datentabelle an ein Zellen-Recipe übergibt.

Im Basisspiel verwendet: 114-mal in 18 Dateien

base/content/game_mechanics/game_mechanics/notifications/gui/notification_log.tl:123

local NotificationLogMessage = react.RegisterRecipe("NotificationLogMessage", function(param : Builtin.TableCellParam) : TreeNodeId

base/content/gui/gui/entity_window/entity_window_util.tl:1371

local TableCellTargetState = react.RegisterRecipe("TableCellTargetState", function(params : Builtin.TableCellParam) : TreeNodeId

base/content/gui/gui/entity_window/industry/industry_eow.script.tl:195

local TableCellName = react.RegisterRecipe("TableCellName", function(params : Builtin.TableCellParam) : TreeNodeId

base/content/gui/gui/entity_window/line/line_eow.script.tl:99

local LineTableCellVehicle = react.RegisterRecipe("LineTableCellVehicle", function(params : Builtin.TableCellParam) : TreeNodeId

base/content/gui/gui/entity_window/maintenance_station/maintenance_station_eow.script.tl:17

local VehicleConditionCell = react.RegisterRecipe("VehicleConditionCell", function(params : Builtin.TableCellParam) : TreeNodeId

base/content/gui/gui/entity_window/town/town.tl:183

local TownTableCellName = react.RegisterRecipe("TownTableCellName", function(params : Builtin.TableCellParam) : TreeNodeId

… und 12 weitere Dateien.

Felder

Name	Typ	Beschreibung
rowKey	integer	Schlüssel der Zeile.
colKey	integer	Schlüssel der Spalte.
userParam	any	Der Benutzerparameter der Tabelle.

Builtin.TableCellParamT

record base/tealdef/scripts/builtin.d.tl:1131

record TableCellParamT<T>

Hinweise

Typisierte Parameter, die eine Datentabelle an ein Zellen-Recipe übergibt.

Im Basisspiel verwendet: 5-mal in 1 Datei

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

local TableCellModStatus = react.RegisterRecipe("TableCellModStatus", function(params : Builtin.TableCellParamT<SelectorApi>) : TreeNodeId

Felder

Name	Typ	Beschreibung
rowKey	integer	Schlüssel der Zeile.
colKey	integer	Schlüssel der Spalte.
userParam	T	Der Benutzerparameter der Tabelle.

Builtin.ColumnDescParam

record base/tealdef/scripts/builtin.d.tl:1137

record ColumnDescParam

Hinweise

Beschreibung einer Spalte einer Datentabelle.

Felder

Name	Typ	Beschreibung
name	string	Text der Spaltenüberschrift.
tooltip	string	Tooltip der Überschrift.
path	string	Symbol der Überschrift.
headerStyleClass	string	Style-Klasse der Überschrift.
weight	number	Relative Breite der Spalte.
recipe	IRecipe	with arg of type Builtin.TableCellParam
forceLexicographicalStringComparison	boolean	Force lexicographical string comparison for all strings (causing e.g. "Train 10" before "Train 2")

Funktionen

getCompareValue(rowKey : integer) : any base/tealdef/scripts/builtin.d.tl:1149

Get value to be used when sorting the table at C++. Sorting the table from C++ will use lang_util.compareStrings() to compare strings that are not themselves keys inside a table. For example, this will cause "Train 2" to be sorted before "Train 10". If needed, you can opt-out of this string comparison behavior by setting forceLexicographicalStringComparison = true.

Rückgabe any

Builtin.DataTableApi

record base/tealdef/scripts/builtin.d.tl:1155

record DataTableApi

Hinweise

API eines Datentabellen-Knotens.

Funktionen

scrollToRowKey(rowKey : integer, forceTopAlign : boolean) base/tealdef/scripts/builtin.d.tl:1158

note that this will not work in the 1st frame. You should always set for initial selection, use preferredInitialSelectionRowKey

Builtin.DataTableParam

record base/tealdef/scripts/builtin.d.tl:1160

record DataTableParam

Hinweise

Parameter einer Datentabelle, einer sortierbaren Tabelle aus Zellen-Recipes.

Felder

Name	Typ	Beschreibung
columns	{TreeNodeId}	instances of type Builtin.ColumnDesc
rowKeys	{integer}	Schlüssel der Zeilen, die angezeigt werden.
preferredInitialSelectionRowKey	integer	Zeile, die beim ersten Erscheinen der Tabelle ausgewählt ist.
disableSortKey	boolean
iaSort	string	InputAction key to change sorting (default: IA_OPTION2)
userParam	any	Input param given to NEWLY CREATED cells. Existing cells will NOT be updated! (-> use constants or pass a ref and read onStep inside the cell)
initialSortColumn	{integer, boolean}	1-based index of initial column, true if ASC, false if DESC
columnWeights	{number}	Removed. Use weight of ColumDesc instead.
scrollPolicyHorizontal	Type.ScrollBarPolicy	Wann die waagrechte Bildlaufleiste erscheint.
scrollPolicyVertical	Type.ScrollBarPolicy	Wann die senkrechte Bildlaufleiste erscheint.
keyboardNavigation	boolean	use arrow keys to navigate cells (instead of controlling scrollbars directly)

Funktionen

compareFn(colIndex : integer, rowKeyA : integer, rowKeyB : integer) : boolean base/tealdef/scripts/builtin.d.tl:1168

Deprecated: Function for table sorting. Prefer ColumnDescParam.getCompareValue instead.

Rückgabe boolean

fnUserFilter(integer) : boolean base/tealdef/scripts/builtin.d.tl:1171

Hinweise

Gibt false für Zeilen zurück, die ausgeblendet werden.

Rückgabe boolean

onSortColumnChange(columnIndex : integer, ascending : boolean) base/tealdef/scripts/builtin.d.tl:1173

Hinweise

Wird aufgerufen, wenn sich Sortierspalte oder Sortierreihenfolge ändert.

Builtin.WindowParam

record base/tealdef/scripts/builtin.d.tl:1186

record WindowParam

Hinweise

Parameter eines Fensters.

Felder

Name	Typ	Beschreibung
title	string	Fenstertitel.
closable	boolean	Zeigt den Schließen-Button.
movable	boolean	Das Fenster lässt sich verschieben.
pinnable	boolean	Zeigt den Pinnen-Button.
pinned	boolean	Das Fenster ist angepinnt.
autoFocusOnBecomingVisible	boolean	Gibt dem Fenster den Fokus, sobald es sichtbar wird.
autoVisibilityOnFocusChange	boolean
content	TreeNodeId	Inhalt des Fensters (Pflicht).
initialX	number	Startposition, X.
initialY	number	Startposition, Y.
titleEditable	boolean	Der Spieler kann den Titel bearbeiten (z. B. um eine Entität umzubenennen).
locateVisible	boolean	Zeigt den Anpeilen-Button.
id	string	Element-ID, z. B. "menu.pause". Darüber findet api.gui.byId das Fenster.
tool	string	Name des Werkzeugs, zu dem das Fenster gehört, z. B. "notification-log".
expanded	boolean	if true, specify expanded size with a css rule using !window-expanded, furthermore: !window-collapsed is set when returning from expanded mode (but not initially)
compact	boolean	if true, the content fills the entire window. Title bar gets reduced to some button (via !window-compact css rules) and overlaps with the content.
emptyNameAllowed	boolean	defaults to true
inputActionBubbleUpFilter	Type.InputActionBubbleUpFilter	Welche Eingabeaktionen das Fenster an sein Elternelement weitergibt.
header	TreeNodeId	Zusätzlicher Knoten in der Kopfzeile des Fensters.

Funktionen

onClose() base/tealdef/scripts/builtin.d.tl:1188

Hinweise

Wird aufgerufen, wenn das Fenster geschlossen wird.

onTitleChange(string) base/tealdef/scripts/builtin.d.tl:1199

Hinweise

Wird mit dem bearbeiteten Titel aufgerufen.

onLocate() base/tealdef/scripts/builtin.d.tl:1201

Hinweise

Wird aufgerufen, wenn der Anpeilen-Button gedrückt wird.

onPinned(boolean) base/tealdef/scripts/builtin.d.tl:1202

Hinweise

Wird aufgerufen, wenn das Fenster angepinnt oder gelöst wird.

Builtin.WindowContainerDelegateParam

record base/tealdef/scripts/builtin.d.tl:1212

record WindowContainerDelegateParam

Hinweise

Parameter des Fenster-Containers.

Im Basisspiel verwendet: 10-mal in 7 Dateien

base/content/gui/gui/main/game.tl:38

windowContainer : ReactRefWrapApiT<Builtin.WindowContainerDelegateParam, Builtin.WindowAPI>

base/content/gui/gui/main/pause_menu.tl:15

local quitWithConfirmation = function(quitString : string, windowContainer : ReactRefWrapApiT<Builtin.WindowContainerDelegateParam, Builtin.WindowAPI>, quit : f

base/content/gui/gui/menu/main_menu.tl:506

local windowContainer = react.useNodeRef() as ReactRefWrapApiT<Builtin.WindowContainerDelegateParam, Builtin.WindowAPI>

base/content/gui/gui/menu/mod_manager_react_util.tl:2810

wc : ReactRefWrapApiT<Builtin.WindowContainerDelegateParam, Builtin.WindowAPI>

base/content/gui/gui/menu/paradox_react_util.tl:288

wc : ReactRefWrapApiT<Builtin.WindowContainerDelegateParam, Builtin.WindowAPI>

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

windowContainer : ReactRefWrapApiT<Builtin.WindowContainerDelegateParam, Builtin.WindowAPI>,

… und 1 weitere Dateien.

Felder

Name	Typ	Beschreibung
redirectToComponentIdHack	string

Builtin.WindowAPI

record base/tealdef/scripts/builtin.d.tl:1216

record WindowAPI

Hinweise

API des Fenster-Containers, erreichbar über gameCtx.windowContainer:get():getApi().

Im Basisspiel verwendet: 27-mal in 16 Dateien

base/content/gui/gui/construction/construction.tl:20

local function getWindowApi(gameCtx : GameContext) : Builtin.WindowAPI

base/content/gui/gui/entity_window/view_manager.tl:12

local function getWindowApi(gameCtx : GameContext) : Builtin.WindowAPI

base/content/gui/gui/game_bar/game_bar.tl:25

local function getWindowApi(gameCtx : GameContext) : Builtin.WindowAPI

base/content/gui/gui/layers/layers_button_ridge.tl:25

local function getWindowApi(gameCtx : GameContext) : Builtin.WindowAPI

base/content/gui/gui/line_vehicle_mgmt/line_manager_panel.tl:60

local function getWindowApi() : Builtin.WindowAPI

base/content/gui/gui/line_vehicle_mgmt/manager_window.tl:4772

local wc : Builtin.WindowAPI = gameCtx.windowContainer:get():getApi()

… und 10 weitere Dateien.

Funktionen

note that if these reuse a window, they do not change its visibility

addSingletonWindow<T>(Recipe<T>, params : T) base/tealdef/scripts/builtin.d.tl:1218

Hinweise

Öffnet ein Fenster des Recipes. Von diesem Fenster gibt es höchstens eines.

addSingletonWindow<T, A>(RecipeWithApi<T, A>, params? : T) base/tealdef/scripts/builtin.d.tl:1219

Hinweise

Öffnet ein Fenster des Recipes. Von diesem Fenster gibt es höchstens eines.

addWindow<T>(Recipe<T>, key : string, params : T) base/tealdef/scripts/builtin.d.tl:1220

Hinweise

Öffnet ein Fenster des Recipes unter einem Schlüssel. Mit verschiedenen Schlüsseln können mehrere Fenster desselben Recipes offen sein.

note that these only move the window in z order, they do not change its visibility

moveSingletonWindowToFront(IRecipe) base/tealdef/scripts/builtin.d.tl:1223

Hinweise

Holt das einzige Fenster des Recipes in den Vordergrund.

moveSingletonWindowToFront<T>(Recipe<T>) base/tealdef/scripts/builtin.d.tl:1224

Hinweise

Holt das einzige Fenster des Recipes in den Vordergrund.

moveSingletonWindowToFront<T, A>(RecipeWithApi<T, A>) base/tealdef/scripts/builtin.d.tl:1225

Hinweise

Holt das einzige Fenster des Recipes in den Vordergrund.

moveWindowToFront(IRecipe, key : string) base/tealdef/scripts/builtin.d.tl:1226

Hinweise

Holt das Fenster des Recipes mit dem Schlüssel in den Vordergrund.

moveWindowToFront<T>(Recipe<T>, key : string) base/tealdef/scripts/builtin.d.tl:1227

Hinweise

Holt das Fenster des Recipes mit dem Schlüssel in den Vordergrund.

removeAllWindows<T>(Recipe<T>) base/tealdef/scripts/builtin.d.tl:1229

Hinweise

Schließt alle Fenster des Recipes.

removeAllWindows<T, A>(?RecipeWithApi<T, A>) base/tealdef/scripts/builtin.d.tl:1230

Hinweise

Schließt alle Fenster des Recipes.

removeWindow<T>(Recipe<T>, key : string) base/tealdef/scripts/builtin.d.tl:1231

Hinweise

Schließt das Fenster des Recipes mit dem Schlüssel.

Builtin.ToolStackContext

record base/tealdef/scripts/builtin.d.tl:1237

record ToolStackContext<T>

Hinweise

Kontext, den die Callbacks eines Werkzeugs bekommen.

Im Basisspiel verwendet: 38-mal in 9 Dateien

base/content/gui/gui/construction/construction.tl:5057

local makeToolWindowParam = function(toolParam : ConstructionToolParam, ctx : Builtin.ToolStackContext<ConstructionToolParam>) : ConstructionToolWindowParam

base/content/gui/gui/entity_window/view_manager.tl:91

local makeWindowParams : function(param : EntityDetailsToolParam, ctx : Builtin.ToolStackContext<EntityDetailsToolParam>,

base/content/gui/gui/layers/layers_button_ridge.tl:88

local makeToolWindowParam = function(toolParam : LayerToolParamInternal, ctx : Builtin.ToolStackContext<LayerToolParamInternal>) : LayerToolWindowParam

base/content/gui/gui/line_vehicle_mgmt/manager_window.tl:8283

local makeToolWindowParam = function(toolParam : ManagerWindow.ManagerToolParam, ctx : Builtin.ToolStackContext<ManagerWindow.ManagerToolParam>) : ToolReactUtil

base/content/gui/gui/main/free_cam_options.tl:38

push = function(ctx : Builtin.ToolStackContext<FreeCamOptions.FreeCamToolParam>, toolParam : FreeCamOptions.FreeCamToolParam)

base/content/gui/gui/main/pause_menu.tl:430

pauseMenuToolImpl.pop = function(ctx : Builtin.ToolStackContext<ToolReactUtil.IToolParam>, param : ToolReactUtil.IToolParam)

… und 3 weitere Dateien.

Funktionen

setActionFn(actionFn? : (function() : TreeNodeId), key2? : string) base/tealdef/scripts/builtin.d.tl:1238

Hinweise

Setzt die Funktion, die den Action-Knoten des Werkzeugs (z. B. eine ConstructionAction) für die 3D-Ansicht erzeugt. Mit nil wird sie entfernt.

popSelf() base/tealdef/scripts/builtin.d.tl:1239

shortcut to toolStackApi.pop(recipe, key)

setVariantOverride(string) base/tealdef/scripts/builtin.d.tl:1240

Hinweise

Überschreibt die aktive Variante des Werkzeugs.

Builtin.ToolStackAPI

record base/tealdef/scripts/builtin.d.tl:1242

record ToolStackAPI

Hinweise

API des Werkzeug-Stacks.

Im Basisspiel verwendet: 11-mal in 11 Dateien

base/content/game_mechanics/game_mechanics/notifications/gui/notification_button.tl:5

local function getToolStackApi(gameCtx : GameContext) : Builtin.ToolStackAPI

base/content/gui/gui/construction/construction.tl:178

local function getToolStackApi(gameCtx : GameContext) : Builtin.ToolStackAPI

base/content/gui/gui/entity_window/view_manager.tl:15

local function getToolStackApi(gameCtx : GameContext) : Builtin.ToolStackAPI

base/content/gui/gui/game_bar/game_bar.tl:22

local function getToolStackApi(gameCtx : GameContext) : Builtin.ToolStackAPI

base/content/gui/gui/game_bar/game_bar_widgets.tl:66

local function getToolStackApi(gameCtx : GameContext) : Builtin.ToolStackAPI

base/content/gui/gui/layers/layers_button_ridge.tl:28

local function getToolStackApi(gameCtx : GameContext) : Builtin.ToolStackAPI

… und 5 weitere Dateien.

Funktionen

push<T>(ReactToolDefinition<T>, key : string, params? : T, allowStacking : boolean) base/tealdef/scripts/builtin.d.tl:1243

Hinweise

Legt ein Werkzeug mit Schlüssel und Parametern auf den Stack. Ist allowStacking false, werden vorher alle anderen Werkzeuge außer dem Standardwerkzeug entfernt.

pop<T>(ReactToolDefinition<T>, key : string) base/tealdef/scripts/builtin.d.tl:1244

Hinweise

Entfernt das Werkzeug mit dem Schlüssel vom Stack.

pop(tool : IReactToolDefinition, key : string) base/tealdef/scripts/builtin.d.tl:1245

Hinweise

Entfernt das Werkzeug mit dem Schlüssel vom Stack.

clear() base/tealdef/scripts/builtin.d.tl:1246

Hinweise

Entfernt alle Werkzeuge außer dem Standardwerkzeug.

setActionsDisabled(block : boolean) base/tealdef/scripts/builtin.d.tl:1247

start/end behaving as if actionFn would always be nil

getActiveTool() : IReactToolDefinition, string base/tealdef/scripts/builtin.d.tl:1248

Hinweise

Gibt das oberste Werkzeug des Stacks und seinen Schlüssel zurück.

Rückgabe IReactToolDefinition, string

Builtin.ToolStackParam

record base/tealdef/scripts/builtin.d.tl:1250

record ToolStackParam

Hinweise

Parameter des Werkzeug-Stacks.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/main/game.tl:612

function game_react_globals.getDefaultToolStack() : ReactRefWrapApiT<Builtin.ToolStackParam, Builtin.ToolStackAPI>

Felder

Name	Typ	Beschreibung
rendererComponent	ReactRefWrapApiT<Builtin.RendererComponentParam, Builtin.RenderComponentAPI>	Renderer-Komponente (3D-Ansicht), in der die Werkzeuge wirken.
defaultTool	ReactToolDefinition	Werkzeug, das gilt, wenn der Stack leer ist.
defaultToolParam	any	Parameter des Standardwerkzeugs.
defaultToolKey	string	Schlüssel des Standardwerkzeugs.
showDebugVisualization	boolean	Zeigt Debug-Ausgaben des Werkzeug-Stacks.

Builtin.HudIconParam

record base/tealdef/scripts/builtin.d.tl:1261

record HudIconParam

Hinweise

Parameter, die ein HUD-Symbol-Recipe für eine Entität bekommt.

Im Basisspiel verwendet: 35-mal in 22 Dateien

base/content/game_mechanics/game_mechanics/emission/pollution_cleanup_facility_hud.script.tl:19

hudIconFn = function(captureParams : any, _params : Builtin.HudIconParam, _userParam : HudIconToolbox.HudIconMasterUserParam) : TreeNodeId

base/content/gui/gui/construction/constructionHudIconMaster.tl:12

function(param : Builtin.HudIconParam, userParam : ConstructionActionHudIconParams) : TreeNodeId

base/content/gui/gui/construction/construction_react_util.tl:8

local ConstructionMenuHudIconMaster = ug_require "/gui/construction/constructionHudIconMaster.tl" as Recipe2<Builtin.HudIconParam, ConstructionActionHudIconPara

base/content/gui/gui/entity_window/entity_window_hud.tl:142

entity_window_hud.IndustryHudIconMaster = react.RegisterRecipe("IndustryHudIconMaster", function(param : Builtin.HudIconParam, userParam : EntityWindowHud.Entit

base/content/gui/gui/layers/layer_cargo.tl:44

layer_cargo.HudIconMaster = react.RegisterRecipe("LayerCargoHudIconMaster", function(params : Builtin.HudIconParam, userParam : LayerCargo.HudIconUserParam) : T

base/content/gui/gui/layers/layer_cargo_flow.tl:50

layer_cargo_flow.HudIconMaster = react.RegisterRecipe("LayerCargoFlowHudIconMaster", function(param : Builtin.HudIconParam, userParam : LayerCargoFlow.HudIconUs

… und 16 weitere Dateien.

Felder

Name	Typ	Beschreibung
entity	Engine.Entity	Die Entität, zu der das Symbol gehört.
index	integer
details	Gui.SelectionDetails	Auswahldetails der Entität oder Unterentität.
internalLayer	integer
internalPhysicsImpact	integer

Builtin.HudIconChildConfigParam

record base/tealdef/scripts/builtin.d.tl:1270

record HudIconChildConfigParam

Hinweise

Umhüllt einen HUD-Symbol-Knoten.

Felder

Name	Typ	Beschreibung
item	TreeNodeId	Der Symbol-Knoten.
selectorSupport	boolean	true to allow selector hover event while mouse hovers the item. nil to inherit from parent (root defaults to true).
overrideSelectionDetails	boolean	true to override selectionDetails for the above feature, false to use the one from HudIconParamT. nil to inherit from parent (root defaults to false)
selectionDetails	Gui.SelectionDetails	if overrideSelectionDetails == true, the selectionDetails to be used

Builtin.HudIconManagerConfigParam

record base/tealdef/scripts/builtin.d.tl:1278

record HudIconManagerConfigParam<T>

Hinweise

Konfiguriert die HUD-Symbole eines Karten-Layers.

Im Basisspiel verwendet: 2-mal in 1 Datei

base/content/gui/gui/construction/construction_react_util.tl:1256

local getHudIconManagerParams = function(definition : ConstructionDefinition, accessNotificationCacheFn : (function(Engine.Entity) : {Notification})) : Builtin.

Felder

Name	Typ	Beschreibung
userParam	T	Wert, der als zweiter Parameter an das Master-Recipe geht.
masterRecipe	Recipe2<HudIconParam, T>	Recipe, das für jede Entität das Symbol erzeugt.
preFilter	{Engine.ComponentType}	List components for which the HUD icons will be created and shown Subconstruction filter only applies to subconstruction that are of no other type
preFilterTvCarriers	{Carrier}	In case you have TransportVehicle in you preFilter, this additionally filters for its carriers
showCosts	boolean	Zeigt Kosten-Pop-ups.
showIncome	boolean	Zeigt Einnahmen-Pop-ups.
incomeSFX	{FilePath}	only active if showIncome is true
costsRenderDistance	number	Kameraabstand, bis zu dem Kosten-Pop-ups erscheinen.
transportVehiclePainter	any	variant nil|LineVehicleColor|TrafficColor|EmissionEmitterColor|MaintainedTransportVehicleColor
fallbackColor	LayerConfig.ColorPassFn.FallbackColor	should be set whenever transportVehiclePainter is provided
localKey	string	Schlüssel, der die Identität des Knotens zwischen zwei Renderings erhält.
visibilityThresholds	Builtin.Type.VisibilityThresholds	Regeln nach Kameraabstand pro Entitätstyp.
vehicleIconOffsets	{Carrier : Vec3f}	Versatz der Fahrzeugsymbole pro Verkehrsträger.

Builtin.RendererComponentParam

record base/tealdef/scripts/builtin.d.tl:1303

record RendererComponentParam

Hinweise

Parameter der Renderer-Komponente (der 3D-Ansicht).

Im Basisspiel verwendet: 4-mal in 2 Dateien

base/content/gui/gui/main/game.tl:37

rc : ReactRefWrapApiT<Builtin.RendererComponentParam, Builtin.RenderComponentAPI>

base/content/gui/gui/main/selector_react_util.tl:88

function selector_react_util.makeDefaultSelector(refRC : ReactRefWrapApiT<Builtin.RendererComponentParam, Builtin.RenderComponentAPI>, selectedEntityRef : React

Felder

Name	Typ	Beschreibung
toolStack	ReactRefWrapApiT<ToolStackParam, ToolStackAPI>	Werkzeug-Stack, dessen oberstes Werkzeug in der Ansicht wirkt.
redirectToComponentIdHack	string

Builtin.RenderComponentAPI

record base/tealdef/scripts/builtin.d.tl:1308

record RenderComponentAPI

Hinweise

API der Renderer-Komponente.

Im Basisspiel verwendet: 4-mal in 2 Dateien

base/content/gui/gui/main/game.tl:37

rc : ReactRefWrapApiT<Builtin.RendererComponentParam, Builtin.RenderComponentAPI>

base/content/gui/gui/main/selector_react_util.tl:88

function selector_react_util.makeDefaultSelector(refRC : ReactRefWrapApiT<Builtin.RendererComponentParam, Builtin.RenderComponentAPI>, selectedEntityRef : React

Funktionen

bindAction(ref : ReactRefWrap, (function() : TreeNodeId), key2? : string) base/tealdef/scripts/builtin.d.tl:1309

Die Spieldateien enthalten hierzu noch keine Beschreibung.

unbindAction(ref : ReactRefWrap) base/tealdef/scripts/builtin.d.tl:1310

Die Spieldateien enthalten hierzu noch keine Beschreibung.

Builtin.EntityRendererComponentParams

record base/tealdef/scripts/builtin.d.tl:1313

record EntityRendererComponentParams

Hinweise

Parameter einer Entitätsansicht.

Felder

Name	Typ	Beschreibung
entity	Engine.Entity	Die Entität, die angezeigt wird.

Builtin.EdgeRenderableParam

record base/tealdef/scripts/builtin.d.tl:1317

record EdgeRenderableParam

Hinweise

Parameter von Kantenhervorhebungen in der 3D-Ansicht.

Felder

Name	Typ	Beschreibung
edges	{Type.EdgeRenderable.Edge}	Die Kanten, die gezeichnet werden.
ignoreDepth	boolean	Zeichnet die Kanten über allem anderen.

Builtin.MissionArrowRenderableParam

record base/tealdef/scripts/builtin.d.tl:1322

record MissionArrowRenderableParam

Hinweise

Parameter von Missionspfeilen.

Felder

Name	Typ	Beschreibung
arrows	{Type.MissionArrowRenderable.Arrow}	Die Pfeile, die gezeichnet werden.

Builtin.TerrainCirclePolicy

enum base/tealdef/scripts/builtin.d.tl:1331

enum TerrainCirclePolicy

Hinweise

Wann der Kreis unter dem Mauszeiger auf das Gelände gezeichnet wird.

Im Basisspiel verwendet: 3-mal in 2 Dateien

base/content/gui/gui/line_vehicle_mgmt/line_util.tl:985

setTerrainCirclePolicy = function(terrainCirclePolicy : Builtin.TerrainCirclePolicy)

base/content/gui/gui/line_vehicle_mgmt/manager_window.tl:503

ctx.setTerrainCirclePolicy(app_util.getMouseOrGamepad("Never", "Always") as Builtin.TerrainCirclePolicy)

Wert	Beschreibung
"FocusSelection"	Nur um die fokussierte Auswahl.
"Always"	Immer.
"IfNoEntity"	Nur, wenn der Mauszeiger über keiner Entität ist.
"Never"	Nie.

Builtin.ActionDescriptorParam

record base/tealdef/scripts/builtin.d.tl:1338

record ActionDescriptorParam

Hinweise

Beschreibt die aktive Action in der 3D-Ansicht (Werkzeugname, Layer, Eingabehinweise).

Felder

Name	Typ	Beschreibung
tool	string	Name des Werkzeugs.
layer	string	Karten-Layer, der während der Action angezeigt wird.
terrainCirclePolicy	TerrainCirclePolicy	Wann der Geländekreis gezeichnet wird.
highlightedEntities	{Engine.Entity}	Entitäten, die hervorgehoben werden.
crosshair	boolean	Zeigt das Fadenkreuz (das Basisspiel zeigt es im Gamepad-Modus).
parent	ReactNodeRef	Elternknoten der Action.
horizontalPromptList	boolean	Ordnet die Button-Hinweise waagrecht an.
children	{TreeNodeId}	Kindknoten der Action.

Funktionen

onBack() base/tealdef/scripts/builtin.d.tl:1345

Hinweise

Wird aufgerufen, wenn der Spieler die Action verlässt.

Builtin.ActionTooltipParam

record base/tealdef/scripts/builtin.d.tl:1350

record ActionTooltipParam<T>

Hinweise

Tooltip, der während einer Action am Mauszeiger erscheint.

Im Basisspiel verwendet: 14-mal in 3 Dateien

base/content/gui/gui/construction/construction_react_util.tl:1285

local tooltipHolder : ReactRefT<ReactStateT<Builtin.ActionTooltipParam<any>>> = react.useRef()

base/content/gui/gui/construction/tools/industry_greenify_tool.script.tl:28

local tooltip : Builtin.ActionTooltipParam<ConstructionReactUtil.SimpleTooltipRecipeParams> = nil

base/content/gui/gui/construction/tools/marketing_campaign_tool.script.tl:35

local tooltip : Builtin.ActionTooltipParam<ConstructionReactUtil.SimpleTooltipRecipeParams> = nil

Felder

Name	Typ	Beschreibung
recipe	Recipe<T>	Recipe für den Inhalt des Tooltips.
param	T	Parameter, der an das Recipe geht.

Builtin.ConstructionActionParam

record base/tealdef/scripts/builtin.d.tl:1355

record ConstructionActionParam

Hinweise

Parameter einer Bau-Action in der 3D-Ansicht. Setze den Deskriptor der gewünschten Werkzeugart, z. B. constructionBuilder, um eine Konstruktion zu platzieren, oder bulldozer, um Objekte zu entfernen.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/construction/construction_react_util.tl:3146

repository : ConstructionActionRepository, entity : Engine.Entity) : Builtin.ConstructionActionParam

Felder

Name	Typ	Beschreibung
modifierColor	Type.ConstructionAction.ModifierColor	Hervorhebungsfarben der Änderungswerkzeuge.
constructionBuilder	Type.ConstructionAction.ConstructionBuilder	Einstellungen zum Platzieren von Konstruktionen.
streetEdgeBuilder	Type.ConstructionAction.StreetEdgeBuilder	Einstellungen zum Bauen von Straßen.
trackEdgeBuilder	Type.ConstructionAction.TrackEdgeBuilder	Einstellungen zum Bauen von Gleisen.
streetEdgeNodeModifier	Type.ConstructionAction.StreetEdgeNodeModifier	Einstellungen zum Ändern von Straßen.
trackEdgeModifier	Type.ConstructionAction.TrackEdgeModifier	Einstellungen zum Ändern von Gleisen.
edgeObjectBuilder	Type.ConstructionAction.EdgeObjectBuilder	Einstellungen zum Platzieren von Kantenobjekten (Straßenhaltestellen, Signale).
laneModifier	Type.ConstructionAction.LaneModifier	Einstellungen zum Ändern von Fahrspuren.
crosswalkModifier	Type.ConstructionAction.CrosswalkModifier	Einstellungen zum Ändern von Fußgängerstreifen.
terrainModifier	Type.ConstructionAction.TerrainModifier	Einstellungen zum Formen des Geländes.
terrainPainter	Type.ConstructionAction.TerrainPainter	Einstellungen zum Bemalen des Geländes.
assetBrush	Type.ConstructionAction.AssetBrush	Einstellungen zum Platzieren von Assets mit einem Pinsel.
townBuilder	Type.ConstructionAction.TownBuilder	Einstellungen zum Gründen von Städten.
bulldozer	Type.ConstructionAction.Bulldozer	Einstellungen zum Abreißen.
moduleBuilder	Type.ConstructionAction.ModuleBuilder	Einstellungen zum Platzieren von Modulen.
moduleBulldozer	Type.ConstructionAction.ModuleBulldozer	Einstellungen zum Entfernen von Modulen.
inputActions	{string : string}	Zusätzliche Eingabeaktionen der Action, nach Name.
inputActionPrompts	{string : string}	Hinweistext pro Eingabeaktion.
inputActionActive	{string : boolean}	Aktiv-Flag pro Eingabeaktion.
preventFocusStealFromIds	{string}	Element-IDs, denen die Action den Fokus nicht wegnimmt.

Funktionen

getProposalStringsFn(proposal : Proposal, proposalData : ProposalData) : {string} base/tealdef/scripts/builtin.d.tl:1373

Hinweise

Gibt Textzeilen für den aktuellen Bauvorschlag zurück.

Rückgabe {string}

inputActionsHandler(string) base/tealdef/scripts/builtin.d.tl:1376

Hinweise

Wird mit dem Namen einer ausgelösten Eingabeaktion aufgerufen.

Builtin.SimpleInputActionsParam

record base/tealdef/scripts/builtin.d.tl:1386

record SimpleInputActionsParam

Hinweise

Parameter einer Gruppe von Eingabeaktionen.

Felder

Name	Typ	Beschreibung
inputActions	{string : string}	Eingabeaktionen, nach Name.

Funktionen

inputActionsHandler(string) base/tealdef/scripts/builtin.d.tl:1388

Hinweise

Wird mit dem Namen einer ausgelösten Eingabeaktion aufgerufen.

Builtin.SelectorParam

record base/tealdef/scripts/builtin.d.tl:1392

record SelectorParam

Hinweise

Parameter des Entitäts-Selektors in der 3D-Ansicht.

Felder

Name	Typ	Beschreibung
lineViewerSupport	boolean	Erlaubt die Auswahl von Linien, die der Line-Viewer zeichnet.
stopOnMenuBack	boolean	Beendet die Auswahl mit der Zurück-Eingabeaktion.
selectionColor	Vec4f	Hervorhebungsfarbe der Auswahl.
selectionOutlineColor	Vec4f	Umrissfarbe der Auswahl.
selectionOutlineColor1	Vec4f	Zweite Umrissfarbe der Auswahl.
circleBorderColor	Vec4f	Randfarbe des Selektor-Kreises.
circleFillColor	Vec4f	Füllfarbe des Selektor-Kreises.
circleBorderWidth	number	Randbreite des Selektor-Kreises.
circleAnimEasing	Easing	Easing der Kreisanimation.
circleAnimDuration	number	Dauer der Kreisanimation.
crosshairColor	Vec4f	Farbe des Fadenkreuzes.

Funktionen

onSelect(entity : Engine.Entity, indices : {integer}, details : Gui.SelectionDetails) : boolean base/tealdef/scripts/builtin.d.tl:1393

Hinweise

Wird aufgerufen, wenn eine Entität ausgewählt wird.

Rückgabe boolean

onSelectSecondary(entity : Engine.Entity, indices : {integer}, details : Gui.SelectionDetails) : boolean base/tealdef/scripts/builtin.d.tl:1394

Hinweise

Wird aufgerufen, wenn eine Entität mit der zweiten Maustaste ausgewählt wird.

Rückgabe boolean

onHover(entity : Engine.Entity, indices : {integer}, details : Gui.SelectionDetails) base/tealdef/scripts/builtin.d.tl:1395

Hinweise

Wird aufgerufen, wenn der Mauszeiger über eine Entität fährt.

filter(entity : Engine.Entity) base/tealdef/scripts/builtin.d.tl:1396

Hinweise

Gibt false für Entitäten zurück, die nicht auswählbar sind.

terminalFilter(stationGroupEntity : Engine.Entity, stationTerminal : StationTerminal, flatTerminalIndex : integer) base/tealdef/scripts/builtin.d.tl:1397

Hinweise

Gibt false für Stationsterminals zurück, die nicht auswählbar sind.

onProcessMouseEvent(evt : Gui.Mouse.Event) : boolean base/tealdef/scripts/builtin.d.tl:1400

Hinweise

Wird mit Mausereignissen aufgerufen, bevor der Selektor sie verarbeitet.

Rückgabe boolean

Builtin.FullScreenComponentParam

record base/tealdef/scripts/builtin.d.tl:1417

record FullScreenComponentParam<T>

Hinweise

Inhalt eines Vollbild-Overlays.

Felder

Name	Typ	Beschreibung
recipe	Recipe<T>	Recipe für den Inhalt des Overlays.
param	T	Parameter, der an das Recipe geht.

Builtin.LineViewerParam

record base/tealdef/scripts/builtin.d.tl:1424

record LineViewerParam

Hinweise

Parameter des Line-Viewers, der Linien und Haltestellen in der 3D-Ansicht zeichnet.

Felder

Name	Typ	Beschreibung
selectable	boolean	Linien sind auswählbar.
carriers	{Carrier}	Verkehrsträger, deren Linien gezeichnet werden.
highlightedLine	Engine.Entity	Linie, die hervorgehoben wird.
highlightedLineStop	integer	Haltestelle der hervorgehobenen Linie, die hervorgehoben wird.
highlightedLineWaypoint	integer	Wegpunkt der hervorgehobenen Linie, der hervorgehoben wird.
showTerminals	boolean	Zeichnet die Stationsterminals.
highlightedTerminal	StationTerminal	Terminal, das hervorgehoben wird.
maxSnapFactorView	number
maxSnapFactorWorld	number
fadingMinHeight	number
fadingDeltaHeight	number
highlightedTerminalNodes	{{Engine.Entity, StationTerminal}}	Terminals, die hervorgehoben werden, als Paare {station, terminal}.
showLineTerminalsFor	Engine.Entity	Linie, deren Terminals angezeigt werden.
highlightStop	Gui.SelectionDetails.Stop	Haltestelle, die hervorgehoben wird.
highlightWaypoint	{Engine.Entity, integer, integer}	waypoint to highlight (line entity, zero-based stopIndex, waypoint tag)
snapPreview	Gui.SelectionDetails.TransportNetworkEdge
showLines	{Builtin.Type.LineVisualization}	Linien, die gezeichnet werden, mit Transparenz.
hiddenLinesTransparent	boolean	default is true --> if set to false, the lines are completely invisible (refers to all the lines filtered away with "showLines")
continuousRenderLine	Engine.Entity
preferLineOverTransportNetworkEdge	boolean	default is true --> if set to false, it enables building waypoints on (already existing) lines

Builtin.ProposalViewerParam

record base/tealdef/scripts/builtin.d.tl:1450

record ProposalViewerParam

Hinweise

Parameter des Proposal-Viewers, der eine Vorschau eines Bauvorschlags in der 3D-Ansicht zeigt.

Felder

Name	Typ	Beschreibung
simpleProposal	SimpleProposal	Bauvorschlag für die Vorschau (einfache Form).
proposal	Proposal	Bauvorschlag für die Vorschau.
controlPointInfo	Type.ControlPointInfo	Kontrollpunkt, der angezeigt wird.
entityForRefundableContext	Engine.Entity
proposalId	string	ID des Bauvorschlags.

Funktionen

onCreateProposalData(ProposalData, Proposal) base/tealdef/scripts/builtin.d.tl:1454

Hinweise

Wird mit den verarbeiteten Daten des Bauvorschlags aufgerufen.

Builtin.MapPreviewCompParam

record base/tealdef/scripts/builtin.d.tl:1459

record MapPreviewCompParam

Hinweise

Parameter der Kartenvorschau auf den Bildschirmen für ein neues Spiel und den Karten-Editor.

Felder

Name	Typ	Beschreibung
mapColoring	PreviewColoring	Einfärbung der Vorschau.
showMapSize	boolean	Zeigt die Kartengröße.
showTownAndIndustryCount	boolean	Zeigt die Anzahl der Städte und Industrien.
showBiomesColors	boolean	Färbt die Biome ein.
inputMap	GameMap	Karte, die angezeigt wird.
mode	any	HeighmapGenerationMode | TownIndustryGenerationMode
locationsConfig	BaseConfig.Locations	Einstellungen zu Städten und Industrien für die Vorschau.
economy	string	Wirtschaftseinstellung.
initialMap	GameMap	use this when creating for the 1st time (instead of recomputing)

Funktionen

onReady(map : GameMap, feedback : {string}) base/tealdef/scripts/builtin.d.tl:1468

Hinweise

Wird aufgerufen, wenn die Vorschaukarte fertig ist.

onTownConnectionsChanged({{integer, integer}}) base/tealdef/scripts/builtin.d.tl:1469

Die Spieldateien enthalten hierzu noch keine Beschreibung.

Builtin.NodeViewerParam

record base/tealdef/scripts/builtin.d.tl:1475

record NodeViewerParam

Die Spieldateien enthalten hierzu noch keine Beschreibung.

Felder

Name	Typ	Beschreibung
nodeConfig	{Engine.Entity : {integer, Vec4f}}

Builtin.ICompParam

interface base/tealdef/scripts/builtin.d.tl:1488

interface ICompParam

Hinweise

Parameter eines Widgets für eine Entitätskomponente.

Felder

Name	Typ	Beschreibung
entity	Engine.Entity	Die Entität.

Builtin.RailroadCrossingCompParam

record base/tealdef/scripts/builtin.d.tl:1492

record RailroadCrossingCompParam is ICompParam

Hinweise

Parameter des Widgets für Bahnübergänge.

Builtin.SignalCompParam

record base/tealdef/scripts/builtin.d.tl:1494

record SignalCompParam is ICompParam

Hinweise

Parameter des Signal-Widgets.

Builtin.ReactAdapterHost

record base/tealdef/scripts/builtin.d.tl:1502

record ReactAdapterHost

Die Spieldateien enthalten hierzu noch keine Beschreibung.

Builtin.ReactAdapterHostEventParam

record base/tealdef/scripts/builtin.d.tl:1504

record ReactAdapterHostEventParam

Die Spieldateien enthalten hierzu noch keine Beschreibung.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/main/game.tl:208

react.onEvent("mountReactAdapterHost", function(__ : string, adapterParams : Builtin.ReactAdapterHostEventParam)

Felder

Name	Typ	Beschreibung
component	ReactAdapterHost
type	string
param	any

Builtin.ReactAdapterGuestContainerAPI

record base/tealdef/scripts/builtin.d.tl:1510

record ReactAdapterGuestContainerAPI

Die Spieldateien enthalten hierzu noch keine Beschreibung.

Funktionen

add(host : ReactAdapterHost, recipeFn : Recipe, recipeParam : any) base/tealdef/scripts/builtin.d.tl:1511

Die Spieldateien enthalten hierzu noch keine Beschreibung.

remove(host : ReactAdapterHost) base/tealdef/scripts/builtin.d.tl:1512

Die Spieldateien enthalten hierzu noch keine Beschreibung.