Benutzerdefinierte Iteratoren

Python lässt eine Klasse sich mit magischen Methoden wie __len__, __getitem__, __contains__ und __iter__ wie eine Liste verhalten. Godot hat virtuelle Methoden nur für eine dieser Aufgaben: die for-Schleife. Drei Methoden sorgen dafür, dass for item in my_object: funktioniert:

• _iter_init(iter) wird einmal vor dem ersten Durchlauf ausgeführt. Sie setzt die Startposition und gibt true zurück, wenn es ein erstes Element gibt.
• _iter_get(position) gibt das Element an der aktuellen Position zurück, und die Schleifenvariable erhält diesen Wert.
• _iter_next(iter) wird vor jedem weiteren Durchlauf ausgeführt. Sie geht zur nächsten Position und gibt false zurück, wenn es keine weiteren Elemente gibt, wodurch die Schleife beendet wird.

# 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 ist ein Array mit einem Slot, das Godot für jede Schleife erstellt. iter[0] enthält die Position dieser Schleife, und Godot übergibt seinen Wert an _iter_get(). Ein Team funktioniert jetzt in einer for-Schleife:

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

Speichere die Position in iter[0], nicht in einer Member-Variable wie _position. Jede Schleife erhält ihr eigenes iter, sodass zwei Schleifen über dasselbe Team einander nicht stören, selbst wenn eine innerhalb der anderen liegt. Mit einer Member-Variable würde die innere Schleife die Position der äußeren Schleife verändern.

Für die übrigen Listenaufgaben gibt es keine virtuelle Methode: len(team) und team[0] sind Fehler. Schreibe gewöhnliche Methoden mit Namen wie bei Array, etwa size(), get_at(index) und has(member). Prüfe die Mitgliedschaft nicht mit in: "Ada" in team prüft, ob Team eine Eigenschaft oder Methode namens Ada hat, also ist das Ergebnis false.