credits_react_util¶

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

Hinweise

Die Credits-Diashow des Hauptmenüs. Die Folien kommen aus gui/menu/configs/credits_screen_data.lua, das eine Tabelle der Form { slides = {...} } zurückgibt.

CreditsReactUtil¶

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

global record CreditsReactUtil

Laden: local credits_react_util = ug_require "::/gui/main/credits_react_util.tl" as CreditsReactUtil

Hinweise

Recipe für die Credits und die Datentypen der Credits-Folien.

Felder

Name	Typ	Beschreibung
`slides`	`{Slide}`	Die Liste der Folien (gefüllt aus `credits_screen_data.lua`).
`CreditsContent`	`Recipe<CreditsContentParam>`	Die Credits-Diashow. Der Spieler kann zurück- und vorblättern (links/rechts oder Klick), anhalten (oben) und fortsetzen (unten).Im Spiel Pause · Fortsetzen · WeiterIm Code: Pause · Continue · Next 2-mal im Basisspiel verwendet

CreditsReactUtil.CreditsContentParam¶

record base/tealdef/gui/main/credits_react_util.d.tl:5

record CreditsContentParam

Hinweise

Parameter von CreditsContent.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/main/credits_react_util.tl:123

credits_react_util.CreditsContent = react.RegisterRecipe("CreditsContent", function(param : CreditsReactUtil.CreditsContentParam) : TreeNodeId

Felder

Name	Typ	Beschreibung
`stopOnBreakpoint`	`boolean`	Bei `true` hält die Show an `Breakpoint`-Folien an (und ruft `setFinished` auf), sonst werden sie übersprungen.

Funktionen

setPause(value : boolean) base/tealdef/gui/main/credits_react_util.d.tl:6

Hinweise

Wird mit true oder false aufgerufen, wenn der Spieler die Diashow anhält oder fortsetzt.

getPause() : boolean base/tealdef/gui/main/credits_react_util.d.tl:7

Hinweise

Gibt zurück, ob die Diashow angehalten ist.

Rückgabe boolean

setFinished() base/tealdef/gui/main/credits_react_util.d.tl:8

Hinweise

Wird aufgerufen, wenn die Show eine Breakpoint-Folie erreicht und stopOnBreakpoint true ist.

CreditsReactUtil.Credit¶

record base/tealdef/gui/main/credits_react_util.d.tl:12

record Credit

Hinweise

Ein Eintrag einer Credits-Folie (eine Textzeile, ein Bild oder zwei Unterspalten).

Im Basisspiel verwendet: 4-mal in 1 Datei

base/content/gui/gui/main/credits_react_util.tl:7

local makeVerticalLayoutOfItems : function(items : {CreditsReactUtil.Credit}, slideType : CreditsReactUtil.Slide.SlideType, extraClass? : string) : TreeNodeId

Felder

Name	Typ	Beschreibung
`filterOut`	`any`
`type`	`string`	Art des Texteintrags, legt seinen Stil fest (`"HEADER0"`, `"HEADER1"`, `"HEADER2"`, `"NAME"`, `"LICENSE"`, `"LINK"` oder `"TWO_COLUMNS"` für einen Eintrag aus zwei Spalten in `subItems`).
`text`	`string`	Text des Eintrags.
`rich`	`boolean`
`image`	`string`	Pfad eines Bildes; ist er gesetzt, zeigt der Eintrag nur dieses Bild.
`subItems`	`{{Credit}}`	Bei `type = "TWO_COLUMNS"` die Einträge der linken (`[1]`) und der rechten (`[2]`) Spalte.

CreditsReactUtil.Slide¶

record base/tealdef/gui/main/credits_react_util.d.tl:21

record Slide

Hinweise

Eine Folie der Credits.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/main/credits_react_util.tl:11

slide : CreditsReactUtil.Slide

Felder

Name	Typ	Beschreibung
`slideType`	`SlideType`	Layout der Folie.
`items`	`{Credit}`	Einträge einer Folie vom Typ `SingleColumn` oder `Scroller`.
`rows`	`{{{Credit}}}`	Zeilen einer Folie vom Typ `TwoColumns`; jede Zeile ist `{leftEntries, rightEntries}`.
`duration`	`number`	Anzeigedauer der Folie in Sekunden (Standard 6); gilt nicht für Folien vom Typ `Scroller`.

CreditsReactUtil.Slide.SlideType¶

enum base/tealdef/gui/main/credits_react_util.d.tl:22

enum SlideType

Hinweise

Layout einer Folie.

Im Basisspiel verwendet: 4-mal in 1 Datei

base/content/gui/gui/main/credits_react_util.tl:7

local makeVerticalLayoutOfItems : function(items : {CreditsReactUtil.Credit}, slideType : CreditsReactUtil.Slide.SlideType, extraClass? : string) : TreeNodeId

Wert	Beschreibung
`"SingleColumn"`	Die `items` in einer Spalte.
`"TwoColumns"`	Die `rows`, jede mit einer linken und einer rechten Spalte.
`"Scroller"`	Die `items` in einem Bereich, der von selbst scrollt; ist das Ende erreicht, beginnt die nächste Folie.
`"Breakpoint"`	Ohne Inhalt; beendet die Show, wenn `stopOnBreakpoint` gesetzt ist, sonst wird sie übersprungen.