Zum Inhalt

collapsible_checkbox_list

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

Hinweise

Listen von Kontrollkästchen unter einer Kopfschaltfläche. Sie klappen entweder an Ort und Stelle auf und zu (CollapsibleCheckboxList) oder öffnen sich als Callout (CheckboxListCallout). Beide gehen mit Maus und Gamepad.

CheckboxList

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

global record CheckboxList

Laden: local checkboxList = ug_require "::/gui/main/collapsible_checkbox_list.tl" as CheckboxList

Hinweise

Recipes für Listen von Kontrollkästchen mit Kopfzeile.

Felder

Name Typ Beschreibung
CollapsibleCheckboxList Recipe<CollapsibleCheckboxListParam> Kopfschaltfläche mit einer Liste von Kontrollkästchen darunter, die an Ort und Stelle auf- und zuklappt. 1-mal im Basisspiel verwendet
CheckboxListCallout Recipe<CheckboxListCalloutParam> Schaltfläche, die eine Liste von Kontrollkästchen in einem Callout öffnet (über CalloutReactUtil.ToggleCalloutButton). Einträge können auch unbestimmt sein (drei Zustände). 1-mal im Basisspiel verwendet

CheckboxList.CollapsibleCheckboxListParam

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

record CollapsibleCheckboxListParam

Hinweise

Parameter von CollapsibleCheckboxList.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/main/collapsible_checkbox_list.tl:134

checkboxList.CollapsibleCheckboxList = react.RegisterRecipe("CollapsibleCheckboxList", function(param : CheckboxList.CollapsibleCheckboxListParam) : TreeNodeId

Felder

Name Typ Beschreibung
header string Text der Kopfschaltfläche, die die Liste auf- und zuklappt.
hasArrow boolean defaults to false if nil
verticalScrollPolicy Builtin.Type.ScrollBarPolicy defaults to AlwaysOff if nil

Funktionen

onToggle(index : integer) base/tealdef/gui/main/collapsible_checkbox_list.d.tl:5

Hinweise

Wird mit dem Index (ab 1) des Eintrags aufgerufen, den der Spieler umgeschaltet hat.

isToggled(index : integer) : boolean base/tealdef/gui/main/collapsible_checkbox_list.d.tl:6

Hinweise

Gibt zurück, ob der Eintrag mit dem angegebenen Index (ab 1) angehakt ist.

Rückgabe boolean

makeEntries() : {{TreeNodeId, integer}} base/tealdef/gui/main/collapsible_checkbox_list.d.tl:9

second param is for level (defaults to 1 if nil)

Rückgabe {{TreeNodeId, integer}}

CheckboxList.CheckboxListCalloutParam

record base/tealdef/gui/main/collapsible_checkbox_list.d.tl:15

record CheckboxListCalloutParam

Hinweise

Parameter von CheckboxListCallout.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/main/collapsible_checkbox_list.tl:193

checkboxList.CheckboxListCallout = react.RegisterRecipe("CheckboxListCallout", function(param : CheckboxList.CheckboxListCalloutParam) : TreeNodeId

Felder

Name Typ Beschreibung
calloutContainerRef ReactRefWrapApi0<CalloutApi> Referenz auf den Callout-Container, in dem sich die Liste öffnet (zum Beispiel gameCtx.calloutContainerRef).
isToggledDependentSource ReactStateT<any> React-State, aus dem die Zustände der Kontrollkästchen abgeleitet werden.
header string Text der Schaltfläche, die das Callout öffnet.
hasArrow boolean defaults to false if nil
verticalScrollPolicy Builtin.Type.ScrollBarPolicy defaults to AlwaysOff if nil
indeterminateToggleToChecked boolean if true, toggling an indifferent checkbox will set it to checked instead of unchecked
tooltip string Tooltip der Schaltfläche, die das Callout öffnet.

Funktionen

onToggle(index : integer) base/tealdef/gui/main/collapsible_checkbox_list.d.tl:18

Hinweise

Wird mit dem Index (ab 1) des Eintrags aufgerufen, den der Spieler umgeschaltet hat.

transformDependentSourceFn({integer}, any) : {integer} base/tealdef/gui/main/collapsible_checkbox_list.d.tl:20

Hinweise

Leitet den Zustand jedes Eintrags aus isToggledDependentSource ab, so wie react.useDependentState es erwartet.

Rückgabe {integer}

Details

Die entstehende Liste hat einen Wert je Eintrag (1 angehakt, 0 nicht angehakt, -1 unbestimmt).

makeEntries() : {{TreeNodeId, integer}} base/tealdef/gui/main/collapsible_checkbox_list.d.tl:23

second param is for level (defaults to 1 if nil)

Rückgabe {{TreeNodeId, integer}}