callout_react_util¶

Quelle: base/tealdef/gui/main/callout_react_util.d.tl

Hinweise

Recipes für Callouts (kleine Popups, die an einem Knoten hängen): ein Toggle-Button, der ein Callout öffnet, solange er gedrückt ist, und ein Standardrahmen, der den Inhalt eines Callouts mit einem Pfeil zeichnet. Callouts zeigt der Callout-Container (CalloutApi), meist der aus GameContext.calloutContainerRef.

CalloutReactUtil¶

record global base/tealdef/gui/main/callout_react_util.d.tl:3

global record CalloutReactUtil

Laden: local callout_react_util = ug_require "::/gui/main/callout_react_util.tl" as CalloutReactUtil

Hinweise

Recipes für Toggle-Buttons, die Callouts öffnen, und ein Standardrahmen für Callouts.

Felder

Name	Typ	Beschreibung
`ToggleCalloutButton`	`Recipe<ToggleCalloutButtonParamsT<IRecipeParamWithMeta>>`	Toggle-Button, der ein Callout mit dem angegebenen Recipe öffnet, solange er gedrückt ist. 8-mal im Basisspiel verwendet
`DefaultCalloutWrapper`	`Recipe<DefaultCalloutWrapperParamsT<IRecipeParamWithMeta>>`	Zeichnet den Inhalt von `recipe` in einer Box mit der Style-Klasse `callout-content` und darunter einen Pfeil nach unten. 3-mal im Basisspiel verwendet

CalloutReactUtil.ToggleCalloutButtonParamsT¶

record base/tealdef/gui/main/callout_react_util.d.tl:4

record ToggleCalloutButtonParamsT<R is IRecipeParamWithMeta>

Hinweise

Parameter des Recipes ToggleCalloutButton.

Details

R ist der Parametertyp des Recipes, das im Callout angezeigt wird.

Im Basisspiel verwendet: 4-mal in 3 Dateien

base/content/gui/gui/main/callout_react_util.tl:62

callout_react_util.ToggleCalloutButton = react.RegisterRecipe("ToggleCalloutButton", function(params : CalloutReactUtil.ToggleCalloutButtonParamsT<IRecipeParamW

base/content/gui/gui/main/script_param_util.tl:234

as ReactRefWrapApiT<callout_react_util.ToggleCalloutButtonParamsT<IRecipeParamWithMeta>, callout_react_util.ToggleCalloutButtonApi>

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

as ReactRefWrapApiT<callout_react_util.ToggleCalloutButtonParamsT<IRecipeParamWithMeta>, callout_react_util.ToggleCalloutButtonApi>

Felder

Name	Typ	Beschreibung
`gameCtx`	`GameContext`	Spielkontext. Sein `calloutContainerRef` gilt, wenn `calloutContainerRef` nicht gesetzt ist.
`button`	`TreeNodeId`	Knoten, der als Inhalt des Toggle-Buttons erscheint.
`toggleButtonClass`	`string`	Style-Klasse des Toggle-Buttons.
`calloutContainerRef`	`ReactRefWrapApi0<CalloutApi>`	Callout-Container, in dem das Callout geöffnet wird. Bei `nil` gilt `gameCtx.calloutContainerRef`.
`recipe`	`Recipe<R>`	Recipe, das den Inhalt des Callouts baut.
`recipeParam`	`R`	Parameter, die an `recipe` gehen.
`anchor`	`Vec2f`	Ankerpunkt des Callout-Inhalts relativ zu seiner eigenen Größe (`0..1` pro Achse).
`gravity`	`Vec2f`	Punkt auf dem Toggle-Button relativ zu seiner Größe (`0..1` pro Achse), an dem das Callout platziert wird.
`tooltip`	`string`	Tooltip des Toggle-Buttons.

Funktionen

getPositionFn() : Vec2f base/tealdef/gui/main/callout_react_util.d.tl:16

overrides automatic placement

Rückgabe Vec2f

recipeParamCompareFn(R, R) : boolean base/tealdef/gui/main/callout_react_util.d.tl:17

overrides default compare

Rückgabe boolean

onOpenedChanged(boolean) base/tealdef/gui/main/callout_react_util.d.tl:19

Hinweise

Wird mit true aufgerufen, wenn das Callout aufgeht, und mit false, wenn es sich schließt.

onValueChange(integer) base/tealdef/gui/main/callout_react_util.d.tl:21

Hinweise

Wenn gesetzt, wird es mit dem neuen Wert des Toggle-Buttons (0 oder 1) aufgerufen, statt das Callout auf die übliche Weise zu öffnen und zu schließen.

Details

Ohne diesen Callback öffnet das Drücken des Buttons das Callout, und das Lösen schließt es. Mit ihm öffnet oder schließt das Recipe das Callout bei Klicks nicht; der Callback übernimmt diese Logik.

CalloutReactUtil.ToggleCalloutButtonApi¶

record base/tealdef/gui/main/callout_react_util.d.tl:25

record ToggleCalloutButtonApi

Hinweise

API, die ToggleCalloutButton über react.provideApi bereitstellt.

Im Basisspiel verwendet: 3-mal in 2 Dateien

base/content/gui/gui/main/script_param_util.tl:234

as ReactRefWrapApiT<callout_react_util.ToggleCalloutButtonParamsT<IRecipeParamWithMeta>, callout_react_util.ToggleCalloutButtonApi>

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

as ReactRefWrapApiT<callout_react_util.ToggleCalloutButtonParamsT<IRecipeParamWithMeta>, callout_react_util.ToggleCalloutButtonApi>

Funktionen

close() base/tealdef/gui/main/callout_react_util.d.tl:26

Hinweise

Schließt das Callout und setzt den Toggle-Button zurück, wenn das Callout offen ist.

CalloutReactUtil.DefaultCalloutWrapperParamsT¶

record base/tealdef/gui/main/callout_react_util.d.tl:30

record DefaultCalloutWrapperParamsT<R is IRecipeParamWithMeta> is IRecipeParamWithMeta

Hinweise

Parameter des Recipes DefaultCalloutWrapper.

Im Basisspiel verwendet: 2-mal in 2 Dateien

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

local CelebrationCalloutWrapper = react.RegisterRecipe("CelebrationCalloutWrapper", function(param : CalloutReactUtil.DefaultCalloutWrapperParamsT<IRecipeParamW

base/content/gui/gui/main/callout_react_util.tl:198

callout_react_util.DefaultCalloutWrapper = react.RegisterRecipe("DefaultCalloutWrapper", function(params : CalloutReactUtil.DefaultCalloutWrapperParamsT<IRecipe

Felder

Name	Typ	Beschreibung
`recipe`	`Recipe<R>`	Recipe, das den Inhalt im Callout-Rahmen baut.
`recipeParam`	`R`	Parameter, die an `recipe` gehen.