Using signals¶
In dieser Lektion werden wir uns mit Signalen beschäftigen. Das sind Nachrichten, die Nodes aussenden, wenn etwas Bestimmtes mit ihnen passiert, z. B. wenn eine Taste gedrückt wird. Andere Nodes können sich mit diesem Signal verbinden und eine Funktion aufrufen, wenn das Ereignis eintritt.
Signals are a delegation mechanism built into Godot that allows one game object to react to a change in another without them referencing one another. Using signals limits coupling and keeps your code flexible.
Sie könnten zum Beispiel einen Lebensbalken auf dem Bildschirm haben, der die Gesundheit des Spielers anzeigt. Wenn der Spieler Schaden erleidet oder einen Heiltrank benutzt, soll der Balken die Veränderung anzeigen. Dazu würden Sie in Godot Signale verwenden.
Bemerkung
Wie in der Einleitung erwähnt, sind Signale Godot's Version des Beobachtermusters. Sie können hier mehr darüber erfahren: https://gameprogrammingpatterns.com/observer.html
Wir werden nun ein Signal verwenden, um unser Godot-Symbol aus dem letzten Teil (Eingaben des Spielers abhören) zu bewegen und durch Drücken einer Taste anzuhalten.
Eine Szene einrichten¶
Um unserem Spiel einen Knopf hinzuzufügen, erstellen wir eine neue "main"-Szene, die sowohl einen Knopf als auch die Sprite.tscn Szene enthält, die wir in den vorherigen Lektionen geschrieben haben.
Erstellen Sie eine neue Szene, indem Sie das Menü Szene -> Neue Szene aufrufen.
Klicken Sie im Szenendock auf die Schaltfläche 2D-Szene. Dadurch wird ein Node2D als Wurzel hinzugefügt.
Klicken Sie im Dateisystem-Dock auf die zuvor gespeicherte Datei Sprite.tscn und ziehen Sie sie auf die Node2D, um sie zu instanziieren.
Wir wollen einen weiteren Knoten neben dem Sprite hinzufügen. Dazu klickst du mit der rechten Maustaste auf Node2D und wählst Node hier anhängen.
Suche nach dem Button Node-Typ und füge es hinzu.
Der Knoten ist standardmäßig klein. Klicken und ziehen Sie am unteren rechten Ziehpunkt der Schaltfläche, um die Größe zu ändern.
Wenn Sie die Hinweise nicht sehen, vergewissern Sie sich, dass das Auswahlwerkzeug in der Werkzeugleiste aktiviert ist.
Klicken und ziehen Sie den Knopf, um ihn näher an das Sprite zu bringen.
You can also write a label on the Button by editing its Text property in the Inspector. Enter "Toggle motion".
Dein Szenenbaum und Ansichtsfenster sollten wie folgt aussehen.
Save your newly created scene. You can then run it with F6. At the moment, the button will be visible, but nothing will happen if you press it.
Verbinden von Signalen im Editor¶
Hier wollen wir das Signal "pressed" des Buttons mit unserem Sprite verbinden und eine neue Funktion aufrufen, die seine Bewegung ein- und ausschaltet. Wir brauchen ein Skript, das an den Sprite-Knoten angehängt ist, wie wir es in der vorherigen Lektion getan haben.
Du kannst Signale im Node-Dock verbinden. Wähle den Button-Node aus und klicke auf der rechten Seite des Editors auf die Registerkarte "Node" neben dem Inspektor.
Das Dock zeigt eine Liste aller verfügbaren Signale für das ausgewählte Node an.
Doppelklick auf das „pressed“ Signal, um das Knotenverbindungsfenster zu öffnen.
Dort kannst du das Signal mit dem Sprite-Knoten verbinden. Der Knoten benötigt eine Empfängermethode, eine Funktion, die Godot aufruft, wenn der Button das Signal sendet. Der Editor generiert die Funktion für dich. Der Konvention nach nennen wir diese Callback-Methoden "_on_NodeName_signal_name". Hier wird es "_on_Button_pressed" sein.
Bemerkung
Man kann zweierlei Modi verwenden, um Signale über das Node-Dock zu verbinden. Der einfache Modus erlaubt ausschließlich die Verbindung zu Knoten mit dazugehörigem Script und erstellt in diesem eine neue Callback-Funktion.
The advanced view lets you connect to any node and any built-in function, add arguments to the callback, and set options. You can toggle the mode in the window's bottom-right by clicking the Advanced button.
Click the Connect button to complete the signal connection and jump to the Script workspace. You should see the new method with a connection icon in the left margin.
Wenn man auf das Symbol klickt öffnet sich ein Fenster und zeigt Informationen über die Verbindung an. Diese Eigenschaft ist nur verfügbar, wenn Knoten im Editor verbunden werden.
Lassen Sie uns die Zeile im Code mit dem pass Schlüsselwort durch Code ersetzen, welcher die Bewegung des Nodes umschaltet.
Unser Sprite lässt sich dank des Codes in der _process()-Funktion bewegen. Godot stellt eine Methode bereit, um den Ablauf zu aktivieren und zu deaktivieren: Node.set_process(). Eine weitere Methode der Node-Klasse, is_processing(), gibt true zurück, falls die Ausführung aktiv ist. Man kann diesen Wert über das Schlüsselwort not umdrehen.
func _on_Button_pressed():
set_process(not is_processing())
Diese Funktion schaltet die Ausführung um und die Bewegung des Symbols beim Drücken der Knopfes entsprechend ein und aus.
Bevor man das Spiel ausprobiert, muss die _process()-Funktion vereinfacht werden, um den Knoten automatisch zu bewegen und nicht auf die Eingabe des Anwenders warten zu müssen. Daher ersetzen wir ihren Code durch den folgenden, der bereits in er vorletzten Lektion vor kam:
func _process(delta):
rotation += angular_speed * delta
var velocity = Vector2.UP.rotated(rotation) * speed
position += velocity * delta
Der komplette Szenenbaum Sprite.gd sollte wie folgt aussehen.
extends Sprite
var speed = 400
var angular_speed = PI
func _process(delta):
rotation += angular_speed * delta
var velocity = Vector2.UP.rotated(rotation) * speed
position += velocity * delta
func _on_Button_pressed():
set_process(not is_processing())
Starte Sie die Szene und klicken Sie auf die Schaltfläche um das Sprite zum Laufen und Halten zu bringen.
Ein Signal über Code verbinden¶
Man kann Signale auch über den Code erzeugen anstelle den Editor zu verwenden. Dies ist notwendig, falls man Notes oder Szenen innerhalb eines Skriptes erzeugen möchte.
Wir verwenden an dieser Stelle einen anderen Node. Godot besitzt einen Knoten Timer, der hilfreich ist, um Skill-Cooldown-Zeiten, das Nachladen von Waffen oder anderes zu implementieren.
Gehen Sie zurück zum 2D-Arbeitsbereich. Sie können entweder auf den "2D"-Text oben im Fenster klicken oder Strg + F1 (Alt + 1 unter macOS) drücken.
Rechtsklicken sie im Szene-Panel das Sprite-Node und füge einen weiteren Knoten hinzu (Node hier anhängen). Suche sie nach Timer und ergänzt den entsprechenden Knoten. Im Anschluss sollte die Szene wie folgt aussehen.
Bei angewähltem Timer-Knoten lässt sich im Inspektor die Autostart-Eigenschaft anwählen.
Drücken Sie auf das Skript-Symbol neben dem Sprite und springen Sie zurück in den Script-Arbeitsbereich.
Es müssen zwei Schritte ausgeführt werden, um die Knoten im Code zu verbinden:
Ermittelt den Verweis auf den Timer des Sprites.
Rufen Sie die
connect()-Methode des Timers auf.
Bemerkung
Um das Signal im Quellcode anzubinden, ruft man die connect()-Methode des Knotens auf, dessen Signal man erwartet. In diesem Fall wird das "timeout"-Signal des Timers erwartet.
Wir wollen das Signal verbinden wenn die Szene instantiiert wird und das können wir über die integrierte Funktion Node._ready(), welche automatisch von der Engine aufgerufen wird, wenn das Node vollständig instantiiert ist.
Um die Referenz auf einen Knoten zu erhalten, der sich in Relation zum aktuellen befindet, verwendet man die Methode Node.get_node(). Die Referenz kann in einer Variablen gespeichert werden.
func _ready():
var timer = get_node("Timer")
Die Funktion get_node() ermittelt den Knoten an Hand des Namens der Sprite-Kinderknoten. Wenn man den Timer beispielsweise in "BlinkingTimer" umbenannt hat, muss man den Aufruf in get_node("BlinkingTimer") abändern.
Nun kann man den Timer in der _ready()-Funktion zum Sprite anbinden.
func _ready():
var timer = get_node("Timer")
timer.connect("timeout", self, "_on_Timer_timeout")
Die Zeile liest sich wie folgt: Das Signal "timeout" von Timer wird mit dem Knoten verbunden, dem das Script gehört (self). Sobald der Timer "timeout" sendet, soll die Funktion "_on_Timer_timeout" angestoßen werden, die gerade definiert wurde. Diese wird jetzt am Ende des Skriptes ergänzt, um die Sichtbarkeit des Sprites umschalten zu können.
func _on_Timer_timeout():
visible = not visible
Die Eigenschaft visible ist ein boolean-Wert, der festlegt, ob ein Knoten sichtbar ist. Die Zeile visible = not visible wechselt zwischen sichtbar und unsichtbar hin und her. Wenn visible auf true war wird es auf false gestetzt und umgekehrt.
If you run the scene now, you will see that the sprite blinks on and off, at one second intervals.
Complete script¶
Das ist nun unsere kleine bewegende und blinkende Godot-icon-Demo. Hier ist die vollständige Sprite.gd-Datei als Referenz.
extends Sprite
var speed = 400
var angular_speed = PI
func _ready():
var timer = get_node("Timer")
timer.connect("timeout", self, "_on_Timer_timeout")
func _process(delta):
rotation += angular_speed * delta
var velocity = Vector2.UP.rotated(rotation) * speed
position += velocity * delta
func _on_Button_pressed():
set_process(not is_processing())
func _on_Timer_timeout():
visible = not visible
Benutzerdefinierte Signale¶
Bemerkung
Dieser Abschnitt dient als Referenz für die Definition und Verwendung eigener Signale und baut nicht auf dem in den vorherigen Lektionen erstellten Projekt auf.
Man kann mehrere verschiedene Signale innerhalb eines Skriptes definieren. Möchte man beispielsweise einen "Game Over"-Bildschirm anzeigen, sobald der Gesundheitswert des Spielers auf Null gesunken ist, kann man ein Signal namens "died" oder "health_depleted" definieren, das angestoßen wird, sobald der Gesundheitswert auf Null gesetzt wurde.
extends Node2D
signal health_depleted
var health = 10
Bemerkung
Da sämtliche Signale Ereignisse repräsentieren, die gerade erst stattfanden, verwendet man üblicherweise die Vergangenheitsform des Verbes für deren Namen.
Diese Signale arbeiten genau so wie native: Sie erscheinen im Node-Tab und man kann sie wie alle anderen anbinden.
Um ein Signal per Code auszusenden, verwende die Funktion emit_signal.
func take_damage(amount):
health -= amount
if health <= 0:
emit_signal("health_depleted")
Ein Signal kann optional auch ein oder mehrere Argumente deklarieren. Geben Sie die Argumentnamen zwischen den Klammern an:
extends Node
signal health_changed(old_value, new_value)
Bemerkung
Die Signal-Argumente werden oben im Bearbeitungs-Node-Dock auftauchen, und Godot kann diese nutzen, um Aufruf-Funktionen für Sie zu generieren. Allerdings kann man immer noch jede beliebige Anzahl von Argumenten aufrufen, wenn man Signale aufruft. Es ist also in der Hand der Person, diese richtigen Werte aufzurufen.
To emit values along with the signal, add them as extra arguments to the
emit_signal() function:
func take_damage(amount):
var old_health = health
health -= amount
emit_signal("health_changed", old_health, health)
Zusammenfassung¶
Jeder Knoten in Godot sendet Signale, wenn etwas spezielles passiert, beispielsweise beim Drücken eines Buttons. Andere Knoten können sich mit definierten Signalen verbinden und so auf die ausgewählten Ereignisse reagieren.
Signale können vielfältig verwendet werden. Man kann auf einen Knoten reagieren, der gerade die Spielwelt betritt oder verlässt, auf eine Kollision, darauf dass eine Spielfigur einen bestimmten Bereich betritt oder verlässt, darauf dass ein Element seine Größe verändert und vieles mehr.
For example, an Area2D representing a coin emits a
body_entered signal whenever the player's physics body enters its collision
shape, allowing you to know when the player collected it.
In the next section, Dein erstes 2D-Spiel, you'll create a complete 2D game and put everything you learned so far into practice.