menu_icon_react_util

Quelle: base/tealdef/gui/menu/menu_icon_react_util.d.tl

Hinweise

Bausteine der Hauptmenüseiten (Buttons, Bildkacheln, Kachelraster mit Seiten, Seitenrahmen, Hinweisfeld), geladen mit ug_require "/gui/menu/menu_icon_react_util.tl".

MenuIconReactUtil

record global base/tealdef/gui/menu/menu_icon_react_util.d.tl:3

global record MenuIconReactUtil

Laden: local menu_icon_react_util = ug_require "::/gui/menu/menu_icon_react_util.tl" as MenuIconReactUtil

Hinweise

Layout-Helfer und Recipes für Hauptmenüseiten.

Felder

Name	Typ	Beschreibung
CardButton	Recipe<CardButtonParams>	Großer Menü-Button mit wechselnden Hintergrundbildern und einer Beschriftung am unteren Rand. 3-mal im Basisspiel verwendet
HintWidget	RecipeWithApi<HintWidgetParam, HintWidgetApi>	Feld mit Titel und Beschreibung des Hinweises zum überfahrenen Element des gewählten Tabs. 6-mal im Basisspiel verwendet
HintImage	RecipeWithApi<HintWidgetParam, HintWidgetApi>	Standard-Hinweisbild der Einstellungsseiten. Seine API-Funktionen tun nichts. 3-mal im Basisspiel verwendet

Funktionen

makeButton(text : string, onClick : function(), classes : string, enabled? : boolean, tooltip? : string, ref? : ReactRefWrap, textColorClass? : string, buttonClass? : string) : TreeNodeId base/tealdef/gui/menu/menu_icon_react_util.d.tl:21

Aufruf: menu_icon_react_util.makeButton(…)

Hinweise

Erzeugt einen Text-Button.

Parameter	Typ	Beschreibung
text	string	Text des Buttons.
onClick	function()	Klick-Handler.
classes	string	Style-Klassen des Buttons.
enabled?	boolean	Ob der Button aktiv ist.
tooltip?	string	Tooltip-Text.
ref?	ReactRefWrap	Optionale Node-Ref für den Button.
textColorClass?	string	Zusätzliche Style-Klasse des Texts.
buttonClass?	string	Zusätzliche Style-Klasse des Buttons, zum Beispiel primary oder secondary.

Rückgabe TreeNodeId

Im Basisspiel verwendet: 4-mal in 1 Datei

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

menu_icon_react_util.makeButton(_("Reset Filters"), function()

makeSecondaryButton(text : string, onClick : function(), classes? : string, enabled? : boolean, tooltip? : string, ref? : ReactRefWrap) : TreeNodeId base/tealdef/gui/menu/menu_icon_react_util.d.tl:31

Aufruf: menu_icon_react_util.makeSecondaryButton(…)

Hinweise

Erzeugt einen Text-Button mit der Style-Klasse secondary (siehe makeButton).

Rückgabe TreeNodeId

Im Basisspiel verwendet: 7-mal in 4 Dateien

base/content/gui/gui/menu/advanced_settings.tl:578

menu_icon_react_util.makeSecondaryButton(

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

menu_icon_react_util.makeSecondaryButton(_("Deactivate All"), function()

base/content/gui/gui/menu/savegame_react_util.tl:1215

local deleteButton = menu_icon_react_util.makeSecondaryButton(

base/content/gui/gui/menu/settings_page.tl:1554

return menu_icon_react_util.makeSecondaryButton(

makePrimaryButton(text : string, onClick : function(), classes? : string, enabled? : boolean, tooltip? : string, ref? : ReactRefWrap) : TreeNodeId base/tealdef/gui/menu/menu_icon_react_util.d.tl:39

Aufruf: menu_icon_react_util.makePrimaryButton(…)

Hinweise

Erzeugt einen Text-Button mit der Style-Klasse primary (siehe makeButton).

Rückgabe TreeNodeId

Im Basisspiel verwendet: 3-mal in 3 Dateien

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

not missingFilterState:old() and menu_icon_react_util.makePrimaryButton(_("Show All"),

base/content/gui/gui/menu/new_game_or_map_settings_page.tl:610

local startBtn = menu_icon_react_util.makePrimaryButton(

base/content/gui/gui/menu/savegame_react_util.tl:1138

local loadBtn = menu_icon_react_util.makePrimaryButton(

makeCardButton(text : string, onClick : function(), onAttention : function(x : number, y : number), tooltip : string, images : {string | Builtin.ImageViewParam}, initialImageIndex : integer, imageSwapOffsetSeconds? : number, displayDurationSeconds? : number, class? : string, extraChildren? : {TreeNodeId}, enabled? : boolean) : TreeNodeId base/tealdef/gui/menu/menu_icon_react_util.d.tl:47

Aufruf: menu_icon_react_util.makeCardButton(…)

Hinweise

Erzeugt einen CardButton, dessen untere Beschriftung text als Haupttitel der Kachel zeigt.

Rückgabe TreeNodeId

Im Basisspiel verwendet: 7-mal in 2 Dateien

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

local campaignCard = menu_icon_react_util.makeCardButton(

base/content/gui/gui/menu/new_game_page.tl:72

table.insert(climatesTabsBuilder, menu_icon_react_util.makeCardButton(

makeTabWidget(elements : {TreeNodeId}, maxNumPerPage : integer, makeEmptyElem : (function(last : boolean) : TreeNodeId), numRows : integer, selectedTabState : ReactStateT<integer>, ref? : ReactRefWrap) : TreeNodeId base/tealdef/gui/menu/menu_icon_react_util.d.tl:60

Aufruf: menu_icon_react_util.makeTabWidget(…)

Hinweise

Ordnet Elemente in einem Raster aus numRows Zeilen mit je maxNumPerPage Elementen an. Passen sie nicht auf eine Seite, werden die Seiten zu Tabs mit Punktanzeige, Pfeil-Buttons und Blättern per Mausrad.

Parameter	Typ	Beschreibung
elements	{TreeNodeId}	Anzuordnende Elemente.
maxNumPerPage	integer	Anzahl der Elemente pro Zeile.
makeEmptyElem	(function(last : boolean) : TreeNodeId)	Erzeugt den Platzhalter für leere Zellen. last ist true für die letzte Zelle einer Zeile.
numRows	integer	Anzahl der Zeilen pro Seite (Standard 2).
selectedTabState	ReactStateT<integer>	Zustand mit dem Index der angezeigten Seite.
ref?	ReactRefWrap	Optionale Node-Ref.

Rückgabe TreeNodeId

Im Basisspiel verwendet: 3-mal in 3 Dateien

base/content/gui/gui/menu/campaign_page.tl:250

table.insert(tabs, menu_icon_react_util.makeTabWidget(cards, campaign and maxMissionsPerPage or maxCampaignsPerPage, function( lastElem : boolean ) : TreeNodeId

base/content/gui/gui/menu/new_game_page.tl:115

table.insert(childrenOuter, menu_icon_react_util.makeTabWidget(

base/content/gui/gui/menu/releasenotes_window.tl:63

} or menu_icon_react_util.makeTabWidget(elements, 1, releasenotes_util.createEmpty, releaseNotes.infoItemsPerPage, tabIndexState, toSelect)

makePage(commonParams : CommonMenuParams, text : string, back : function(), centerItem : TreeNodeId, extra : {TreeNodeId}, campaignBriefingScreen? : boolean) : TreeNodeId base/tealdef/gui/menu/menu_icon_react_util.d.tl:68

Aufruf: menu_icon_react_util.makePage(…)

Hinweise

Erzeugt den Rahmen einer Menüseite mit Hintergrund-Canvas, einem optionalen mittigen Element und einer oberen Leiste mit Titel und Zurück-Button.

Parameter	Typ	Beschreibung
commonParams	CommonMenuParams	Gemeinsame Parameter der Menüseite.
text	string	Titel der Seite. Bei nil entsteht keine obere Leiste.
back	function()	Wird vom Zurück-Button und von der Eingabeaktion IA_MENU_BACK aufgerufen.
centerItem	TreeNodeId	Element in der Mitte der Seite.
extra	{TreeNodeId}	Weitere schwebende Layout-Kinder.
campaignBriefingScreen?	boolean	Ob die obere Leiste im Stil des Kampagnen-Briefings erscheint.

Rückgabe TreeNodeId

Im Basisspiel verwendet: 15-mal in 12 Dateien

base/content/gui/gui/menu/achievements_page.tl:14

return menu_icon_react_util.makePage(

base/content/gui/gui/menu/campaign_page.tl:22

return menu_icon_react_util.makePage(

base/content/gui/gui/menu/credits_page.tl:15

return menu_icon_react_util.makePage(

base/content/gui/gui/menu/license_page.tl:116

return menu_icon_react_util.makePage(

base/content/gui/gui/menu/load_game_page.tl:81

return menu_icon_react_util.makePage(

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

return menu_icon_react_util.makePage(nil, nil, nil, nil, {

… und 6 weitere Dateien.

makeCardLabelBottomComponent(textTitle : string, textDescription : string, textRight : string, postTitleChild : TreeNodeId, mainTitleCard : boolean) : TreeNodeId base/tealdef/gui/menu/menu_icon_react_util.d.tl:77

Aufruf: menu_icon_react_util.makeCardLabelBottomComponent(…)

Hinweise

Erzeugt die untere Beschriftung einer Kachel mit Titel, optionaler Beschreibung und optionalem rechtsbündigem Text auf einem Effekt-Hintergrund.

Parameter	Typ	Beschreibung
textTitle	string	Titeltext.
textDescription	string	Optionale Beschreibung unter dem Titel.
textRight	string	Optionaler Text rechts.
postTitleChild	TreeNodeId	Optionales Element hinter dem Titel.
mainTitleCard	boolean	Ob die große Titelschrift der Hauptkacheln verwendet wird.

Rückgabe TreeNodeId

Im Basisspiel verwendet: 2-mal in 2 Dateien

base/content/gui/gui/menu/campaign_page.tl:147

return menu_icon_react_util.makeCardLabelBottomComponent(

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

bottomComponent = menu_icon_react_util.makeCardLabelBottomComponent(

makeMainOuterCard(addSpacer : boolean, children : {TreeNodeId}) : TreeNodeId base/tealdef/gui/menu/menu_icon_react_util.d.tl:85

Aufruf: menu_icon_react_util.makeMainOuterCard(…)

Hinweise

Packt Elemente in den vertikalen Container main-outer-card, auf Wunsch mit einem Abstandhalter oben.

Rückgabe TreeNodeId

Im Basisspiel verwendet: 8-mal in 7 Dateien

base/content/gui/gui/menu/achievements_page.tl:22

menu_icon_react_util.makeMainOuterCard(

base/content/gui/gui/menu/load_game_page.tl:92

menu_icon_react_util.makeMainOuterCard(

base/content/gui/gui/menu/mod_manager_page.tl:317

menu_icon_react_util.makeMainOuterCard(

base/content/gui/gui/menu/new_game_or_map_settings_page.tl:1026

menu_icon_react_util.makeMainOuterCard(

base/content/gui/gui/menu/new_game_page.tl:219

table.insert(childrenOuter, menu_icon_react_util.makeMainOuterCard(

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

menu_icon_react_util.makeMainOuterCard(

… und 1 weitere Dateien.

makeTabAnalogue(headerChildren : {TreeNodeId}, bodyChildren : {TreeNodeId}) : TreeNodeId base/tealdef/gui/menu/menu_icon_react_util.d.tl:89

Aufruf: menu_icon_react_util.makeTabAnalogue(…)

Hinweise

Erzeugt einen Container, der wie ein Tab-Widget aussieht, mit einer waagrechten Kopfzeile und einem senkrechten Inhaltsbereich.

Rückgabe TreeNodeId

Im Basisspiel verwendet: 3-mal in 3 Dateien

base/content/gui/gui/menu/achievements_page.tl:25

menu_icon_react_util.makeTabAnalogue(

base/content/gui/gui/menu/load_game_page.tl:223

menu_icon_react_util.makeTabAnalogue(

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

menu_icon_react_util.makeTabAnalogue(

MenuIconReactUtil.CardButtonParams

record base/tealdef/gui/menu/menu_icon_react_util.d.tl:4

record CardButtonParams

Hinweise

Parameter von CardButton.

Im Basisspiel verwendet: 1-mal in 1 Datei

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

menu_icon_react_util.CardButton = react.RegisterRecipe("CardButton", function(cardButtonParams : MenuIconReactUtil.CardButtonParams) : TreeNodeId

Felder

Name	Typ	Beschreibung
bottomComponent	TreeNodeId	Inhalt der Beschriftung am unteren Rand der Kachel, zum Beispiel aus makeCardLabelBottomComponent.
tooltip	string	Tooltip der Kachel.
images	{string | Builtin.ImageViewParam}	Hintergrundbilder (Pfade oder Parameter für eine Bildansicht). Bei mehr als einem Bild wechseln sie nacheinander mit Überblendung.
initialImageIndex	integer	Index des ersten angezeigten Bildes (Standard 1).
imageSwapOffsetSeconds	number	Zeitversatz des Bildwechsels in Sekunden, damit nicht mehrere Kacheln im selben Moment wechseln (Standard 0).
displayDurationSeconds	number	Anzeigedauer jedes Bildes in Sekunden (Standard 24).
class	string	Style-Klasse der Kachel (Standard small-card). main-menu-card kommt immer dazu.
extraChildren	{TreeNodeId}	Weitere schwebende Layout-Kinder auf der Kachel.
localKey	string	Lokaler Schlüssel des Kachel-Buttons.
enabled	boolean	Ob die Kachel aktiv ist.
clipper	boolean	Ob die Bilder auf die Kachel zugeschnitten werden.

Funktionen

onClick() base/tealdef/gui/menu/menu_icon_react_util.d.tl:6

Hinweise

Wird beim Klick auf die Kachel aufgerufen.

onAttention(x : number, y : number) base/tealdef/gui/menu/menu_icon_react_util.d.tl:7

Hinweise

Wird aufgerufen, wenn die Kachel Aufmerksamkeit bekommt (Hover oder Fokus). Übergeben wird eine Position auf der Kachel (aus getPosition des Nodes), an der sich ein Popup daneben platzieren lässt.

MenuIconReactUtil.HintWidgetParam

record base/tealdef/gui/menu/menu_icon_react_util.d.tl:94

record HintWidgetParam

Hinweise

Parameter von HintWidget und HintImage.

Im Basisspiel verwendet: 5-mal in 2 Dateien

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

menu_icon_react_util.HintWidget = react.RegisterRecipe("HintWidget", function(param : MenuIconReactUtil.HintWidgetParam) : TreeNodeId

base/content/gui/gui/menu/settings_page.tl:1583

hintWidgetRef : ReactRefWrapApiT<MenuIconReactUtil.HintWidgetParam, MenuIconReactUtil.HintWidgetApi>

Felder

Name	Typ	Beschreibung
tabId2Hints	{any : {Data}}	integer|number|string
selectedTab	any	integer|number|string
placeHolderHint	Data	Hinweis, der erscheint, wenn kein Element überfahren wird oder der Tab keine Hinweise hat.

MenuIconReactUtil.HintWidgetParam.Data

record base/tealdef/gui/menu/menu_icon_react_util.d.tl:95

record Data

Hinweise

Text eines Hinweises.

Im Basisspiel verwendet: 11-mal in 4 Dateien

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

) : MenuIconReactUtil.HintWidgetParam.Data, TreeNodeId

base/content/gui/gui/menu/advanced_settings.tl:70

local idData : {MenuIconReactUtil.HintWidgetParam.Data} = {}

base/content/gui/gui/menu/new_game_or_map_settings_page.tl:753

local makeGenericHint = function() : MenuIconReactUtil.HintWidgetParam.Data

base/content/gui/gui/menu/settings_page.tl:1607

local tab2id : {integer : {MenuIconReactUtil.HintWidgetParam.Data}} = {}

Felder

Name	Typ	Beschreibung
title	string	Titel des Hinweises.
description	string	Text des Hinweises.
imagePath	string	Bild des Hinweises. Die Einstellungsseite setzt es, HintWidget und HintImage zeigen es aber nicht an.

MenuIconReactUtil.HintWidgetApi

record base/tealdef/gui/menu/menu_icon_react_util.d.tl:105

record HintWidgetApi

Hinweise

API von HintWidget zum Setzen des überfahrenen Elements.

Im Basisspiel verwendet: 3-mal in 2 Dateien

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

end) as RecipeWithApi<MenuIconReactUtil.HintWidgetParam, MenuIconReactUtil.HintWidgetApi>

base/content/gui/gui/menu/settings_page.tl:1583

hintWidgetRef : ReactRefWrapApiT<MenuIconReactUtil.HintWidgetParam, MenuIconReactUtil.HintWidgetApi>

Funktionen

getHovered() : integer base/tealdef/gui/menu/menu_icon_react_util.d.tl:106

Hinweise

Gibt den Index des überfahrenen Elements zurück (0, wenn keines).

Rückgabe integer

setHovered(index : integer) base/tealdef/gui/menu/menu_icon_react_util.d.tl:107

Hinweise

Setzt den Index des überfahrenen Elements, dessen Hinweis dann erscheint.