仮想メソッド入門

Python には __init__ や __str__ のようなマジックメソッドがあり、言語がそれらを呼び出します。Godot ではこれに相当するのが仮想メソッドです。これは、アンダースコアで始まる固定名を持つメソッドで、クラス内で定義すると、適切なタイミングで Godot が呼び出します。すでに 2 つ使いました。

• _init() は、new() がオブジェクトを作成するときに、new() に渡された引数とともに実行されます。
• _ready() は、ノードがシーンツリーに入ったときに実行されます。これは main.gd が開始する場所です。

その他には、オブジェクトが出力されるときに呼び出される _to_string()、for ループでオブジェクトを走査できるようにするイテレーターメソッド（どちらも次のレッスンで扱います）、そしてエンジンからイベントを受け取る _notification() があります。そのうちの1つである NOTIFICATION_PREDELETE は、オブジェクトが削除される直前に送られます。

# torch.gd
class_name Torch
extends RefCounted

var label: String

func _init(new_label: String = "Torch") -> void:
	label = new_label
	print(label, " lit")

func _notification(what: int) -> void:
	if what == NOTIFICATION_PREDELETE:
		print(label, " burned out")

# main.gd
var torch := Torch.new("Hall torch") # ホールのたいまつが点灯した
torch = null # ホールのたいまつが燃え尽きた

RefCountedオブジェクトは、どの変数からも参照されなくなるとすぐに削除されるため、torch = nullは即座に通知を送信します。_init()のデフォルト値によって、new()の引数は省略可能になります。Torch.new()は、Torchという名前のtorchを作成します。

Python も、+ に対する __add__ や、== に対する __eq__ など、演算子にマジックメソッドを使います。GDScript には演算子のオーバーロードがありません。potion_a + potion_b はエラーになります。代わりにメソッドを書きます。

# potion.gd
class_name Potion
extends RefCounted

var power: int

func _init(start_power: int) -> void:
	power = start_power

func combined(other: Potion) -> Potion:
	return Potion.new(power + other.power)

potion_a.combined(potion_b)は新しいポーションを返し、元の2つのポーションには変更を加えません。2つのオブジェクト間の==は、両者の値が一致するかどうかではなく、両者が同じオブジェクトかどうかを確認します。つまり、Potion.new(5) == Potion.new(5)はfalseです。値を比較する必要がある場合は、equals(other)のようなメソッドを書きましょう。