Wzorzec Observer

Wzorzec Observer pozwala jednemu obiektowi, podmiotowi, poinformować wiele innych obiektów, obserwatorów, że coś się wydarzyło. Podmiot nie wie, co obserwatorzy zrobią z tą wiadomością; jedynie ją ogłasza.

Napisany ręcznie podmiot przechowuje tablicę obserwatorów i wywołuje tę samą metodę na każdym z nich:

# health.gd
class_name Health
extends RefCounted

var observers: Array = []
var hp := 100

func add_observer(observer) -> void:
	observers.append(observer)

func take_damage(amount: int) -> void:
	hp -= amount
	for observer in observers:
		observer.on_hp_changed(hp)

Godot ma ten wzorzec wbudowany. Sygnał jest komunikatem nadawanym przez obiekt, a każde connect() dodaje obserwatora, więc tablica i pętla nie są już potrzebne:

# health.gd
class_name Health
extends RefCounted

signal hp_changed(new_hp: int)

var hp := 100

func take_damage(amount: int) -> void:
	hp -= amount
	hp_changed.emit(hp)

Obserwatorem jest dowolny obiekt, który ma metodę z parametrami pasującymi do sygnału:

# health_bar.gd
class_name HealthBar
extends RefCounted

func on_hp_changed(new_hp: int) -> void:
	print("Bar: ", new_hp, "/100")

# damage_log.gd
class_name DamageLog
extends RefCounted

func on_hp_changed(new_hp: int) -> void:
	if new_hp < 50:
		print("Log: low health!")

# main.gd
var health := Health.new()
var bar := HealthBar.new()
var damage_log := DamageLog.new()
health.hp_changed.connect(bar.on_hp_changed)
health.hp_changed.connect(damage_log.on_hp_changed)
health.take_damage(70)

Bar: 30/100
Log: low health!

Health nie ma pojęcia, że istnieje pasek ani dziennik. Efekt dźwiękowy lub osiągnięcie też mogą nasłuchiwać, bez wprowadzania choćby jednej zmiany w health.gd.

Trzy zasady sprawiają, że obserwatorzy działają:

• Podłączenie tej samej metody dwa razy jest błędem. Jeśli może do tego dojść, najpierw sprawdź za pomocą hp_changed.is_connected(bar.on_hp_changed). disconnect() usuwa obserwatora, a odłączenie obserwatora, który nie jest podłączony, również jest błędem.
• Połączenie nie utrzymuje obserwatora przy życiu. Przechowuj obserwatora w zmiennej lub tablicy: obiekt utworzony wewnątrz wywołania connect() jest natychmiast zwalniany i nigdy nie odbiera sygnału.
• Podłączaj metody obserwatorów. Lambda, która używa podmiotu i jest podłączona do własnego sygnału podmiotu, utrzymuje podmiot przy życiu na zawsze, co Godot zgłasza jako wyciek przy zamykaniu gry.