react

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

Hinweise

Typen der React-artigen Bibliothek der GUI, ::/gui/main/react.lua (React). Ein Recipe ist eine Funktion, die GUI-Knoten zurückgibt. Du registrierst es einmal mit React.RegisterRecipe und rufst es dann wie eine Funktion auf, um Knoten zu erzeugen. Innerhalb eines Recipes halten Hooks wie useState, useRef, onStep und onEvent Zustand über mehrere Renderdurchläufe. Die eingebauten Widgets liegen in ::/gui/main/builtin.lua (Builtin).

Beispiel

-- aus base/content/gui/gui/main/main_mod_button_area.tl (gekürzt)
local react = ug_require "::/gui/main/react.lua" as React
local builtin = ug_require "::/gui/main/builtin.lua" as Builtin

local MainModButtonArea = react.RegisterRecipe("MainModButtonArea", function(params : MainModButtonAreaParams) : TreeNodeId
    local selfRef = react.useSelfRef()
    local focusableState = react.useState(false)

    react.onEvent("focusMainModButtonArea", function()
        focusableState:set(true)
        selfRef:get():focus()
    end)
    react.useInputAction("IA_MENU_BACK", react.iaHandler(function()
        focusableState:set(false)
    end))

    return builtin.FloatingLayout {
        children = {
            builtin.ScrollArea {
                meta = { disableFocusableRecursive = not focusableState:old() },
                content = builtin.Component { meta = { class = "scroll-area-content" } },
            },
        },
    }
end)

Globale Namen

Typen

Name	Definition	Beschreibung
Builtin	hier deklariert, definiert in Builtin	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.

RefFill

record global base/tealdef/scripts/react.d.tl:5

global record RefFill

Hinweise

Markierung, die React.ref zurückgibt. Als erstes Argument eines Recipe-Aufrufs füllt sie eine Node-Ref mit dem erzeugten Knoten.

ReactStyle

record base/tealdef/scripts/react.d.tl:7

record ReactStyle

Hinweise

Markierung, die React.style zurückgibt. Vor den Parametern eines Recipe-Aufrufs setzt sie Style-Klassen.

IRecipeParamWithMeta

interface global base/tealdef/scripts/react.d.tl:9

global interface IRecipeParamWithMeta

Hinweise

Recipe-Parameter, die eine Tabelle meta annehmen.

Felder

Name	Typ	Beschreibung
meta	Meta	Allgemeine Knoteneinstellungen (Style-Klasse, lokaler Schlüssel, Tooltip, Fokus, Tag); siehe Meta.

TreeNodeId

record global base/tealdef/scripts/react.d.tl:13

global record TreeNodeId

Hinweise

Handle eines GUI-Knotens, den ein Recipe-Aufruf erzeugt hat. Recipes geben einen solchen Handle, eine Liste davon oder nil zurück.

IRecipe

interface global base/tealdef/scripts/react.d.tl:15

global interface IRecipe

Hinweise

Alles, was sich als Recipe aufrufen lässt.

Funktionen

metamethod __call(IRecipe, any) : TreeNodeId base/tealdef/scripts/react.d.tl:16

Aufruf: IRecipe(…)

Hinweise

Erzeugt einen Knoten dieses Recipes.

Rückgabe TreeNodeId

Recipe0

record global base/tealdef/scripts/react.d.tl:19

global record Recipe0 is IRecipe

Hinweise

Ein Recipe ohne Parameter, wie es RegisterRecipe für eine Funktion ohne Argumente zurückgibt.

Funktionen

metamethod __call(Recipe0) : TreeNodeId base/tealdef/scripts/react.d.tl:20

Aufruf: Recipe0(…)

Hinweise

Erzeugt einen Knoten: MyRecipe(). Optional davor stehen ein React.ref(...) und ein React.style{...}.

Rückgabe TreeNodeId

metamethod __call(Recipe0, RefFill) : TreeNodeId base/tealdef/scripts/react.d.tl:21

Aufruf: Recipe0(…)

Hinweise

Erzeugt einen Knoten: MyRecipe(). Optional davor stehen ein React.ref(...) und ein React.style{...}.

Rückgabe TreeNodeId

metamethod __call(Recipe0, ReactStyle) : TreeNodeId base/tealdef/scripts/react.d.tl:22

Aufruf: Recipe0(…)

Hinweise

Erzeugt einen Knoten: MyRecipe(). Optional davor stehen ein React.ref(...) und ein React.style{...}.

Rückgabe TreeNodeId

metamethod __call(Recipe0, RefFill, ReactStyle) : TreeNodeId base/tealdef/scripts/react.d.tl:23

Aufruf: Recipe0(…)

Hinweise

Erzeugt einen Knoten: MyRecipe(). Optional davor stehen ein React.ref(...) und ein React.style{...}.

Rückgabe TreeNodeId

Recipe

record global base/tealdef/scripts/react.d.tl:26

global record Recipe<T> is IRecipe

Hinweise

Ein Recipe mit einer Parametertabelle T.

Funktionen

metamethod __call(Recipe<T>, ?T) : TreeNodeId base/tealdef/scripts/react.d.tl:27

Aufruf: Recipe(…)

Hinweise

Erzeugt einen Knoten: MyRecipe(params). Optional davor stehen ein React.ref(...) und ein React.style{...}, in beliebiger Reihenfolge. Ein Feld meta in params wird herausgenommen und auf den Knoten angewendet.

Rückgabe TreeNodeId

metamethod __call(Recipe<T>, ?RefFill, ?T) : TreeNodeId base/tealdef/scripts/react.d.tl:28

Aufruf: Recipe(…)

Hinweise

Erzeugt einen Knoten: MyRecipe(params). Optional davor stehen ein React.ref(...) und ein React.style{...}, in beliebiger Reihenfolge. Ein Feld meta in params wird herausgenommen und auf den Knoten angewendet.

Rückgabe TreeNodeId

metamethod __call(Recipe<T>, ?ReactStyle, ?T) : TreeNodeId base/tealdef/scripts/react.d.tl:29

Aufruf: Recipe(…)

Hinweise

Erzeugt einen Knoten: MyRecipe(params). Optional davor stehen ein React.ref(...) und ein React.style{...}, in beliebiger Reihenfolge. Ein Feld meta in params wird herausgenommen und auf den Knoten angewendet.

Rückgabe TreeNodeId

metamethod __call(Recipe<T>, ?RefFill, ?ReactStyle, ?T) : TreeNodeId base/tealdef/scripts/react.d.tl:30

Aufruf: Recipe(…)

Hinweise

Erzeugt einen Knoten: MyRecipe(params). Optional davor stehen ein React.ref(...) und ein React.style{...}, in beliebiger Reihenfolge. Ein Feld meta in params wird herausgenommen und auf den Knoten angewendet.

Rückgabe TreeNodeId

Recipe2

record global base/tealdef/scripts/react.d.tl:33

global record Recipe2<T, T2> is IRecipe

Hinweise

Ein Recipe mit zwei Parametern.

Funktionen

metamethod __call(Recipe2<T, T2>, T, T2) : TreeNodeId base/tealdef/scripts/react.d.tl:34

Aufruf: Recipe2(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

metamethod __call(Recipe2<T, T2>, RefFill, T, T2) : TreeNodeId base/tealdef/scripts/react.d.tl:35

Aufruf: Recipe2(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

metamethod __call(Recipe2<T, T2>, ReactStyle, T, T2) : TreeNodeId base/tealdef/scripts/react.d.tl:36

Aufruf: Recipe2(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

metamethod __call(Recipe2<T, T2>, RefFill, ReactStyle, T, T2) : TreeNodeId base/tealdef/scripts/react.d.tl:37

Aufruf: Recipe2(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

Recipe3

record global base/tealdef/scripts/react.d.tl:40

global record Recipe3<T, T2, T3> is IRecipe

Hinweise

Ein Recipe mit drei Parametern.

Funktionen

metamethod __call(Recipe3<T, T2, T3>, T, T2, T3) : TreeNodeId base/tealdef/scripts/react.d.tl:41

Aufruf: Recipe3(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

metamethod __call(Recipe3<T, T2, T3>, RefFill, T, T2, T3) : TreeNodeId base/tealdef/scripts/react.d.tl:42

Aufruf: Recipe3(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

metamethod __call(Recipe3<T, T2, T3>, ReactStyle, T, T2, T3) : TreeNodeId base/tealdef/scripts/react.d.tl:43

Aufruf: Recipe3(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

metamethod __call(Recipe3<T, T2, T3>, RefFill, ReactStyle, T, T2, T3) : TreeNodeId base/tealdef/scripts/react.d.tl:44

Aufruf: Recipe3(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

Recipe4

record global base/tealdef/scripts/react.d.tl:47

global record Recipe4<T, T2, T3, T4> is IRecipe

Hinweise

Ein Recipe mit vier Parametern.

Funktionen

metamethod __call(Recipe4<T, T2, T3, T4>, T, T2, T3, T4) : TreeNodeId base/tealdef/scripts/react.d.tl:48

Aufruf: Recipe4(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

metamethod __call(Recipe4<T, T2, T3, T4>, RefFill, T, T2, T3, T4) : TreeNodeId base/tealdef/scripts/react.d.tl:49

Aufruf: Recipe4(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

metamethod __call(Recipe4<T, T2, T3, T4>, ReactStyle, T, T2, T3, T4) : TreeNodeId base/tealdef/scripts/react.d.tl:50

Aufruf: Recipe4(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

metamethod __call(Recipe4<T, T2, T3, T4>, RefFill, ReactStyle, T, T2, T3, T4) : TreeNodeId base/tealdef/scripts/react.d.tl:51

Aufruf: Recipe4(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

RecipeWithApi0

record global base/tealdef/scripts/react.d.tl:54

global record RecipeWithApi0<Api>

Hinweise

Ein Recipe ohne Parameter, dessen Knoten eine API anbieten (gesetzt mit React.provideApi). Erreichbar ist sie über getApi() einer Node-Ref.

Funktionen

metamethod __call(RecipeWithApi0<Api>) : TreeNodeId base/tealdef/scripts/react.d.tl:55

Aufruf: RecipeWithApi0(…)

Hinweise

Erzeugt einen Knoten; optional mit den Argumenten React.ref(...) und React.style{...}.

Rückgabe TreeNodeId

metamethod __call(RecipeWithApi0<Api>, RefFill) : TreeNodeId base/tealdef/scripts/react.d.tl:56

Aufruf: RecipeWithApi0(…)

Hinweise

Erzeugt einen Knoten; optional mit den Argumenten React.ref(...) und React.style{...}.

Rückgabe TreeNodeId

metamethod __call(RecipeWithApi0<Api>, ReactStyle) : TreeNodeId base/tealdef/scripts/react.d.tl:57

Aufruf: RecipeWithApi0(…)

Hinweise

Erzeugt einen Knoten; optional mit den Argumenten React.ref(...) und React.style{...}.

Rückgabe TreeNodeId

metamethod __call(RecipeWithApi0<Api>, RefFill, ReactStyle) : TreeNodeId base/tealdef/scripts/react.d.tl:58

Aufruf: RecipeWithApi0(…)

Hinweise

Erzeugt einen Knoten; optional mit den Argumenten React.ref(...) und React.style{...}.

Rückgabe TreeNodeId

RecipeWithApi

record global base/tealdef/scripts/react.d.tl:61

global record RecipeWithApi<T, Api> is IRecipe

Hinweise

Ein Recipe mit einem Parameter, dessen Knoten eine API anbieten (gesetzt mit React.provideApi).

Funktionen

metamethod __call(RecipeWithApi<T, Api>, T) : TreeNodeId base/tealdef/scripts/react.d.tl:62

Aufruf: RecipeWithApi(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

metamethod __call(RecipeWithApi<T, Api>, RefFill, T) : TreeNodeId base/tealdef/scripts/react.d.tl:63

Aufruf: RecipeWithApi(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

metamethod __call(RecipeWithApi<T, Api>, ReactStyle, T) : TreeNodeId base/tealdef/scripts/react.d.tl:64

Aufruf: RecipeWithApi(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

metamethod __call(RecipeWithApi<T, Api>, RefFill, ReactStyle, T) : TreeNodeId base/tealdef/scripts/react.d.tl:65

Aufruf: RecipeWithApi(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

RecipeWithApi2

record global base/tealdef/scripts/react.d.tl:68

global record RecipeWithApi2<T, T2, Api>

Hinweise

Ein Recipe mit zwei Parametern, dessen Knoten eine API anbieten.

Funktionen

metamethod __call(RecipeWithApi2<T, T2, Api>, T, T2) : TreeNodeId base/tealdef/scripts/react.d.tl:69

Aufruf: RecipeWithApi2(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

metamethod __call(RecipeWithApi2<T, T2, Api>, RefFill, T, T2) : TreeNodeId base/tealdef/scripts/react.d.tl:70

Aufruf: RecipeWithApi2(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

metamethod __call(RecipeWithApi2<T, T2, Api>, ReactStyle, T, T2) : TreeNodeId base/tealdef/scripts/react.d.tl:71

Aufruf: RecipeWithApi2(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

metamethod __call(RecipeWithApi2<T, T2, Api>, RefFill, ReactStyle, T, T2) : TreeNodeId base/tealdef/scripts/react.d.tl:72

Aufruf: RecipeWithApi2(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

RecipeWithApi3

record global base/tealdef/scripts/react.d.tl:75

global record RecipeWithApi3<T, T2, T3, Api>

Hinweise

Ein Recipe mit drei Parametern, dessen Knoten eine API anbieten.

Funktionen

metamethod __call(RecipeWithApi3<T, T2, T3, Api>, T, T2, T3) : TreeNodeId base/tealdef/scripts/react.d.tl:76

Aufruf: RecipeWithApi3(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

metamethod __call(RecipeWithApi3<T, T2, T3, Api>, RefFill, T, T2, T3) : TreeNodeId base/tealdef/scripts/react.d.tl:77

Aufruf: RecipeWithApi3(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

metamethod __call(RecipeWithApi3<T, T2, T3, Api>, ReactStyle, T, T2, T3) : TreeNodeId base/tealdef/scripts/react.d.tl:78

Aufruf: RecipeWithApi3(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

metamethod __call(RecipeWithApi3<T, T2, T3, Api>, RefFill, ReactStyle, T, T2, T3) : TreeNodeId base/tealdef/scripts/react.d.tl:79

Aufruf: RecipeWithApi3(…)

Hinweise

Erzeugt einen Knoten. Optionale Argumente React.ref(...) und React.style{...} stehen vor den Parametern.

Rückgabe TreeNodeId

ExtensionPoint0

record global base/tealdef/scripts/react.d.tl:82

global record ExtensionPoint0

Hinweise

Eine benannte Stelle in der GUI, an der andere Mods Plugin-Recipes ohne Parameter einhängen können. Erzeugt mit React.RegisterExtensionPoint0.

Felder

Name	Typ	Beschreibung
id	string	Vollständiger Name, "<modId>::<name>".

ExtensionPoint

record global base/tealdef/scripts/react.d.tl:85

global record ExtensionPoint<RecipeParam>

Hinweise

Eine benannte Stelle in der GUI, an der sich Plugin-Recipes mit dem Parameter RecipeParam einhängen lassen.

Felder

Name	Typ	Beschreibung
id	string	Vollständiger Name, "<modId>::<name>".

WrapperExtensionPoint0

record global base/tealdef/scripts/react.d.tl:88

global record WrapperExtensionPoint0<WrappedRecipe>

Hinweise

Ein Erweiterungspunkt, dessen Plugins einen Knoten von wrappedRecipe zurückgeben müssen (oder nichts).

Felder

Name	Typ	Beschreibung
wrappedRecipe	WrappedRecipe	Das Recipe, das jedes Plugin zurückgeben muss.
id	string	Vollständiger Name, "<modId>::<name>".

WrapperExtensionPoint

record global base/tealdef/scripts/react.d.tl:92

global record WrapperExtensionPoint<WrappedRecipe, RecipeParam>

Hinweise

Ein Erweiterungspunkt mit Parametern, dessen Plugins einen Knoten von wrappedRecipe zurückgeben müssen.

Felder

Name	Typ	Beschreibung
wrappedRecipe	WrappedRecipe	Das Recipe, das jedes Plugin zurückgeben muss.
id	string	Vollständiger Name, "<modId>::<name>".

Meta

record global base/tealdef/scripts/react.d.tl:97

global record Meta

Hinweise

Einstellungen im Feld meta der Recipe-Parameter. class und localKey gelten für den Knoten selbst. Für die übrigen Felder wird der Knoten in einen Knoten Builtin.WithComponentParams gepackt.

Felder

Name	Typ	Beschreibung
localKey	string	Schlüssel, der Identität (und Zustand) des Knotens über Renderdurchläufe hinweg erhält, wenn sich seine Position unter den Geschwisterknoten ändert.
id	string	Element-ID des Knotens, wie api.gui.byId sie verwendet (z. B. Fenster-IDs wie "menu.pause").
tag	string	Tag des Knotens. Die Kontexthilfe sucht ihre Hilfeseite über diesen Tag (z. B. "menu.finances.charts").
tooltip	string	Text des Tooltips.
tooltipModifierInputAction	string	append this IA's key to the tooltip (regardless of what the key currently does)
tooltipSource	ReactRefWrap	Knoten, dessen Tooltip für diesen Knoten angezeigt wird.
class	string	Style-Klasse(n) des Knotens. Überschreibt ein Argument React.style{class = ...} (mit Warnung).
forceFocusable	boolean	Macht den Knoten fokussierbar, auch wenn er es sonst nicht wäre.
disableFocusableRecursive	boolean	Macht den Knoten und alle seine Kinder nicht fokussierbar.
enabled	boolean	false deaktiviert den Knoten.
styleSheet	StyleSheet	Stylesheet, das auf den Knoten angewendet wird.
mouseCursorOverride	number	Mauszeiger über dem Knoten, z. B. gui_react_util.getMouseCursorInteger("Default").
discardNodeIdentity	boolean	force the node to be fully regenerated (it will lose its state and its UI elements).

Funktionen

onMouseOver(isHovered : boolean) base/tealdef/scripts/react.d.tl:109

Hinweise

Wird aufgerufen, wenn die Maus den Knoten zu überfahren beginnt oder ihn verlässt.

onFocusChange(hasFocus : boolean) base/tealdef/scripts/react.d.tl:110

Hinweise

Wird aufgerufen, wenn der Knoten den Fokus bekommt oder verliert.

onAttention(attention : boolean) base/tealdef/scripts/react.d.tl:115

Callback when "attention" changes. With "attention" we refer to the node having focus (in gamepad mode) or being hovered with the mouse. Note that this is not directly tied to :hover pseudo-class (you can have attention even with pseudo-class :active, but :hover would be ruled out by :active)

ReactState

record global base/tealdef/scripts/react.d.tl:123

global record ReactState

Hinweise

Zustand, erzeugt mit React.useState. Eine Änderung mit set oder transform rendert das Recipe neu. old() gibt den Wert des aktuellen Renderdurchlaufs zurück.

Funktionen

old(ReactState) : any base/tealdef/scripts/react.d.tl:124

Hinweise

Gibt den Wert des aktuellen Renderdurchlaufs zurück.

Rückgabe any

set(ReactState, any) base/tealdef/scripts/react.d.tl:125

Hinweise

Setzt einen neuen Wert; das Recipe rendert damit neu.

transform(ReactState, function(any) : any) base/tealdef/scripts/react.d.tl:126

Hinweise

Setzt den Wert auf fn(aktueller Wert).

hasExpired(ReactState) : boolean base/tealdef/scripts/react.d.tl:127

Hinweise

true, wenn der Knoten, dem der Zustand gehört, nicht mehr existiert (z. B. bei einem Aufruf aus einem Callback nach dem Unmount).

Rückgabe boolean

Beispiel

-- aus base/content/gui/gui/layers/layer_cargo.tl
getSelectedCargoTypeId = function() : CargoTypeId
    if dropDownSelectionState:hasExpired() then
        return -1
    end
    return dropDownSelectionState:old().selectedCargoTypeId
end,

ReactStateT

record global base/tealdef/scripts/react.d.tl:130

global record ReactStateT<T>

Hinweise

Typisierter Zustand, erzeugt mit React.useState(initialValue); siehe ReactState.

Funktionen

old(ReactStateT<T>) : T base/tealdef/scripts/react.d.tl:131

Aufruf: reactStateT:old(…) (Methode)

Hinweise

Gibt den Wert des aktuellen Renderdurchlaufs zurück.

Rückgabe T

Im Basisspiel verwendet: 1.593-mal in 82 Dateien

base/content/game_mechanics/game_mechanics/celebrations/celebration_react_util.tl:199

local s = state:old()

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

local aniStep = animationStepState:old()

base/content/game_mechanics/game_mechanics/finance/account.tl:62

tabValue = tabState:old(),

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

if sliderHoldState:old() then

base/content/game_mechanics/game_mechanics/finance/finances_loan_gui.tl:35

if currentGameSpeed.millisPerDay ~= millisPerDayState:old() then

base/content/game_mechanics/game_mechanics/finance/finances_react_util.tl:123

if checkedState:old() and activeState:old() then

… und 76 weitere Dateien.

set(ReactStateT<T>, T) base/tealdef/scripts/react.d.tl:132

Aufruf: reactStateT:set(…) (Methode)

Hinweise

Setzt einen neuen Wert; das Recipe rendert damit neu.

Im Basisspiel verwendet: 667-mal in 71 Dateien

base/content/game_mechanics/game_mechanics/celebrations/celebration_react_util.tl:227

state:set(s)

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

animationStepState:set("Unlocking")

base/content/game_mechanics/game_mechanics/finance/account.tl:50

tabState:set(tab)

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

sliderHoldState:set(true)

base/content/game_mechanics/game_mechanics/finance/finances_loan_gui.tl:36

millisPerDayState:set(currentGameSpeed.millisPerDay)

base/content/game_mechanics/game_mechanics/finance/finances_react_util.tl:104

activeState:set(true)

… und 65 weitere Dateien.

transform(ReactStateT<T>, function(T) : T) base/tealdef/scripts/react.d.tl:133

Aufruf: reactStateT:transform(…) (Methode)

Hinweise

Setzt den Wert auf fn(aktueller Wert).

Im Basisspiel verwendet: 41-mal in 22 Dateien

base/content/game_mechanics/game_mechanics/celebrations/celebration_react_util.tl:154

state:transform(function(currentState : CelebrationState) : CelebrationState

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

filterState:transform(function(current : NotificationLogToolParam.FilterState) : NotificationLogToolParam.FilterState

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

actionPresentState:transform(function(__ : boolean) : boolean

base/content/gui/gui/entity_window/industry/industry.tl:110

industryExpansionState:transform(function(old : IndustryExpansionState) : IndustryExpansionState

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

showLinesForTabRef:transform(function(cur : {string : boolean}) : {string : boolean}

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

guiContextState:transform(function(old : LineUtil.GuiContextState) : LineUtil.GuiContextState

… und 16 weitere Dateien.

hasExpired(ReactStateT<T>) : boolean base/tealdef/scripts/react.d.tl:134

Aufruf: reactStateT:hasExpired(…) (Methode)

Hinweise

true, wenn der Knoten, dem der Zustand gehört, nicht mehr existiert.

Rückgabe boolean

Im Basisspiel verwendet: 9-mal in 6 Dateien

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

if diagramWidgetState:hasExpired() then

base/content/gui/gui/entity_window/industry/industry.tl:96

if industryExpansionState:hasExpired() then

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

userParamInplace.cargoTypes = (not activeTabState:hasExpired()) and params.cargoNeeds or {}

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

if dropDownSelectionState:hasExpired() then

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

if lvmFilterConfigState:hasExpired() then

base/content/gui/gui/main/engine_react_util.tl:146

if stateData:hasExpired() then

ReactRefT

record global base/tealdef/scripts/react.d.tl:137

global record ReactRefT<T>

Hinweise

Ein Wert, der über Renderdurchläufe erhalten bleibt, erzeugt mit React.useRef. Anders als bei einem Zustand rendert eine Änderung das Recipe nicht neu.

Funktionen

get(ReactRefT<T>) : T base/tealdef/scripts/react.d.tl:138

Aufruf: reactRefT:get(…) (Methode)

Hinweise

Gibt den gespeicherten Wert zurück.

Rückgabe T

Im Basisspiel verwendet: 535-mal in 41 Dateien

base/content/game_mechanics/game_mechanics/celebrations/celebration_react_util.tl:190

if calloutStartTimeRef:get() then

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

if currentSelectedLevel == appliedLevel:get() then

base/content/game_mechanics/game_mechanics/finance/finances_assets.tl:341

local checkedEntry = checkedCargoTypes:get()[logName]

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

initialFilterState = filterState:get()

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

for __, ignorableType in ipairs(ignorableTypesRef:get()) do

base/content/game_mechanics/game_mechanics/notifications/gui/notification_popups.tl:317

local animated = animatedRef:get()

… und 35 weitere Dateien.

set(ReactRefT<T>, T) base/tealdef/scripts/react.d.tl:139

Aufruf: reactRefT:set(…) (Methode)

Hinweise

Speichert einen Wert, ohne neu zu rendern.

Im Basisspiel verwendet: 292-mal in 37 Dateien

base/content/game_mechanics/game_mechanics/celebrations/celebration_react_util.tl:186

calloutStartTimeRef:set(nil)

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

appliedLevel:set(currentSelectedLevel)

base/content/game_mechanics/game_mechanics/finance/finances_table.tl:152

selectedRowKeyRef:set(rowKey)

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

filterState:set(newState)

base/content/game_mechanics/game_mechanics/notifications/gui/notification_popups.tl:321

animatedRef:set(true)

base/content/game_mechanics/game_mechanics/notifications/types/notification_react_util.tl:98

notificationStateRef:set(notification_util.externalGetNotificationsStateNative())

… und 31 weitere Dateien.

transform(ReactRefT, function(T) : T) base/tealdef/scripts/react.d.tl:140

Aufruf: reactRefT:transform(…) (Methode)

Hinweise

Speichert fn(aktueller Wert).

Im Basisspiel verwendet: 9-mal in 3 Dateien

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

depot2VehiclesCompareRef:transform(function(curr : {Engine.Entity : {Engine.Entity}}) : {Engine.Entity : {Engine.Entity}}

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

editorStateRef:transform(function(current : MapEditor.GlobalState) : MapEditor.GlobalState

base/content/mission/mission/mission_react_util.tl:492

pendingRef:transform(function(cur : {VoiceOverState}) : {VoiceOverState}

hasExpired(ReactRefT<T>) : boolean base/tealdef/scripts/react.d.tl:141

Aufruf: reactRefT:hasExpired(…) (Methode)

Hinweise

true, wenn der Knoten, dem die Ref gehört, nicht mehr existiert.

Rückgabe boolean

Im Basisspiel verwendet: 3-mal in 3 Dateien

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

return tooltipHolder:hasExpired()

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

if not bufferedSendDataRef:hasExpired() and data then

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

if activeModMapRef:hasExpired() then

ReactRefWrap

record global base/tealdef/scripts/react.d.tl:144

global record ReactRefWrap

Hinweise

Eine Ref auf einen GUI-Knoten, aus React.useNodeRef() oder React.useSelfRef().

Funktionen

get(ReactRefWrap) : ReactNodeRef base/tealdef/scripts/react.d.tl:145

Aufruf: reactRefWrap:get(…) (Methode)

Hinweise

Gibt den Knoten zurück, oder nil, solange der Knoten noch nicht existiert.

Rückgabe ReactNodeRef

Im Basisspiel verwendet: 39-mal in 10 Dateien

base/content/game_mechanics/game_mechanics/notifications/gui/notification_popups.tl:152

if notificationPopupRef and notificationPopupRef:get() ~= nil and not notificationPopupRef:hasExpired() then

base/content/game_mechanics/game_mechanics/subventions/subventions_gui.tl:191

if api.util.getInputMode() == api.type["enum"].InputMode.Gamepad and initialFocusRef:get() then

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

if refSearchTextInput:get() ~= nil and refSearchTextInput:get():getIdentity() ~= nil then

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

if vehicleListRef:get() then

base/content/gui/gui/line_vehicle_mgmt/vehicle_store_window.tl:2206

refSearchTextInput:get():focus()

base/content/gui/gui/main/callout_container.tl:87

and (cur.current.parent as ReactRefWrap):get() == parent:get() then

… und 4 weitere Dateien.

set(ReactRefWrap, any) base/tealdef/scripts/react.d.tl:146

Hinweise

Speichert einen Knoten. React.ref(...) erledigt das, wenn der Knoten erzeugt wird.

transform(ReactRefWrap, function(any) : any) base/tealdef/scripts/react.d.tl:147

Hinweise

Speichert fn(aktueller Wert).

hasExpired(ReactRefWrap) : boolean base/tealdef/scripts/react.d.tl:148

Aufruf: reactRefWrap:hasExpired(…) (Methode)

Hinweise

true, wenn der Knoten, dem die Ref gehört, nicht mehr existiert.

Rückgabe boolean

Im Basisspiel verwendet: 2-mal in 1 Datei

base/content/game_mechanics/game_mechanics/notifications/gui/notification_popups.tl:152

if notificationPopupRef and notificationPopupRef:get() ~= nil and not notificationPopupRef:hasExpired() then

ReactNodeRefT

record global base/tealdef/scripts/react.d.tl:151

global record ReactNodeRefT<T>

Hinweise

Zugriff auf einen erzeugten Knoten eines Recipes mit dem Parametertyp T.

Funktionen

focus(ReactNodeRefT<T>) base/tealdef/scripts/react.d.tl:152

Hinweise

Gibt dem Knoten den Fokus.

containsPosition(ReactNodeRefT<T>, position : Vec2i) : boolean base/tealdef/scripts/react.d.tl:153

Hinweise

true, wenn die Bildschirmposition innerhalb des Knotens liegt.

Rückgabe boolean

getPosition(ReactNodeRefT<T>, gravityX : number, gravityY : number) : Vec2f base/tealdef/scripts/react.d.tl:154

Hinweise

Bildschirmposition eines Punkts des Knotens. Bei gravityX/gravityY steht 0 für den linken bzw. oberen Rand und 1 für den rechten bzw. unteren Rand.

Rückgabe Vec2f

Beispiel

-- Breite eines Knotens (base/content/game_mechanics/game_mechanics/notifications/gui/notification_popups.tl)
local popupWidth = notificationPopupRef:get():getPosition(1.0, 0.0).x - notificationPopupRef:get():getPosition(0.0, 0.0).x

ensureVisible(ReactNodeRefT<T>) base/tealdef/scripts/react.d.tl:155

Hinweise

Scrollt die umgebenden Scrollbereiche so, dass der Knoten sichtbar ist.

setSelectedRecursive(ReactNodeRefT<T>, selected : boolean) base/tealdef/scripts/react.d.tl:156

Hinweise

Setzt den Auswahlzustand des Knotens und seiner Kinder.

ReactNodeRefApiT

record global base/tealdef/scripts/react.d.tl:158

global record ReactNodeRefApiT<T, Api>

Hinweise

Zugriff auf einen erzeugten Knoten eines Recipes mit API.

Funktionen

getApi(ReactNodeRefApiT<T, Api>) : Api base/tealdef/scripts/react.d.tl:159

Hinweise

Gibt die API zurück, die das Recipe mit React.provideApi gesetzt hat.

Rückgabe Api

focus(ReactNodeRefApiT<T, Api>) base/tealdef/scripts/react.d.tl:160

Hinweise

Gibt dem Knoten den Fokus.

containsPosition(ReactNodeRefApiT<T, Api>, position : Vec2i) : boolean base/tealdef/scripts/react.d.tl:161

Hinweise

true, wenn die Bildschirmposition innerhalb des Knotens liegt.

Rückgabe boolean

getPosition(ReactNodeRefApiT<T, Api>, gravityX : number, gravityY : number) : Vec2f base/tealdef/scripts/react.d.tl:162

Hinweise

Bildschirmposition eines Punkts des Knotens. Bei gravityX/gravityY steht 0 für den linken bzw. oberen Rand und 1 für den rechten bzw. unteren Rand.

Rückgabe Vec2f

getIdentity(ReactNodeRefApiT<T, Api>) : integer base/tealdef/scripts/react.d.tl:163

Hinweise

Identitätsnummer des Knotens; nil, wenn der Knoten nicht existiert (das Basisspiel prüft das vor getApi()).

Rückgabe integer

ensureVisible(ReactNodeRefApiT<T, Api>) base/tealdef/scripts/react.d.tl:164

Hinweise

Scrollt die umgebenden Scrollbereiche so, dass der Knoten sichtbar ist.

setSelectedRecursive(ReactNodeRefApiT<T, Api>, selected : boolean) base/tealdef/scripts/react.d.tl:165

Hinweise

Setzt den Auswahlzustand des Knotens und seiner Kinder.

ReactNodeRefApi0

record global base/tealdef/scripts/react.d.tl:167

global record ReactNodeRefApi0<Api>

Hinweise

Zugriff auf einen erzeugten Knoten eines parameterlosen Recipes mit API.

Funktionen

getApi(ReactNodeRefApi0<Api>) : Api base/tealdef/scripts/react.d.tl:168

Hinweise

Gibt die API zurück, die das Recipe mit React.provideApi gesetzt hat.

Rückgabe Api

focus(ReactNodeRefApi0<Api>) base/tealdef/scripts/react.d.tl:169

Hinweise

Gibt dem Knoten den Fokus.

containsPosition(ReactNodeRefApi0<Api>, position : Vec2i) : boolean base/tealdef/scripts/react.d.tl:170

Hinweise

true, wenn die Bildschirmposition innerhalb des Knotens liegt.

Rückgabe boolean

getPosition(ReactNodeRefApi0<Api>, gravityX : number, gravityY : number) : Vec2f base/tealdef/scripts/react.d.tl:171

Hinweise

Bildschirmposition eines Punkts des Knotens. Bei gravityX/gravityY steht 0 für den linken bzw. oberen Rand und 1 für den rechten bzw. unteren Rand.

Rückgabe Vec2f

getIdentity(ReactNodeRefApi0<Api>) : integer base/tealdef/scripts/react.d.tl:172

Hinweise

Identitätsnummer des Knotens.

Rückgabe integer

ensureVisible(ReactNodeRefApi0<Api>) base/tealdef/scripts/react.d.tl:173

Hinweise

Scrollt die umgebenden Scrollbereiche so, dass der Knoten sichtbar ist.

setSelectedRecursive(ReactNodeRefApi0<Api>, selected : boolean) base/tealdef/scripts/react.d.tl:174

Hinweise

Setzt den Auswahlzustand des Knotens und seiner Kinder.

ReactRefWrapT

record global base/tealdef/scripts/react.d.tl:177

global record ReactRefWrapT<T>

Hinweise

Typisierte Node-Ref aus React.useNodeRef(SomeRecipe).

Funktionen

get(ReactRefWrapT<T>) : ReactNodeRefT<T> base/tealdef/scripts/react.d.tl:178

Aufruf: reactRefWrapT:get(…) (Methode)

Hinweise

Gibt den Knoten zurück, oder nil, solange der Knoten noch nicht existiert.

Rückgabe ReactNodeRefT<T>

Im Basisspiel verwendet: 1-mal in 1 Datei

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

categoryFilterPanelRef:get():focus()

set(ReactRefWrapT<T>, ReactNodeRefT<T>) base/tealdef/scripts/react.d.tl:179

Hinweise

Speichert einen Knoten. React.ref(...) erledigt das, wenn der Knoten erzeugt wird.

transform(ReactRefWrapT<T>, function(ReactNodeRefT<T>) : ReactNodeRefT<T>) base/tealdef/scripts/react.d.tl:180

Hinweise

Speichert fn(aktueller Wert).

hasExpired(ReactRefWrapT<T>) : boolean base/tealdef/scripts/react.d.tl:181

Hinweise

true, wenn der Knoten, dem die Ref gehört, nicht mehr existiert.

Rückgabe boolean

ReactRefWrapApiT

record global base/tealdef/scripts/react.d.tl:184

global record ReactRefWrapApiT<T, Api>

Hinweise

Node-Ref aus React.useNodeRef(SomeRecipeWithApi); ihr Knoten hat getApi().

Funktionen

get(ReactRefWrapApiT<T, Api>) : ReactNodeRefApiT<T, Api> base/tealdef/scripts/react.d.tl:185

Aufruf: reactRefWrapApiT:get(…) (Methode)

Hinweise

Gibt den Knoten zurück, oder nil, solange der Knoten noch nicht existiert.

Rückgabe ReactNodeRefApiT<T, Api>

Im Basisspiel verwendet: 86-mal in 10 Dateien

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

refSelf:get():focus()

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

if (false == refSublistParams:hasExpired()) and refSublistParams:get() ~= nil and refSublistParams:get():getIdentity() ~= nil and refSublistParams:get():getApi(

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

informationWidgetRef:get():getApi().setActiveTab("Overview")

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

if vehicleManagerRef:get() then

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

local wc = windowContainer:get():getApi()

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

local wc = windowContainer:get():getApi()

… und 4 weitere Dateien.

set(ReactRefWrapApiT<T, Api>, ReactNodeRefApiT<T, Api>) base/tealdef/scripts/react.d.tl:186

Hinweise

Speichert einen Knoten.

transform(ReactRefWrapApiT<T, Api>, function(ReactNodeRefApiT<T, Api>) : ReactNodeRefApiT<T, Api>) base/tealdef/scripts/react.d.tl:187

Hinweise

Speichert fn(aktueller Wert).

hasExpired(ReactRefWrapApiT<T, Api>) : boolean base/tealdef/scripts/react.d.tl:188

Aufruf: reactRefWrapApiT:hasExpired(…) (Methode)

Hinweise

true, wenn der Knoten, dem die Ref gehört, nicht mehr existiert.

Rückgabe boolean

Im Basisspiel verwendet: 1-mal in 1 Datei

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

if (false == refSublistParams:hasExpired()) and refSublistParams:get() ~= nil and refSublistParams:get():getIdentity() ~= nil and refSublistParams:get():getApi(

ReactRefWrapApi0

record global base/tealdef/scripts/react.d.tl:190

global record ReactRefWrapApi0<Api>

Hinweise

Node-Ref für ein parameterloses Recipe mit API.

Funktionen

get(ReactRefWrapApi0<Api>) : ReactNodeRefApi0<Api> base/tealdef/scripts/react.d.tl:191

Aufruf: reactRefWrapApi0:get(…) (Methode)

Hinweise

Gibt den Knoten zurück, oder nil, solange der Knoten noch nicht existiert.

Rückgabe ReactNodeRefApi0<Api>

Im Basisspiel verwendet: 6-mal in 1 Datei

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

if galleryRef:get() == nil or not params.logoImage or params.logoImage == "" then

set(ReactRefWrapApi0<Api>, ReactNodeRefApi0<Api>) base/tealdef/scripts/react.d.tl:192

Hinweise

Speichert einen Knoten.

transform(ReactRefWrapApi0<Api>, function(ReactNodeRefApi0<Api>) : ReactNodeRefApi0<Api>) base/tealdef/scripts/react.d.tl:193

Hinweise

Speichert fn(aktueller Wert).

hasExpired(ReactRefWrapApi0<Api>) : boolean base/tealdef/scripts/react.d.tl:194

Hinweise

true, wenn der Knoten, dem die Ref gehört, nicht mehr existiert.

Rückgabe boolean

ReactNodeRef

record global base/tealdef/scripts/react.d.tl:197

global record ReactNodeRef

Hinweise

Zugriff auf einen erzeugten Knoten über eine untypisierte ReactRefWrap.

Funktionen

focus(ReactNodeRef) base/tealdef/scripts/react.d.tl:198

Hinweise

Gibt dem Knoten den Fokus.

containsPosition(ReactNodeRef, position : Vec2i) : boolean base/tealdef/scripts/react.d.tl:199

Hinweise

true, wenn die Bildschirmposition innerhalb des Knotens liegt.

Rückgabe boolean

getPosition(ReactNodeRef, gravityX : number, gravityY : number) : Vec2f base/tealdef/scripts/react.d.tl:200

Hinweise

Bildschirmposition eines Punkts des Knotens. Bei gravityX/gravityY steht 0 für den linken bzw. oberen Rand und 1 für den rechten bzw. unteren Rand.

Rückgabe Vec2f

getIdentity(ReactNodeRef) : integer base/tealdef/scripts/react.d.tl:201

Hinweise

Identitätsnummer des Knotens.

Rückgabe integer

ReactStyleParams

record global base/tealdef/scripts/react.d.tl:204

global record ReactStyleParams

Hinweise

Parameter von React.style.

Felder

Name	Typ	Beschreibung
class	string	Style-Klasse(n) für den Knoten.

IReactToolDefinition

interface global base/tealdef/scripts/react.d.tl:208

global interface IReactToolDefinition

Hinweise

Ein Werkzeug, registriert mit React.RegisterTool (der Werkzeug-Stack der Spiel-GUI, z. B. Fenster wie das Pausenmenü).

Felder

Name	Typ	Beschreibung
name	string	Eindeutiger Werkzeugname. RegisterTool schlägt fehl, wenn er fehlt oder schon vergeben ist.

ReactToolDefinition

record global base/tealdef/scripts/react.d.tl:212

global record ReactToolDefinition<P> is IReactToolDefinition

Hinweise

Callbacks eines Werkzeugs auf dem Werkzeug-Stack, mit den Werkzeugparametern P. Die üblichen Fensterwerkzeuge baut tool_react_util mit prepareDefaultToolWithWindowDefinition.

Funktionen

push(Builtin.ToolStackContext<P>, P) base/tealdef/scripts/react.d.tl:213

Hinweise

Wird aufgerufen, wenn das Werkzeug auf den Werkzeug-Stack gelegt wird. Fensterwerkzeuge öffnen hier ihr Fenster.

pop(Builtin.ToolStackContext<P>, P) base/tealdef/scripts/react.d.tl:214

Hinweise

Wird aufgerufen, wenn das Werkzeug vom Stack genommen wird. Fensterwerkzeuge schließen hier ihr Fenster.

shelve(Builtin.ToolStackContext<P>, P, shelve : boolean) base/tealdef/scripts/react.d.tl:215

Hinweise

Wird mit true aufgerufen, wenn ein anderes Werkzeug dieses verdeckt, und mit false, wenn es wieder oben liegt. Fensterwerkzeuge blenden ihr Fenster dabei aus und wieder ein.

getActiveVariant(Builtin.ToolStackContext<P>, P) : string base/tealdef/scripts/react.d.tl:217

Hinweise

Optional; Name der aktiven Variante des Werkzeugs.

Rückgabe string

getDebugString(Builtin.ToolStackContext<P>, P) : string base/tealdef/scripts/react.d.tl:218

Hinweise

Optional; Text für Debug-Ausgaben.

Rückgabe string

DndGrabContext

record global base/tealdef/scripts/react.d.tl:221

global record DndGrabContext

Hinweise

Kontext zum Hinzufügen von Drag-and-drop-Elementen.

Funktionen

addItem(itemType : ResName, itemData : any) base/tealdef/scripts/react.d.tl:222

Hinweise

Fügt den gezogenen Elementen ein Element des angegebenen Typs hinzu.

DndDropContext

record global base/tealdef/scripts/react.d.tl:224

global record DndDropContext

Hinweise

Elemente, die verfügbar sind, wenn etwas auf einem Knoten abgelegt wird.

Funktionen

getItems() : {Gui.DataTransferItem} base/tealdef/scripts/react.d.tl:226

get filtered items (if filter is set), otherwise same as getAllItems

Rückgabe {Gui.DataTransferItem}

getAllItems() : {Gui.DataTransferItem} base/tealdef/scripts/react.d.tl:227

Hinweise

Alle gezogenen Elemente.

Rückgabe {Gui.DataTransferItem}

anyMatch() : boolean base/tealdef/scripts/react.d.tl:228

Hinweise

true, wenn mindestens ein Element den filter des Handlers besteht.

Rückgabe boolean

DndDragContext

record global base/tealdef/scripts/react.d.tl:230

global record DndDragContext

Hinweise

Elemente, die über einen Knoten gezogen werden (übergeben an enter und exit).

Funktionen

getItems() : {Gui.DataTransferItem} base/tealdef/scripts/react.d.tl:232

get filtered items

Rückgabe {Gui.DataTransferItem}

getAllItems() : {Gui.DataTransferItem} base/tealdef/scripts/react.d.tl:234

get all items that are currently being dragged

Rückgabe {Gui.DataTransferItem}

anyMatch() : boolean base/tealdef/scripts/react.d.tl:236

check if at least one item matches the filter if filter

Rückgabe boolean

DragAndDropHandler

record global base/tealdef/scripts/react.d.tl:238

global record DragAndDropHandler

Hinweise

Callbacks für React.onDragAndDrop.

Funktionen

grab() : {Gui.DataTransferItem}, integer base/tealdef/scripts/react.d.tl:241

return what you started to drag, {} to deny grabbing, nil/false to let parent handle it. second return value: initial dragging mouse cursor (defaults to gui_react_util.getMouseCursorInteger("Grab"))

Rückgabe {Gui.DataTransferItem}, integer

filter(type : ResName, data : any) : boolean base/tealdef/scripts/react.d.tl:244

optional filter, return true if an item should be accepted. If not set, all items are accepted.

Rückgabe boolean

drop(dropContext : DndDropContext) : boolean base/tealdef/scripts/react.d.tl:245

Hinweise

Wird aufgerufen, wenn Elemente auf dem Knoten abgelegt werden. Gib true zurück, wenn du das Ereignis behandelt hast.

Rückgabe boolean

enter(dropContext : DndDragContext) : boolean base/tealdef/scripts/react.d.tl:246

Hinweise

Wird aufgerufen, wenn gezogene Elemente den Knoten betreten. Gib true zurück, wenn du das Ereignis behandelt hast.

Rückgabe boolean

exit(dropContext : DndDragContext) : boolean base/tealdef/scripts/react.d.tl:247

Hinweise

Wird aufgerufen, wenn gezogene Elemente den Knoten verlassen. Gib true zurück, wenn du das Ereignis behandelt hast.

Rückgabe boolean

React

record global base/tealdef/scripts/react.d.tl:250

global record React

Hinweise

Die GUI-Bibliothek, die ug_require "::/gui/main/react.lua" zurückgibt.

Funktionen

RegisterRecipe(string, function() : TreeNodeId) : Recipe0 base/tealdef/scripts/react.d.tl:251

Hinweise

Registriert ein Recipe unter einem Namen und gibt es zurück. Ein Aufruf des Ergebnisses erzeugt Knoten.

Parameter	Typ	Beschreibung
#1	string	Name des Recipes, verwendet für Debugging und Recipe-IDs.
#2	function() : TreeNodeId	Die Renderfunktion. Sie gibt einen Knoten, eine Liste von Knoten oder nil zurück.

Rückgabe Recipe0

Details

Registriere Recipes einmal auf Dateiebene, nicht innerhalb anderer Recipes. Hooks (useState, onStep, ...) funktionieren nur, während die Renderfunktion läuft.

RegisterRecipe<T1>(string, function(T1) : TreeNodeId) : Recipe<T1> base/tealdef/scripts/react.d.tl:252

Hinweise

Registriert ein Recipe unter einem Namen und gibt es zurück. Ein Aufruf des Ergebnisses erzeugt Knoten.

Parameter	Typ	Beschreibung
#1	string	Name des Recipes, verwendet für Debugging und Recipe-IDs.
#2	function(T1) : TreeNodeId	Die Renderfunktion. Sie gibt einen Knoten, eine Liste von Knoten oder nil zurück.

Rückgabe Recipe<T1>

Details

Registriere Recipes einmal auf Dateiebene, nicht innerhalb anderer Recipes. Hooks (useState, onStep, ...) funktionieren nur, während die Renderfunktion läuft.

RegisterRecipe<T1, T2>(string, function(T1, T2) : TreeNodeId) : Recipe2<T1, T2> base/tealdef/scripts/react.d.tl:253

Hinweise

Registriert ein Recipe unter einem Namen und gibt es zurück. Ein Aufruf des Ergebnisses erzeugt Knoten.

Parameter	Typ	Beschreibung
#1	string	Name des Recipes, verwendet für Debugging und Recipe-IDs.
#2	function(T1, T2) : TreeNodeId	Die Renderfunktion. Sie gibt einen Knoten, eine Liste von Knoten oder nil zurück.

Rückgabe Recipe2<T1, T2>

Details

Registriere Recipes einmal auf Dateiebene, nicht innerhalb anderer Recipes. Hooks (useState, onStep, ...) funktionieren nur, während die Renderfunktion läuft.

RegisterRecipe<T1, T2, T3>(string, function(T1, T2, T3) : TreeNodeId) : Recipe3<T1, T2, T3> base/tealdef/scripts/react.d.tl:254

Hinweise

Registriert ein Recipe unter einem Namen und gibt es zurück. Ein Aufruf des Ergebnisses erzeugt Knoten.

Parameter	Typ	Beschreibung
#1	string	Name des Recipes, verwendet für Debugging und Recipe-IDs.
#2	function(T1, T2, T3) : TreeNodeId	Die Renderfunktion. Sie gibt einen Knoten, eine Liste von Knoten oder nil zurück.

Rückgabe Recipe3<T1, T2, T3>

Details

Registriere Recipes einmal auf Dateiebene, nicht innerhalb anderer Recipes. Hooks (useState, onStep, ...) funktionieren nur, während die Renderfunktion läuft.

RegisterRecipe<T1, T2, T3, T4>(string, function(T1, T2, T3, T4) : TreeNodeId) : Recipe4<T1, T2, T3, T4> base/tealdef/scripts/react.d.tl:255

Hinweise

Registriert ein Recipe unter einem Namen und gibt es zurück. Ein Aufruf des Ergebnisses erzeugt Knoten.

Parameter	Typ	Beschreibung
#1	string	Name des Recipes, verwendet für Debugging und Recipe-IDs.
#2	function(T1, T2, T3, T4) : TreeNodeId	Die Renderfunktion. Sie gibt einen Knoten, eine Liste von Knoten oder nil zurück.

Rückgabe Recipe4<T1, T2, T3, T4>

Details

Registriere Recipes einmal auf Dateiebene, nicht innerhalb anderer Recipes. Hooks (useState, onStep, ...) funktionieren nur, während die Renderfunktion läuft.

RegisterWrapperRecipe<T, Params, WrappedParams>(string, Recipe<WrappedParams>, (function(T, Params) : TreeNodeId)) : Recipe<T> base/tealdef/scripts/react.d.tl:257

Hinweise

Registriert ein Recipe, das genau einen Knoten des umhüllten Recipes zurückgeben muss (oder keinen), z. B. ein Fensterrezept auf Basis von builtin.Window.

Rückgabe Recipe<T>

Beispiel

-- aus base/content/gui/gui/main/pause_menu.tl
local PauseMenu = react.RegisterWrapperRecipe("PauseMenu", builtin.Window, function(params : ToolReactUtil.IToolWindowParam<ToolReactUtil.IToolParam>) : TreeNodeId
    return builtin.Window{ id = pauseMenuWindowId, closable = false, content = PauseMenuContent(params) }
end)

register a recipe that is a plugin for a specific extensionPoint

RegisterPluginRecipe(extensionPoint : ExtensionPoint0, name : string, fn : function() : TreeNodeId) : Recipe0 base/tealdef/scripts/react.d.tl:262

Hinweise

Registriert ein Recipe als Plugin für einen Erweiterungspunkt.

Rückgabe Recipe0

Details

Durch das Registrieren landet das Recipe noch nicht im Erweiterungspunkt. Der Mod braucht dazu eine generische Ressource (.res.lua) vom Typ "react-plugin <extension point id>", deren data.filePath das Recipe als "file.script@RecipeName" angibt. Bei einem Wrapper-Erweiterungspunkt muss das Recipe einen Knoten des umhüllten Recipes zurückgeben.

Beispiel

-- base/content/gui/gui/game_bar/game_bar_display_earnings_plugin/game_bar_display_earnings.res.lua
function data()
    return {
        type = "react-plugin ::GameBarInfoDisplayExtension",
        data = {
            filePath = "::/gui/game_bar/game_bar_display_earnings_plugin/game_bar_display_earnings.script@GameBarEarningsPlugin",
        }
    }
end

RegisterPluginRecipe<ParamType>(extensionPoint : ExtensionPoint<ParamType>, name : string, fn : function(ParamType) : TreeNodeId) : Recipe<ParamType> base/tealdef/scripts/react.d.tl:263

Hinweise

Registriert ein Recipe als Plugin für einen Erweiterungspunkt.

Rückgabe Recipe<ParamType>

Details

Durch das Registrieren landet das Recipe noch nicht im Erweiterungspunkt. Der Mod braucht dazu eine generische Ressource (.res.lua) vom Typ "react-plugin <extension point id>", deren data.filePath das Recipe als "file.script@RecipeName" angibt. Bei einem Wrapper-Erweiterungspunkt muss das Recipe einen Knoten des umhüllten Recipes zurückgeben.

Beispiel

-- base/content/gui/gui/game_bar/game_bar_display_earnings_plugin/game_bar_display_earnings.res.lua
function data()
    return {
        type = "react-plugin ::GameBarInfoDisplayExtension",
        data = {
            filePath = "::/gui/game_bar/game_bar_display_earnings_plugin/game_bar_display_earnings.script@GameBarEarningsPlugin",
        }
    }
end

RegisterPluginRecipe<WrappedRecipe>(extensionPoint : WrapperExtensionPoint0<WrappedRecipe>, name : string, fn : function() : TreeNodeId) : Recipe0 base/tealdef/scripts/react.d.tl:264

Hinweise

Registriert ein Recipe als Plugin für einen Erweiterungspunkt.

Rückgabe Recipe0

Details

Durch das Registrieren landet das Recipe noch nicht im Erweiterungspunkt. Der Mod braucht dazu eine generische Ressource (.res.lua) vom Typ "react-plugin <extension point id>", deren data.filePath das Recipe als "file.script@RecipeName" angibt. Bei einem Wrapper-Erweiterungspunkt muss das Recipe einen Knoten des umhüllten Recipes zurückgeben.

Beispiel

-- base/content/gui/gui/game_bar/game_bar_display_earnings_plugin/game_bar_display_earnings.res.lua
function data()
    return {
        type = "react-plugin ::GameBarInfoDisplayExtension",
        data = {
            filePath = "::/gui/game_bar/game_bar_display_earnings_plugin/game_bar_display_earnings.script@GameBarEarningsPlugin",
        }
    }
end

RegisterPluginRecipe<WrappedRecipe, ParamType>(extensionPoint : WrapperExtensionPoint<WrappedRecipe, ParamType>, name : string, fn : function(ParamType) : TreeNodeId) : Recipe<ParamType> base/tealdef/scripts/react.d.tl:265

Hinweise

Registriert ein Recipe als Plugin für einen Erweiterungspunkt.

Rückgabe Recipe<ParamType>

Details

Durch das Registrieren landet das Recipe noch nicht im Erweiterungspunkt. Der Mod braucht dazu eine generische Ressource (.res.lua) vom Typ "react-plugin <extension point id>", deren data.filePath das Recipe als "file.script@RecipeName" angibt. Bei einem Wrapper-Erweiterungspunkt muss das Recipe einen Knoten des umhüllten Recipes zurückgeben.

Beispiel

-- base/content/gui/gui/game_bar/game_bar_display_earnings_plugin/game_bar_display_earnings.res.lua
function data()
    return {
        type = "react-plugin ::GameBarInfoDisplayExtension",
        data = {
            filePath = "::/gui/game_bar/game_bar_display_earnings_plugin/game_bar_display_earnings.script@GameBarEarningsPlugin",
        }
    }
end

register an extensionPoint (its name must be unique, otherwise the call returns nil)

RegisterExtensionPoint0(modId : string, extensionPointName : string) : ExtensionPoint0 base/tealdef/scripts/react.d.tl:268

Hinweise

Legt einen Erweiterungspunkt ohne Parameter unter "<modId>::<name>" an.

Rückgabe ExtensionPoint0: Der Erweiterungspunkt, oder nil (mit Warnung), wenn der Name schon vergeben ist.

Beispiel

-- aus base/content/gui/gui/main/main_mod_button_area.tl
main_mod_button_area.MainModButtonAreaExtension = react.RegisterExtensionPoint0(getOwningModId(), "MainModButtonAreaExtension")
-- im Recipe:
local children = gui_react_util.usePlugins(main_mod_button_area.MainModButtonAreaExtension)

RegisterExtensionPoint<RecipeParam>(modId : string, extensionPointName : string) : ExtensionPoint<RecipeParam> base/tealdef/scripts/react.d.tl:269

Hinweise

Legt unter "<modId>::<name>" einen Erweiterungspunkt an, dessen Plugins einen Parameter bekommen.

Rückgabe ExtensionPoint<RecipeParam>: Der Erweiterungspunkt, oder nil (mit Warnung), wenn der Name schon vergeben ist.

RegisterWrapperExtensionPoint0<WrappedRecipe, RecipeParam>(modId : string, extensionPointName : string, wrappedRecipe : WrappedRecipe) : WrapperExtensionPoint<WrappedRecipe, RecipeParam> base/tealdef/scripts/react.d.tl:270

Hinweise

Legt einen Erweiterungspunkt an, dessen Plugins einen Knoten von wrappedRecipe zurückgeben müssen.

Rückgabe WrapperExtensionPoint<WrappedRecipe, RecipeParam>: Der Erweiterungspunkt, oder nil, wenn der Name schon vergeben ist.

RegisterWrapperExtensionPoint<WrappedRecipe, RecipeParam>(modId : string, extensionPointName : string, wrappedRecipe : WrappedRecipe) : WrapperExtensionPoint<WrappedRecipe, RecipeParam> base/tealdef/scripts/react.d.tl:271

Hinweise

Legt einen Erweiterungspunkt mit Parametern an, dessen Plugins einen Knoten von wrappedRecipe zurückgeben müssen.

Rückgabe WrapperExtensionPoint<WrappedRecipe, RecipeParam>: Der Erweiterungspunkt, oder nil, wenn der Name schon vergeben ist.

get all registered plugins for the extensionPoint (returns {} if extensionPoint is nil or otherwise unknown)

getPlugins(extensionPoint? : ExtensionPoint0) : {ReactPlugin0} base/tealdef/scripts/react.d.tl:274

Hinweise

Lädt die Plugins eines Erweiterungspunkts aus allen Ressourcen "react-plugin <id>", sortiert nach order.

Rückgabe {ReactPlugin0}: Die Plugins mit Recipe, Reihenfolge und Bedingung; {} bei nil oder unbekannten Erweiterungspunkten.

Details

gui_react_util.usePlugins ruft diese Funktion auf, wertet die Bedingungen aus und erzeugt die Plugin-Knoten.

getPlugins<RecipeParam>(extensionPoint? : ExtensionPoint<RecipeParam>) : {ReactPlugin<RecipeParam>} base/tealdef/scripts/react.d.tl:275

Hinweise

Lädt die Plugins eines Erweiterungspunkts aus allen Ressourcen "react-plugin <id>", sortiert nach order.

Rückgabe {ReactPlugin<RecipeParam>}: Die Plugins mit Recipe, Reihenfolge und Bedingung; {} bei nil oder unbekannten Erweiterungspunkten.

Details

gui_react_util.usePlugins ruft diese Funktion auf, wertet die Bedingungen aus und erzeugt die Plugin-Knoten.

getPlugins<WrappedRecipe>(extensionPoint? : WrapperExtensionPoint0<WrappedRecipe>) : {ReactPlugin0} base/tealdef/scripts/react.d.tl:276

Hinweise

Lädt die Plugins eines Erweiterungspunkts aus allen Ressourcen "react-plugin <id>", sortiert nach order.

Rückgabe {ReactPlugin0}: Die Plugins mit Recipe, Reihenfolge und Bedingung; {} bei nil oder unbekannten Erweiterungspunkten.

Details

gui_react_util.usePlugins ruft diese Funktion auf, wertet die Bedingungen aus und erzeugt die Plugin-Knoten.

getPlugins<WrappedRecipe, RecipeParam>(extensionPoint? : WrapperExtensionPoint<WrappedRecipe, RecipeParam>) : {ReactPlugin<RecipeParam>} base/tealdef/scripts/react.d.tl:277

Hinweise

Lädt die Plugins eines Erweiterungspunkts aus allen Ressourcen "react-plugin <id>", sortiert nach order.

Rückgabe {ReactPlugin<RecipeParam>}: Die Plugins mit Recipe, Reihenfolge und Bedingung; {} bei nil oder unbekannten Erweiterungspunkten.

Details

gui_react_util.usePlugins ruft diese Funktion auf, wertet die Bedingungen aus und erzeugt die Plugin-Knoten.

Call the original recipe, ignoring replacement configurations. Note that this will not work for builtins.

CallOriginalRecipe(possiblyReplaced : Recipe0) : TreeNodeId base/tealdef/scripts/react.d.tl:280

Hinweise

Ruft das ursprüngliche Recipe auf, auch wenn ein Ersatz dafür registriert ist. Gedacht für den Aufruf innerhalb des Ersatzes.

Rückgabe TreeNodeId

Details

Für Builtins nicht erlaubt (schreibt einen Fehler ins Log und gibt nil zurück).

Beispiel

-- aus mods/release/urbangames_campaign_mission_05/content/mission/mission/perk_icons_replacement.script.tl
local PerkHudIconRepalcement = react.RegisterRecipe("PerkHudIcon", function(param : HudIconToolbox.PerkHudIconParam) : TreeNodeId
    if game_react_globals.getDisableFeatures()["PerkHudIcons"] then
        return nil
    end
    return builtin.BoxLayout{ children = { react.CallOriginalRecipe(hud_icon_toolbox.PerkHudIcon, param) } }
end)

CallOriginalRecipe<Api>(possiblyReplaced : RecipeWithApi0<Api>) : TreeNodeId base/tealdef/scripts/react.d.tl:281

Hinweise

Ruft das ursprüngliche Recipe auf, auch wenn ein Ersatz dafür registriert ist. Gedacht für den Aufruf innerhalb des Ersatzes.

Rückgabe TreeNodeId

Details

Für Builtins nicht erlaubt (schreibt einen Fehler ins Log und gibt nil zurück).

Beispiel

-- aus mods/release/urbangames_campaign_mission_05/content/mission/mission/perk_icons_replacement.script.tl
local PerkHudIconRepalcement = react.RegisterRecipe("PerkHudIcon", function(param : HudIconToolbox.PerkHudIconParam) : TreeNodeId
    if game_react_globals.getDisableFeatures()["PerkHudIcons"] then
        return nil
    end
    return builtin.BoxLayout{ children = { react.CallOriginalRecipe(hud_icon_toolbox.PerkHudIcon, param) } }
end)

CallOriginalRecipe<RecipeParam>(possiblyReplaced : Recipe<RecipeParam>, params : RecipeParam) : TreeNodeId base/tealdef/scripts/react.d.tl:282

Hinweise

Ruft das ursprüngliche Recipe auf, auch wenn ein Ersatz dafür registriert ist. Gedacht für den Aufruf innerhalb des Ersatzes.

Rückgabe TreeNodeId

Details

Für Builtins nicht erlaubt (schreibt einen Fehler ins Log und gibt nil zurück).

Beispiel

-- aus mods/release/urbangames_campaign_mission_05/content/mission/mission/perk_icons_replacement.script.tl
local PerkHudIconRepalcement = react.RegisterRecipe("PerkHudIcon", function(param : HudIconToolbox.PerkHudIconParam) : TreeNodeId
    if game_react_globals.getDisableFeatures()["PerkHudIcons"] then
        return nil
    end
    return builtin.BoxLayout{ children = { react.CallOriginalRecipe(hud_icon_toolbox.PerkHudIcon, param) } }
end)

CallOriginalRecipe<RecipeParam, Api>(possiblyReplaced : RecipeWithApi<RecipeParam, Api>, params : RecipeParam) : TreeNodeId base/tealdef/scripts/react.d.tl:283

Hinweise

Ruft das ursprüngliche Recipe auf, auch wenn ein Ersatz dafür registriert ist. Gedacht für den Aufruf innerhalb des Ersatzes.

Rückgabe TreeNodeId

Details

Für Builtins nicht erlaubt (schreibt einen Fehler ins Log und gibt nil zurück).

Beispiel

-- aus mods/release/urbangames_campaign_mission_05/content/mission/mission/perk_icons_replacement.script.tl
local PerkHudIconRepalcement = react.RegisterRecipe("PerkHudIcon", function(param : HudIconToolbox.PerkHudIconParam) : TreeNodeId
    if game_react_globals.getDisableFeatures()["PerkHudIcons"] then
        return nil
    end
    return builtin.BoxLayout{ children = { react.CallOriginalRecipe(hud_icon_toolbox.PerkHudIcon, param) } }
end)

CallOriginalRecipe<RecipeParam, UserParam>(possiblyReplaced : Recipe2<RecipeParam, UserParam>, params : RecipeParam, userParam : UserParam) : TreeNodeId base/tealdef/scripts/react.d.tl:284

Hinweise

Ruft das ursprüngliche Recipe auf, auch wenn ein Ersatz dafür registriert ist. Gedacht für den Aufruf innerhalb des Ersatzes.

Rückgabe TreeNodeId

Details

Für Builtins nicht erlaubt (schreibt einen Fehler ins Log und gibt nil zurück).

Beispiel

-- aus mods/release/urbangames_campaign_mission_05/content/mission/mission/perk_icons_replacement.script.tl
local PerkHudIconRepalcement = react.RegisterRecipe("PerkHudIcon", function(param : HudIconToolbox.PerkHudIconParam) : TreeNodeId
    if game_react_globals.getDisableFeatures()["PerkHudIcons"] then
        return nil
    end
    return builtin.BoxLayout{ children = { react.CallOriginalRecipe(hud_icon_toolbox.PerkHudIcon, param) } }
end)

RegisterTool<P>(toolDef : ReactToolDefinition<P>) : ReactToolDefinition<P> base/tealdef/scripts/react.d.tl:286

Hinweise

Registriert eine Werkzeugdefinition für den Werkzeug-Stack.

Rückgabe ReactToolDefinition<P>: Dieselbe Definition.

Details

Löst einen Fehler aus, wenn die Definition keinen name hat oder der Name schon registriert ist.

GetRecipeId(IRecipe) : number base/tealdef/scripts/react.d.tl:288

Hinweise

Interne ID eines registrierten Recipes.

Rückgabe number

GetRecipeName<T>(Recipe<T>) : string base/tealdef/scripts/react.d.tl:289

for debugging, as name is not necessarily unique

Hinweise

Name, unter dem ein Recipe registriert wurde (für Debugging; Namen müssen nicht eindeutig sein).

Rückgabe string

useState(?any) : ReactState base/tealdef/scripts/react.d.tl:291

Hinweise

Erzeugt einen Zustand für den aktuellen Knoten. Der erste Renderdurchlauf verwendet den Anfangswert.

Rückgabe ReactState

Beispiel

local focusableState = react.useState(false)
react.setDisableFocusable(not focusableState:old())

useState<T>(?T) : ReactStateT<T> base/tealdef/scripts/react.d.tl:292

Hinweise

Erzeugt einen Zustand für den aktuellen Knoten. Der erste Renderdurchlauf verwendet den Anfangswert.

Rückgabe ReactStateT<T>

Beispiel

local focusableState = react.useState(false)
react.setDisableFocusable(not focusableState:old())

useStateLazy<T>(function() : T) : ReactStateT<T> base/tealdef/scripts/react.d.tl:293

Hinweise

Wie useState, aber der Anfangswert kommt aus einer Funktion, die nur beim ersten Renderdurchlauf aufgerufen wird.

Rückgabe ReactStateT<T>

Create a State that is automatically updated when the source changes. Otherwise, you might need to either read the ref in onStep, or make it a full-fledged State to force child updates.

useMirrorState<T>(sourceRef : ReactRefT<T>) : ReactStateT<T> base/tealdef/scripts/react.d.tl:298

Hinweise

Erzeugt einen Zustand, der einer Quell-Ref oder einem Quellzustand folgt und das Recipe neu rendert, wenn sich die Quelle ändert.

Rückgabe ReactStateT<T>

useMirrorState<T>(sourceState : ReactStateT<T>) : ReactStateT<T> base/tealdef/scripts/react.d.tl:299

Hinweise

Erzeugt einen Zustand, der einer Quell-Ref oder einem Quellzustand folgt und das Recipe neu rendert, wenn sich die Quelle ändert.

Rückgabe ReactStateT<T>

useDependentState<D, S>(sourceRef : ReactRefT<S>, transform : function(curDependent : D, source : S) : D) : ReactStateT<D> base/tealdef/scripts/react.d.tl:300

Hinweise

Erzeugt einen Zustand, der mit transform(current, source) neu berechnet wird, sobald sich die Quell-Ref oder der Quellzustand ändert.

Rückgabe ReactStateT<D>

useDependentState<D, S>(sourceState : ReactStateT<S>, transform : function(curDependent : D, source : S) : D) : ReactStateT<D> base/tealdef/scripts/react.d.tl:301

Hinweise

Erzeugt einen Zustand, der mit transform(current, source) neu berechnet wird, sobald sich die Quell-Ref oder der Quellzustand ändert.

Rückgabe ReactStateT<D>

onStep(function()) base/tealdef/scripts/react.d.tl:303

Hinweise

Registriert eine Funktion, die bei jedem GUI-Step aufgerufen wird, solange der Knoten existiert.

onStepTimer(function(), intervalSeconds? : number, jitter? : boolean) base/tealdef/scripts/react.d.tl:304

jitter: true by default

Hinweise

Registriert eine Funktion, die in einem festen Abstand aufgerufen wird (Standard 0,5 Sekunden). Der Aufruf wird bis nach dem Rendern verschoben.

Parameter	Typ	Beschreibung
#1	function()
intervalSeconds?	number	Abstand in Sekunden.
jitter?	boolean	Verteilt die Aufrufe vieler Knoten über die Zeit; standardmäßig true.

Act if step mode has changed (due to writing into useChildPauseModes()'s result) Normally only used by builtins, e.g. builtin.TabWidgetChild to pause steps of invisible tab content

onPausedChange(function(paused : boolean)) base/tealdef/scripts/react.d.tl:308

note: current implementation calls this at least once even if mode did not change

Hinweise

Registriert eine Funktion, die aufgerufen wird, wenn der Step-Modus des Knotens pausiert oder fortgesetzt wird (genutzt von Builtins wie Tab-Widgets).

useChildPausedModes(paused : {integer : boolean}) : ReactRefWrapT<{integer : boolean}> base/tealdef/scripts/react.d.tl:309

Create a ref where you can store map childIndex->childPaused

Hinweise

Erzeugt eine Ref, die Kindindizes auf „pausiert“ abbildet, um die Steps verborgener Kinder anzuhalten.

Rückgabe ReactRefWrapT<{integer : boolean}>

onEvent(filterForEventName : string, function(string, any)) base/tealdef/scripts/react.d.tl:311

Hinweise

Registriert einen Handler für Events mit dem angegebenen Namen, die mit React.fireEvent gesendet werden.

Parameter	Typ	Beschreibung
filterForEventName	string	Name des Events; muss das erste Argument sein.
#2	function(string, any)

Beispiel

react.onEvent("focusMainModButtonArea", function()
    focusableState:set(true)
    selfRef:get():focus()
end)

useSelfRef() : ReactRefWrap base/tealdef/scripts/react.d.tl:313

Hinweise

Gibt eine Node-Ref auf den Knoten des aktuellen Recipes zurück.

Rückgabe ReactRefWrap

useRef<T>(?T) : ReactRefT<T> base/tealdef/scripts/react.d.tl:315

Hinweise

Erzeugt eine Ref (einen Wert, der über Renderdurchläufe erhalten bleibt) mit einem Anfangswert.

Rückgabe ReactRefT<T>

useRefLazy<T>(function() : T) : ReactRefT<T> base/tealdef/scripts/react.d.tl:316

Hinweise

Wie useRef, aber der Anfangswert kommt aus einer Funktion, die nur beim ersten Renderdurchlauf aufgerufen wird.

Rückgabe ReactRefT<T>

useMirrorRef<T>(ReactStateT<T>) : ReactRefT<T> base/tealdef/scripts/react.d.tl:318

Hinweise

Erzeugt eine Ref, die einem Quellzustand oder einer Quell-Ref folgt.

Rückgabe ReactRefT<T>

useMirrorRef<T>(ReactRefT<T>) : ReactRefT<T> base/tealdef/scripts/react.d.tl:319

Hinweise

Erzeugt eine Ref, die einem Quellzustand oder einer Quell-Ref folgt.

Rückgabe ReactRefT<T>

useDependentRef<D, S>(sourceRef : ReactRefT<S>, transform : function(curDependent : D, source : S) : D) : ReactRefT<D> base/tealdef/scripts/react.d.tl:320

Hinweise

Erzeugt eine Ref, die mit transform(current, source) neu berechnet wird, sobald sich die Quelle ändert.

Rückgabe ReactRefT<D>

useDependentRef<D, S>(sourceState : ReactStateT<S>, transform : function(curDependent : D, source : S) : D) : ReactRefT<D> base/tealdef/scripts/react.d.tl:321

Hinweise

Erzeugt eine Ref, die mit transform(current, source) neu berechnet wird, sobald sich die Quelle ändert.

Rückgabe ReactRefT<D>

useNodeRef() : ReactRefWrap base/tealdef/scripts/react.d.tl:323

Hinweise

Erzeugt eine leere Node-Ref. Übergib sie mit React.ref(...) an einen Recipe-Aufruf, um Zugriff auf den erzeugten Knoten zu bekommen.

Rückgabe ReactRefWrap

Details

Das Recipe-Argument legt nur den Typ der Ref fest; die Implementierung ignoriert es.

Beispiel

-- aus base/content/game_mechanics/game_mechanics/notifications/gui/notification_button.tl
local toolButtonRef = react.useNodeRef(builtin.ToolButton)
react.useInputAction("selectNotifications", react.iaForward(toolButtonRef, "ACTION_CLICK"))
return builtin.ToolButton(react.ref(toolButtonRef), { ... })

useNodeRef<T>(Recipe<T>) : ReactRefWrapT<T> base/tealdef/scripts/react.d.tl:324

Hinweise

Erzeugt eine leere Node-Ref. Übergib sie mit React.ref(...) an einen Recipe-Aufruf, um Zugriff auf den erzeugten Knoten zu bekommen.

Rückgabe ReactRefWrapT<T>

Details

Das Recipe-Argument legt nur den Typ der Ref fest; die Implementierung ignoriert es.

Beispiel

-- aus base/content/game_mechanics/game_mechanics/notifications/gui/notification_button.tl
local toolButtonRef = react.useNodeRef(builtin.ToolButton)
react.useInputAction("selectNotifications", react.iaForward(toolButtonRef, "ACTION_CLICK"))
return builtin.ToolButton(react.ref(toolButtonRef), { ... })

useNodeRef<T, Api>(RecipeWithApi<T, Api>) : ReactRefWrapApiT<T, Api> base/tealdef/scripts/react.d.tl:325

Hinweise

Erzeugt eine leere Node-Ref. Übergib sie mit React.ref(...) an einen Recipe-Aufruf, um Zugriff auf den erzeugten Knoten zu bekommen.

Rückgabe ReactRefWrapApiT<T, Api>

Details

Das Recipe-Argument legt nur den Typ der Ref fest; die Implementierung ignoriert es.

Beispiel

-- aus base/content/game_mechanics/game_mechanics/notifications/gui/notification_button.tl
local toolButtonRef = react.useNodeRef(builtin.ToolButton)
react.useInputAction("selectNotifications", react.iaForward(toolButtonRef, "ACTION_CLICK"))
return builtin.ToolButton(react.ref(toolButtonRef), { ... })

useNodeRef<Api>(RecipeWithApi0<Api>) : ReactRefWrapApi0<Api> base/tealdef/scripts/react.d.tl:326

Hinweise

Erzeugt eine leere Node-Ref. Übergib sie mit React.ref(...) an einen Recipe-Aufruf, um Zugriff auf den erzeugten Knoten zu bekommen.

Rückgabe ReactRefWrapApi0<Api>

Details

Das Recipe-Argument legt nur den Typ der Ref fest; die Implementierung ignoriert es.

Beispiel

-- aus base/content/game_mechanics/game_mechanics/notifications/gui/notification_button.tl
local toolButtonRef = react.useNodeRef(builtin.ToolButton)
react.useInputAction("selectNotifications", react.iaForward(toolButtonRef, "ACTION_CLICK"))
return builtin.ToolButton(react.ref(toolButtonRef), { ... })

ref<T, Api>(ReactRefWrapApiT<T, Api>) : RefFill base/tealdef/scripts/react.d.tl:328

Hinweise

Verpackt eine Node-Ref (oder eine Liste davon) als erstes Argument eines Recipe-Aufrufs. Die Refs bekommen den erzeugten Knoten.

Rückgabe RefFill

ref<T>(ReactRefWrapT<T>) : RefFill base/tealdef/scripts/react.d.tl:329

Hinweise

Verpackt eine Node-Ref (oder eine Liste davon) als erstes Argument eines Recipe-Aufrufs. Die Refs bekommen den erzeugten Knoten.

Rückgabe RefFill

ref<Api>(ReactRefWrapApi0<Api>) : RefFill base/tealdef/scripts/react.d.tl:330

Hinweise

Verpackt eine Node-Ref (oder eine Liste davon) als erstes Argument eines Recipe-Aufrufs. Die Refs bekommen den erzeugten Knoten.

Rückgabe RefFill

ref(ReactRefWrap) : RefFill base/tealdef/scripts/react.d.tl:331

Hinweise

Verpackt eine Node-Ref (oder eine Liste davon) als erstes Argument eines Recipe-Aufrufs. Die Refs bekommen den erzeugten Knoten.

Rückgabe RefFill

ref<T, Api>({ReactRefWrapApiT<T, Api>}) : RefFill base/tealdef/scripts/react.d.tl:333

Hinweise

Verpackt eine Node-Ref (oder eine Liste davon) als erstes Argument eines Recipe-Aufrufs. Die Refs bekommen den erzeugten Knoten.

Rückgabe RefFill

ref<T>({ReactRefWrapT<T>}) : RefFill base/tealdef/scripts/react.d.tl:334

Hinweise

Verpackt eine Node-Ref (oder eine Liste davon) als erstes Argument eines Recipe-Aufrufs. Die Refs bekommen den erzeugten Knoten.

Rückgabe RefFill

ref<Api>({ReactRefWrapApi0<Api>}) : RefFill base/tealdef/scripts/react.d.tl:335

Hinweise

Verpackt eine Node-Ref (oder eine Liste davon) als erstes Argument eines Recipe-Aufrufs. Die Refs bekommen den erzeugten Knoten.

Rückgabe RefFill

ref({ReactRefWrap}) : RefFill base/tealdef/scripts/react.d.tl:336

Hinweise

Verpackt eine Node-Ref (oder eine Liste davon) als erstes Argument eines Recipe-Aufrufs. Die Refs bekommen den erzeugten Knoten.

Rückgabe RefFill

findOldChildByLocalKey(string) : TreeNodeId base/tealdef/scripts/react.d.tl:338

Hinweise

Gibt den Kindknoten des vorigen Renderdurchlaufs zurück, der den angegebenen localKey hatte.

Rückgabe TreeNodeId

onMount(function(any)) base/tealdef/scripts/react.d.tl:340

Hinweise

Registriert eine Funktion, die aufgerufen wird, wenn der Knoten erzeugt wurde.

onUnmount(function(any)) base/tealdef/scripts/react.d.tl:341

Hinweise

Registriert eine Funktion, die aufgerufen wird, wenn der Knoten entfernt wird.

onMouseEvent(function(Gui.Mouse.Event) : boolean) base/tealdef/scripts/react.d.tl:342

Hinweise

Registriert einen Listener für Mausereignisse des Knotens. Gib true zurück, wenn das Ereignis behandelt wurde.

onDragAndDrop(handlers : DragAndDropHandler) base/tealdef/scripts/react.d.tl:343

Hinweise

Macht den Knoten mit den angegebenen Handlern zur Drag-Quelle, zum Ablageziel oder zu beidem.

style(ReactStyleParams) : ReactStyle base/tealdef/scripts/react.d.tl:345

Hinweise

Verpackt Stilparameter, die vor den Parametern eines Recipe-Aufrufs stehen. Das Basisspiel setzt Klassen stattdessen mit meta = { class = ... }.

Rückgabe ReactStyle

useInputAction(string, IaHandler) base/tealdef/scripts/react.d.tl:357

Hinweise

Verknüpft eine Eingabeaktion (z. B. "IA_MENU_BACK") des aktuellen Knotens mit einem Handler, einem Fokuswechsel oder einer Weiterleitung.

Beispiel

react.useInputAction("IA_MENU_BACK", react.iaHandler(function()
    params.onClose()
end))
react.useInputAction("IA_NAV_LEFT", react.iaFocusTraversal(true, false))

useInputAction(string, IaForward) base/tealdef/scripts/react.d.tl:358

Hinweise

Verknüpft eine Eingabeaktion (z. B. "IA_MENU_BACK") des aktuellen Knotens mit einem Handler, einem Fokuswechsel oder einer Weiterleitung.

Beispiel

react.useInputAction("IA_MENU_BACK", react.iaHandler(function()
    params.onClose()
end))
react.useInputAction("IA_NAV_LEFT", react.iaFocusTraversal(true, false))

iaHandler(action : function(), isEnabled? : function() : (boolean | Gui.InputAction.InputActionState), buttonPromptTextOverride? : string, acceptRepeatedPresses? : boolean, isActive? : boolean) : IaHandler base/tealdef/scripts/react.d.tl:360

Hinweise

Erzeugt einen Handler für eine Eingabeaktion.

Parameter	Typ	Beschreibung
action	function()	Wird aufgerufen, wenn die Aktion ausgelöst wird.
isEnabled?	function() : (boolean | Gui.InputAction.InputActionState)	Optional; gibt einen booleschen Wert oder einen Zustand der Eingabeaktion zurück.
buttonPromptTextOverride?	string	Optionaler Text für den Eingabehinweis.
acceptRepeatedPresses?	boolean	Bei true wiederholt sich die Aktion, solange die Taste gehalten wird.
isActive?	boolean	Optionales Aktiv-Flag.

Rückgabe IaHandler

iaHandlerExtended(action : function(Gui.InputAction.InvokeData), isEnabled? : function() : (boolean | Gui.InputAction.InputActionState), buttonPromptTextOverride? : string, isActive? : boolean) : IaHandler base/tealdef/scripts/react.d.tl:362

Hinweise

Wie iaHandler, aber die Aktion bekommt bei jedem Ereignis die Aufrufdaten, auch beim Loslassen der Taste.

Rückgabe IaHandler

Details

Die Implementierung prüft eine nicht definierte Variable, bevor sie buttonPromptTextOverride anwendet. Die Überschreibung wirkt deshalb nicht.

iaForward(ReactRefWrap, ?string) : IaForward base/tealdef/scripts/react.d.tl:364

Hinweise

Leitet die Eingabeaktion an einen anderen Knoten weiter, auf Wunsch als andere Aktion (z. B. "ACTION_CLICK").

Rückgabe IaForward

iaForward<T>(ReactRefWrapT<T>, ?string) : IaForward base/tealdef/scripts/react.d.tl:365

Hinweise

Leitet die Eingabeaktion an einen anderen Knoten weiter, auf Wunsch als andere Aktion (z. B. "ACTION_CLICK").

Rückgabe IaForward

iaForward<T, Api>(ReactRefWrapApiT<T, Api>, ?string) : IaForward base/tealdef/scripts/react.d.tl:366

Hinweise

Leitet die Eingabeaktion an einen anderen Knoten weiter, auf Wunsch als andere Aktion (z. B. "ACTION_CLICK").

Rückgabe IaForward

iaForward<Api>(ReactRefWrapApi0<Api>, ?string) : IaForward base/tealdef/scripts/react.d.tl:367

Hinweise

Leitet die Eingabeaktion an einen anderen Knoten weiter, auf Wunsch als andere Aktion (z. B. "ACTION_CLICK").

Rückgabe IaForward

provideApi(any) base/tealdef/scripts/react.d.tl:369

Hinweise

Setzt die API-Tabelle des aktuellen Knotens. Andere Recipes erreichen sie mit nodeRef:get():getApi().

Beispiel

-- aus base/content/gui/gui/map_editor/map_editor.tl
local wc = param.gameCtx.windowContainer:get():getApi()

Deprecated, will be replaced by ToolStack. Returns selfRef that can be passed in setActiveOwner() useAction and setActiveOwner are for internal use only!

useAction(rcRef : ReactRefWrapT<Builtin.RendererComponentParam>, actionFn? : (function() : TreeNodeId), key2? : string) : ReactRefWrap base/tealdef/scripts/react.d.tl:373

Hinweise

Verknüpft eine Aktionsfunktion mit einer Renderer-Komponente. Veraltet, heute übernimmt das der Werkzeug-Stack.

Rückgabe ReactRefWrap: Self-Ref, die an setActiveOwner übergeben wird.

useAction(rcRef : ReactRefWrapApiT<Builtin.RendererComponentParam, Builtin.RenderComponentAPI>, actionFn? : (function() : TreeNodeId), key2? : string) : ReactRefWrap base/tealdef/scripts/react.d.tl:374

Hinweise

Verknüpft eine Aktionsfunktion mit einer Renderer-Komponente. Veraltet, heute übernimmt das der Werkzeug-Stack.

Rückgabe ReactRefWrap: Self-Ref, die an setActiveOwner übergeben wird.

setActiveOwner(actionUser : ReactRefWrap) base/tealdef/scripts/react.d.tl:375

Hinweise

Intern; aktiviert die Aktion von useAction.

setDisableFocusable(boolean) base/tealdef/scripts/react.d.tl:377

Hinweise

Macht den aktuellen Knoten nicht fokussierbar.

setForceFocusable(boolean) base/tealdef/scripts/react.d.tl:378

Hinweise

Macht den aktuellen Knoten fokussierbar.

setIndicateSelectionWithMouseHoverOnly(boolean) base/tealdef/scripts/react.d.tl:379

Hinweise

Zeigt die Auswahlhervorhebung des aktuellen Knotens nur, wenn die Maus darüber steht.

setRestrictMouseFocus(boolean) base/tealdef/scripts/react.d.tl:380

Hinweise

Setzt das Flag „restrict mouse focus“ des aktuellen Knotens.

setMouseTransparent(boolean) base/tealdef/scripts/react.d.tl:381

Hinweise

Lässt Mausereignisse durch den aktuellen Knoten hindurch.

setLightweight(boolean) base/tealdef/scripts/react.d.tl:382

Hinweise

Markiert den aktuellen Knoten als leichtgewichtig.

Details

Die Implementierung setzt das Flag immer auf true, egal welches Argument du übergibst.

setClipContent(boolean) base/tealdef/scripts/react.d.tl:383

use with care: special animation cases only, otherwise it might mess with the "natural" gui behaviour

setStyleClasses(string, string...) base/tealdef/scripts/react.d.tl:384

Hinweise

Setzt die Style-Klassen des aktuellen Knotens (mit Kommas verbunden).

setPreferredFocusChild<T, Api>(ReactRefWrapApiT<T, Api>) base/tealdef/scripts/react.d.tl:386

Hinweise

Legt das Kind fest, das den Fokus bekommt, wenn der aktuelle Knoten ihn erhält.

setPreferredFocusChild<T>(ReactRefWrapT<T>) base/tealdef/scripts/react.d.tl:387

Hinweise

Legt das Kind fest, das den Fokus bekommt, wenn der aktuelle Knoten ihn erhält.

setPreferredFocusChild<Api>(ReactRefWrapApi0<Api>) base/tealdef/scripts/react.d.tl:388

Hinweise

Legt das Kind fest, das den Fokus bekommt, wenn der aktuelle Knoten ihn erhält.

setPreferredFocusChild(ReactRefWrap) base/tealdef/scripts/react.d.tl:389

Hinweise

Legt das Kind fest, das den Fokus bekommt, wenn der aktuelle Knoten ihn erhält.

iaFocusTraversal(horizontal : boolean, forward : boolean, allowBubbleUp? : boolean) : IaHandler base/tealdef/scripts/react.d.tl:391

Hinweise

Erzeugt eine Eingabeaktion, die den Fokus zum nächsten oder vorigen Knoten bewegt.

Parameter	Typ	Beschreibung
horizontal	boolean	Horizontal (true) oder vertikal (false) bewegen.
forward	boolean	Nach rechts/unten (true) oder nach links/oben (false) bewegen.
allowBubbleUp?	boolean	Am Ende der Liste übernimmt der Elternknoten die Aktion.

Rückgabe IaHandler

fireEvent(source : ReactRefWrap, name : string, param? : any) base/tealdef/scripts/react.d.tl:393

Hinweise

Sendet ein Event mit Namen und optionalem Parameter. Recipes empfangen es mit React.onEvent.

Parameter	Typ	Beschreibung
source	ReactRefWrap	Knoten, von dem das Event ausgeht. Für GUI-weite Events wie "PushTool" übergibt das Basisspiel nil.
name	string
param?	any

Beispiel

-- aus base/content/gui/gui/layers/layer_terrain.tl
react.fireEvent(param.toolParam.gameCtx.rendererComponent, "selectEntity", {entity = entity, stack = true})

fireEvent<T>(source : ReactRefWrapT<T>, name : string, param? : any) base/tealdef/scripts/react.d.tl:394

Hinweise

Sendet ein Event mit Namen und optionalem Parameter. Recipes empfangen es mit React.onEvent.

Parameter	Typ	Beschreibung
source	ReactRefWrapT<T>	Knoten, von dem das Event ausgeht. Für GUI-weite Events wie "PushTool" übergibt das Basisspiel nil.
name	string
param?	any

Beispiel

-- aus base/content/gui/gui/layers/layer_terrain.tl
react.fireEvent(param.toolParam.gameCtx.rendererComponent, "selectEntity", {entity = entity, stack = true})

fireEvent<T, Api>(source : ReactRefWrapApiT<T, Api>, name : string, param? : any) base/tealdef/scripts/react.d.tl:395

Hinweise

Sendet ein Event mit Namen und optionalem Parameter. Recipes empfangen es mit React.onEvent.

Parameter	Typ	Beschreibung
source	ReactRefWrapApiT<T, Api>	Knoten, von dem das Event ausgeht. Für GUI-weite Events wie "PushTool" übergibt das Basisspiel nil.
name	string
param?	any

Beispiel

-- aus base/content/gui/gui/layers/layer_terrain.tl
react.fireEvent(param.toolParam.gameCtx.rendererComponent, "selectEntity", {entity = entity, stack = true})

getCurrentRecipeName() : string base/tealdef/scripts/react.d.tl:397

Hinweise

Name des Recipes, das gerade gerendert wird.

Rückgabe string

getCurrentRecipeId() : integer base/tealdef/scripts/react.d.tl:398

Hinweise

ID des Recipes, das gerade gerendert wird.

Rückgabe integer

enqueueDeferredStep(fn : function(), debugScope : string) base/tealdef/scripts/react.d.tl:400

call this function with restricted api, in parallel to rendering preparations

enqueueJoin(fn : function(), debugScope : string) base/tealdef/scripts/react.d.tl:401

call this function on main thread after all parallelized react things are complete

enqueueParallel<ParamT>(useFnName : string, useFnParams : ParamT, join : function(workItemResult : any, useFnParams : ParamT)) base/tealdef/scripts/react.d.tl:402

computes result in another thread via useFn(useFnName)(...) and applies it via enqueueJoin(result, ...)

React.IaHandler

record base/tealdef/scripts/react.d.tl:347

record IaHandler

Hinweise

Handler für eine Eingabeaktion, erzeugt mit React.iaHandler oder React.iaHandlerExtended.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/statistics/statistics_react_util.tl:84

local iaHandlers : {string : React.IaHandler} = {}

Felder

Name	Typ	Beschreibung
promptTextOverride	string	Text im Eingabehinweis statt des Standardnamens der Aktion.
mode	integer	0: default, 1: auto keyrepeat, 2: get called with InputAction.InvokeData for all events (including keyrelease)

Funktionen

handlerFn(Gui.InputAction.InvokeData) base/tealdef/scripts/react.d.tl:348

note: invokeData is nil if acceptRepeatedPresses == true

isEnabledFn() : boolean base/tealdef/scripts/react.d.tl:349

Hinweise

Gibt zurück, ob die Aktion aktiv ist. Ein boolesches Ergebnis wird in Enabled oder Inactive umgewandelt.

Rückgabe boolean

React.IaForward

record base/tealdef/scripts/react.d.tl:353

record IaForward

Hinweise

Weiterleitung einer Eingabeaktion an einen anderen Knoten, erzeugt mit React.iaForward.

ReactPluginDesc

record global base/tealdef/scripts/react.d.tl:405

global record ReactPluginDesc

Hinweise

data einer generischen Ressource vom Typ "react-plugin <extension point id>".

Felder

Name	Typ	Beschreibung
filePath	ResName	Das Plugin-Recipe als "file.script@RecipeName".
condition	ResName	Optionale Funktionsreferenz ("file.script@fn"), die entscheidet, ob das Plugin angezeigt wird.
order	number	Sortierschlüssel. Plugins werden in aufsteigender Reihenfolge erzeugt (Standard 0).

ReactPlugin0

record global base/tealdef/scripts/react.d.tl:411

global record ReactPlugin0

Hinweise

Ein geladenes Plugin eines Erweiterungspunkts ohne Parameter.

Felder

Name	Typ	Beschreibung
recipe	Recipe0	Das Plugin-Recipe.
order	number	Sortierschlüssel.

Funktionen

condition() : boolean base/tealdef/scripts/react.d.tl:414

Hinweise

Optional; das Plugin wird nur erzeugt, wenn die Funktion true zurückgibt.

Rückgabe boolean

ReactPlugin

record global base/tealdef/scripts/react.d.tl:416

global record ReactPlugin<RecipeParam>

Hinweise

Ein geladenes Plugin eines Erweiterungspunkts mit Parametern.

Felder

Name	Typ	Beschreibung
recipe	Recipe<RecipeParam>	Das Plugin-Recipe.
order	number	Sortierschlüssel.

Funktionen

condition(RecipeParam) : boolean base/tealdef/scripts/react.d.tl:419

Hinweise

Optional; das Plugin wird nur erzeugt, wenn die Funktion für die Parameter true zurückgibt.

Rückgabe boolean

ReactReplacementApi

record global base/tealdef/scripts/react.d.tl:422

global record ReactReplacementApi

Hinweise

API, die doReplaceFn einer Ersetzungskonfiguration bekommt.

Funktionen

ReplaceRecipe<RecipeType>(originalRecipe : RecipeType, replacement : RecipeType) base/tealdef/scripts/react.d.tl:425

delegate all calls to the original recipe to the replacement Remember that the replacement must be fully compatible, e.g. if the original provides an Api, the replacement must provide the same one!

ReactReplacementConfigDesc

record global base/tealdef/scripts/react.d.tl:428

global record ReactReplacementConfigDesc

Hinweise

data einer generischen Ressource vom Typ "react-replacement-config". Sie ersetzt GUI-Recipes, bevor die GUI startet.

Beispiel

-- mods/release/urbangames_campaign_mission_05/content/mission/mission/perk_icons_replacement.res.lua
function data()
    return {
        type = "react-replacement-config",
        data = {
            filePath = "urbangames_campaign_mission_05::/mission/perk_icons_replacement.script",
            doReplaceFn = "doReplaceFn"
        }
    }
end

Felder

Name	Typ	Beschreibung
filePath	ResName	Skriptdatei, die doReplaceFn enthält, ohne den Teil @function.
doReplaceFn	string	name of the function in the above .script.tl
order	number	Sortierschlüssel. Konfigurationen laufen in aufsteigender Reihenfolge (Standard 0).

ReactReplacementConfig

record global base/tealdef/scripts/react.d.tl:434

global record ReactReplacementConfig

Hinweise

Eine geladene Ersetzungskonfiguration.

Felder

Name	Typ	Beschreibung
order	number	Sortierschlüssel.

Funktionen

the function that actually triggers the replacement (takes a callback to tell react what to exactly replace)

doReplaceFn(replacementApi : ReactReplacementApi) base/tealdef/scripts/react.d.tl:436

Die Spieldateien enthalten hierzu noch keine Beschreibung.