Iteradores personalizados

Python faz uma classe se comportar como uma lista com métodos mágicos como __len__, __getitem__, __contains__ e __iter__. Godot tem métodos virtuais para apenas uma dessas tarefas: o loop for. Três métodos fazem for item in my_object: funcionar:

• _iter_init(iter) é executado uma vez, antes da primeira iteração. Ele define a posição inicial e retorna true se houver um primeiro elemento.
• _iter_get(position) retorna o elemento na posição atual, e a variável do loop recebe esse valor.
• _iter_next(iter) é executado antes de cada iteração seguinte. Ele avança para a próxima posição e retorna false quando não há mais elementos, encerrando o loop.

# 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 é um Array com uma posição que o Godot cria para cada loop. iter[0] contém a posição desse loop, e o Godot passa seu valor para _iter_get(). Agora, um Team funciona em um loop for:

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

Mantenha a posição em iter[0], não em uma variável membro como _position. Cada loop tem seu próprio iter, então dois loops sobre o mesmo time, mesmo que um esteja dentro do outro, não interferem um no outro. Com uma variável membro, o loop interno moveria a posição do loop externo.

As outras operações de lista não têm método virtual: len(team) e team[0] são erros. Escreva métodos comuns com nomes como os de Array, por exemplo, size(), get_at(index) e has(member). Não teste a pertinência com in: "Ada" in team verifica se Team tem uma propriedade ou método chamado Ada, portanto o resultado é false.