カスタムイテレータ

Pythonでは、__len__、__getitem__、__contains__、__iter__などのマジックメソッドを使って、クラスをリストのように振る舞わせることができます。Godotには、これらの役割のうち1つだけ、つまりforループ用の仮想メソッドがあります。次の3つのメソッドによって、for item in my_object:が機能します。

• _iter_init(iter)は、最初の反復の前に1回実行されます。開始位置を設定し、最初の要素がある場合はtrueを返します。
• _iter_get(position)は現在の位置にある要素を返し、ループ変数にはその値が入ります。
• _iter_next(iter)は、それ以降の各反復の前に実行されます。次の位置に進み、要素が残っていない場合はfalseを返して、ループを終了します。

# 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は、Godotが各ループに対して作成する1つのスロットを持つ配列です。iter[0]にはそのループの位置が格納され、Godotはその値を_iter_get()に渡します。これでTeamはforループで使えるようになります。

var team := Team.new()
team.add("Ada")
team.add("Bo")
for member in team:
	print(member) # Ada、次にBo

位置はメンバー変数（_positionなど）ではなく、iter[0]に保持します。各ループは独自のiterを持つため、同じチームを対象とする2つのループは、一方がもう一方の内側にある場合でも、互いに影響しません。メンバー変数を使うと、内側のループによって外側のループの位置が移動してしまいます。

リストの他の操作には仮想メソッドがありません。len(team) と team[0] はエラーになります。size()、get_at(index)、has(member) など、Array のメソッドと同じような名前の通常のメソッドを書きます。in でメンバーシップをテストしないでください。"Ada" in team は、Team に Ada という名前のプロパティまたはメソッドがあるかどうかを調べるため、false になります。