eow_extension_util¶
Quelle: base/tealdef/gui/entity_window/eow_extension_util.d.tl
Hinweise
Gemeinsame Parameterschnittstelle und Besitz-Hilfe für die Erweiterungspunkte (Plugins) der Infofenster.
EowExtensionUtil¶
record global base/tealdef/gui/entity_window/eow_extension_util.d.tl:3
global record EowExtensionUtil
Laden: local eow_extension_util = ug_require "::/gui/entity_window/eow_extension_util.tl" as EowExtensionUtil
Hinweise
Gemeinsame Teile der Erweiterungspunkte der Infofenster.
Funktionen
useOwnershipStepState(entity : Engine.Entity) : ReactStateT<OwnershipState> base/tealdef/gui/entity_window/eow_extension_util.d.tl:24
Aufruf: eow_extension_util.useOwnershipStepState(…)
Hinweise
React-Hook, der den Besitzzustand einer Entität liefert und in jedem Schritt aktualisiert.
| Parameter | Typ | Beschreibung |
|---|---|---|
entity |
Engine.Entity |
Zu prüfende Entität. |
Rückgabe ReactStateT<OwnershipState>: React-State, gelesen mit :old().
Im Basisspiel verwendet: 13-mal in 13 Dateien
base/content/gui/gui/entity_window/animal/animal.tl:40
base/content/gui/gui/entity_window/empty_construction/empty_construction.tl:34
base/content/gui/gui/entity_window/fun_elements/fun_elements.tl:40
base/content/gui/gui/entity_window/line/line.tl:127
base/content/gui/gui/entity_window/maintenance_station/maintenance_station.tl:56
base/content/gui/gui/entity_window/perk/perk.tl:104
… und 7 weitere Dateien.
EowExtensionUtil.IEowWidgetsExtensionParams¶
interface base/tealdef/gui/entity_window/eow_extension_util.d.tl:4
interface IEowWidgetsExtensionParams
Hinweise
Basisparameter, die jedes Plugin eines Erweiterungspunkts eines Infofensters erhält (z. B. VehicleEow.VehicleEowExtensionPoint).
Details
Plugins werden über Ressourcendateien vom Typ "react-plugin ::<ExtensionPointName>" mit
data = { filePath = "<script>@<PluginRecipe>", condition = "<script>@<function>", order = <number> }
registriert. Das Fenster ruft gui_react_util.usePlugins(extensionPoint, ..., extensionParams)
auf. Die Plugins erscheinen aufsteigend nach order, und ein Plugin, dessen Funktion condition
für die Parameter false liefert, wird übersprungen.
Felder
| Name | Typ | Beschreibung |
|---|---|---|
entityId |
Engine.Entity |
Entität, die das Fenster zeigt. |
ownershipState |
OwnershipState |
Wem die Entität gehört, siehe EowExtensionUtil.OwnershipState. |
gameCtx |
GameContext |
Spielkontext. |
showCalloutOnRightSide |
boolean |
Ob die Info-Blasen der Inhaltskarten auf der rechten Seite des Fensters erscheinen. |
firstWidgetRef |
ReactRefWrap |
|
lastWidgetRef |
ReactRefWrap |
Funktionen
setCollapsibleExpanded(string, boolean) base/tealdef/gui/entity_window/eow_extension_util.d.tl:11
Hinweise
Speichert den Aufklappzustand einer einklappbaren Inhaltskarte unter einem Schlüssel.
getCollapsibleExpanded(string) base/tealdef/gui/entity_window/eow_extension_util.d.tl:12
Hinweise
Liefert den gespeicherten Aufklappzustand einer einklappbaren Inhaltskarte zu einem Schlüssel.
EowExtensionUtil.OwnershipState¶
enum base/tealdef/gui/entity_window/eow_extension_util.d.tl:18
enum OwnershipState
Hinweise
Besitz einer Entität aus Sicht des lokalen Spielers.
Im Basisspiel verwendet: 4-mal in 2 Dateien
base/content/gui/gui/entity_window/eow_extension_util.tl:5
eow_extension_util.useOwnershipStepState = function(entity : Engine.Entity) : ReactStateT<EowExtensionUtil.OwnershipState>
base/content/gui/gui/entity_window/industry/industry.tl:37