Pattern Observer

Il pattern Observer permette a un oggetto, il soggetto, di comunicare a molti altri oggetti, gli osservatori, che è successo qualcosa. Il soggetto non sa cosa facciano gli osservatori con la notizia; si limita ad annunciarla.

Scritto a mano, il soggetto mantiene un array di osservatori e chiama lo stesso metodo su ciascuno:

# 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 ha questo schema integrato. Un segnale è l'annuncio del soggetto e ogni connect() aggiunge un osservatore, quindi l'array e il ciclo non sono più necessari:

# 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)

Un osservatore è qualsiasi oggetto con un metodo i cui parametri corrispondono al segnale:

# 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 non ha idea che esistano una barra o un registro. Anche un effetto sonoro o un obiettivo possono ascoltare, senza apportare alcuna modifica a health.gd.

Tre regole mantengono funzionanti gli osservatori:

• Collegare lo stesso metodo due volte è un errore. Quando potrebbe succedere, verifica prima con hp_changed.is_connected(bar.on_hp_changed). disconnect() rimuove un osservatore e anche scollegarne uno che non è collegato è un errore.
• Una connessione non mantiene in vita l'osservatore. Conserva l'osservatore in una variabile o in un array: un oggetto creato all'interno della chiamata connect() viene liberato immediatamente e non riceve mai il segnale.
• Collega i metodi degli osservatori. Una lambda che usa il soggetto ed è collegata al segnale del soggetto stesso mantiene in vita il soggetto per sempre, e Godot lo segnala come perdita di memoria quando il gioco si chiude.