GUI-Vorlagenknoten

GUI-Vorlagenknoten (GUI template nodes) bieten einen leistungsfähigen Mechanismus, um wiederverwendbare GUI-Komponenten (GUI components) auf Grundlage gemeinsam genutzter Vorlagen oder „Prefabs“ zu erstellen. Dieses Handbuch erklärt die Funktion und ihre Verwendung.

Eine GUI-Vorlage (GUI template) ist eine GUI-Szene (GUI scene), die Knoten für Knoten in einer anderen GUI-Szene instanziiert wird. Anschließend kannst du beliebige Eigenschaftswerte der ursprünglichen Vorlagenknoten überschreiben.

Eine Vorlage erstellen

Eine GUI-Vorlage ist eine gewöhnliche GUI-Szene und wird daher wie jede andere GUI-Szene erstellt. Klicke mit der rechten Maustaste auf einen Ort im Bereich Assets und wähle New... ▸ Gui.

Erstelle die Vorlage und speichere sie. Beachte, dass die Knoten der Instanz relativ zum Ursprung platziert werden. Daher empfiehlt es sich, die Vorlage an der Position 0, 0, 0 zu erstellen.

Instanzen aus einer Vorlage erstellen

Du kannst beliebig viele Instanzen auf Grundlage der Instanz erstellen. Erstelle oder öffne die GUI-Szene, in der du die Vorlage platzieren möchtest. Klicke dann mit der rechten Maustaste auf den Abschnitt Nodes in Outline und wähle Add ▸ Template.

Setze die Eigenschaft Template auf die GUI-Szenendatei der Vorlage.

Du kannst beliebig viele Vorlageninstanzen hinzufügen. Für jede Instanz kannst du die Eigenschaften jedes Knotens überschreiben und die Position, Farbgebung, Größe, Textur und weitere Eigenschaften der Instanzknoten ändern.

Jede Eigenschaft, die du änderst, wird im Editor blau markiert. Klicke auf die Schaltfläche zum Zurücksetzen neben der Eigenschaft, um ihren Wert auf den Vorlagenwert zurückzusetzen:

Jeder Knoten mit überschriebenen Eigenschaften wird auch in Outline blau dargestellt:

Die Vorlageninstanz wird als einklappbarer Eintrag in der Ansicht Outline aufgeführt. Beachte jedoch, dass dieser Eintrag in der Übersicht kein Knoten ist. Die Vorlageninstanz existiert auch zur Laufzeit nicht, wohl aber alle Knoten, die zur Instanz gehören.

Knoten, die zu einer Vorlageninstanz gehören, werden automatisch benannt, indem ein Präfix und ein Schrägstrich ("/") vor ihre Id gesetzt werden. Das Präfix ist die Id, die in der Vorlageninstanz festgelegt ist.

Vorlagen zur Laufzeit ändern

Skripte, die über den Vorlagenmechanismus hinzugefügte Knoten ändern oder abfragen, müssen lediglich die Benennung der Instanzknoten berücksichtigen und die Id der Vorlageninstanz als Präfix des Knotennamens einbeziehen:

if gui.pick_node(gui.get_node("button_1/button"), x, y) then
    -- Do something...
end

Es gibt keinen Knoten, der der Vorlageninstanz selbst entspricht. Wenn du einen Wurzelknoten für eine Instanz benötigst, füge ihn zur Vorlage hinzu.

Wenn einer GUI-Szene als Vorlage ein Skript zugeordnet ist, gehört dieses Skript nicht zum Knotenbaum der Instanz. Du kannst jeder GUI-Szene nur ein einziges Skript zuordnen. Daher muss deine Skriptlogik in der GUI-Szene liegen, in der du deine Vorlagen instanziiert hast.