Iteratori personalizzati

Python permette a una classe di comportarsi come una lista grazie a metodi magici come __len__, __getitem__, __contains__ e __iter__. Godot ha metodi virtuali per uno solo di questi compiti: il ciclo for. Tre metodi permettono di usare for item in my_object::

• _iter_init(iter) viene eseguito una volta, prima del primo giro. Imposta la posizione iniziale e restituisce true se esiste un primo elemento.
• _iter_get(position) restituisce l'elemento nella posizione corrente e la variabile del ciclo riceve quel valore.
• _iter_next(iter) viene eseguito prima di ogni giro successivo. Passa alla posizione seguente e restituisce false quando non ci sono altri elementi, terminando così il ciclo.

# 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 è un array con uno slot che Godot crea per ogni ciclo. iter[0] contiene la posizione di quel ciclo e Godot passa il suo valore a _iter_get(). Ora un Team funziona in un ciclo for:

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

Mantieni la posizione in iter[0], non in una variabile membro come _position. Ogni ciclo ha il proprio iter, quindi due cicli sulla stessa squadra, anche uno dentro l’altro, non si intralciano. Con una variabile membro, il ciclo interno sposterebbe la posizione del ciclo esterno.

Gli altri metodi delle liste non hanno un metodo virtuale: len(team) e team[0] generano errori. Scrivi metodi ordinari con nomi simili a quelli di Array, come size(), get_at(index) e has(member). Non verificare l'appartenenza con in: "Ada" in team verifica se Team ha una proprietà o un metodo chiamato Ada, quindi il risultato è false.