Itérateurs personnalisés

Python permet à une classe de se comporter comme une liste grâce à des méthodes magiques telles que __len__, __getitem__, __contains__ et __iter__. Godot dispose de méthodes virtuelles pour une seule de ces tâches : la boucle for. Trois méthodes permettent à for item in my_object: de fonctionner :

• _iter_init(iter) s’exécute une fois, avant le premier tour. Elle définit la position de départ et renvoie true s’il existe un premier élément.
• _iter_get(position) renvoie l’élément à la position actuelle, et la variable de boucle reçoit cette valeur.
• _iter_next(iter) s’exécute avant chaque tour suivant. Elle passe à la position suivante et renvoie false lorsqu’il n’y a plus d’éléments, ce qui termine la boucle.

# team.gd
class_name Team
extends RefCounted

var _members: Array[String] = []

func add(member: String) -> void:
	_members.append(member)

func _iter_init(iter: Array) -> bool:
	iter[0] = 0
	return iter[0] < _members.size()

func _iter_next(iter: Array) -> bool:
	iter[0] += 1
	return iter[0] < _members.size()

func _iter_get(position):
	return _members[position]

iter est un tableau avec un emplacement que Godot crée pour chaque boucle. iter[0] contient la position de cette boucle, et Godot transmet sa valeur à _iter_get(). Un Team fonctionne désormais dans une boucle for :

var team := Team.new()
team.add("Ada")
team.add("Bo")
for member in team:
	print(member) # Ada, puis Bo

Conservez la position dans iter[0], et non dans une variable membre telle que _position. Chaque boucle possède son propre iter, donc deux boucles sur la même équipe, même si l’une est imbriquée dans l’autre, ne se perturbent pas. Avec une variable membre, la boucle interne déplacerait la position de la boucle externe.

Les autres opérations sur une liste n’ont pas de méthode virtuelle : len(team) et team[0] sont des erreurs. Écris des méthodes ordinaires portant des noms comme celles d’Array, telles que size(), get_at(index) et has(member). Ne teste pas l’appartenance avec in : "Ada" in team vérifie si Team possède une propriété ou une méthode nommée Ada, donc le résultat est false.