Patron Observer

Le modèle Observer permet à un objet, le sujet, d’informer de nombreux autres objets, les observateurs, qu’un événement s’est produit. Le sujet ne sait pas ce que les observateurs font de cette information ; il se contente de l’annoncer.

Écrit à la main, le sujet conserve un tableau d’observateurs et appelle la même méthode sur chacun d’eux :

# 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 intègre ce modèle. Un signal est l’annonce du sujet, et chaque connect() ajoute un observateur, de sorte que le tableau et la boucle ne sont plus nécessaires :

# 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 observateur est tout objet doté d’une méthode dont les paramètres correspondent au signal :

# 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 n’a aucune idée qu’une barre ou un journal existe. Un effet sonore ou un succès peut aussi écouter, sans apporter la moindre modification à health.gd.

Trois règles permettent aux observateurs de fonctionner :

• Connecter deux fois la même méthode est une erreur. Lorsque cela peut se produire, vérifie d’abord avec hp_changed.is_connected(bar.on_hp_changed). disconnect() supprime un observateur, et déconnecter un observateur qui n’est pas connecté est également une erreur.
• Une connexion ne maintient pas l’observateur en vie. Conserve l’observateur dans une variable ou un tableau : un objet créé à l’intérieur de l’appel connect() est immédiatement libéré et ne reçoit jamais le signal.
• Connecte les méthodes des observateurs. Une lambda qui utilise le sujet et qui est connectée au propre signal du sujet maintient celui-ci en vie pour toujours, ce que Godot signale comme une fuite à la fermeture du jeu.