Godot : _enter_tree()や、_ready()などの実行順をなるべく詳しく紹介

この記事の概要

この記事では、オープンソースのゲームエンジンであるGodot Engineで、ノードと呼ばれるクラスの初期化時の処理について解説します。

この記事の対象者

• _init()や_ready()、_process()などの関数の役割がなんとなく分かっている方
• 「シグナルが想定したタイミングで実行されてない」と感じる方
• ノードの親子関係が複雑になるにつれて、どういう順番で処理されるのかが、いまいちわからない方

前提 : ノードが初期化される際の処理について

Godot Engineでは、Node系のクラスが初期化される際には、いくつかの関数やシグナル、通知が呼び出されます。例えば、ノードがゲーム画面に表示されるタイミングや、スクリプト経由でnew()やinstantiate()によって初期化された瞬間、add_child()でシーンツリーに加わった瞬間などです。

例えば以下のような関数・シグナルがあります：

• _init()
• _enter_tree()
• _ready()
• tree_entered シグナル
• ready シグナル
• _notification() / この記事では通知と呼称します

これらの関数やシグナル、通知などの処理順について、いくつかの親子関係を想定し、なるべく網羅的に紹介します^[1][2]。また、この記事では便宜上、シーンツリーに加えられて、_process()が実行される直前までを「初期化」の範囲とします。

この記事を書く際に使ったコード

GDScriptのコードを末尾に記載しました。同じ結果になるか、ぜひご自分でもお試しください。

ノードがひとつの場合

まずは、ツリーに親子がない、孤立したノードがひとつの場合の実行順を紹介します。

大文字で記載されているものが、_notification()でキャッチすることができる通知です。

1. _init()
2. NOTIFICATION_ENTER_CANVAS
3. NOTIFICATION_ENTER_TREE
4. _enter_tree()
5. tree_entered シグナル
6. _ready()
7. NOTIFICATION_READY
8. ready シグナル
9. _process()

上述の通り、_init() → _enter_tree() → _ready() → _process()の順番で処理されるのが、初期化の際の基本的な流れとなります。

また、_enter_tree()の後にtree_entered シグナルが発火するなど、関数 → シグナルの順番に処理されることがわかると思います。

親子関係にあるノードの場合

次に、親子関係にある2つのノードの場合の実行順です。

リストが長くなるので、ここからは通知とシグナルを省略したものを記載します。通知とシグナルを含めた順番は、アコーディオンUIにしまってあるので、そちらをご覧ください。

1. 親 _init()
2. 子 _init()
3. 親 _enter_tree()
4. 子 _enter_tree()
5. 子 _ready()
6. 親 _ready()
7. 親 _process()
8. 子 _process()

通知とシグナルを含めた順番を表示

1. 親 _init()
2. 子 _init()
3. 親 NOTIFICATION_ENTER_CANVAS
4. 親 NOTIFICATION_ENTER_TREE
5. 親 _enter_tree()
6. 親 tree_entered シグナル
7. 子 NOTIFICATION_ENTER_CANVAS
8. 子 NOTIFICATION_ENTER_TREE
9. 子 _enter_tree()
10. 子 tree_entered シグナル
11. 子 _ready()
12. 子 NOTIFICATION_READY
13. 子 ready シグナル
14. 親 _ready()
15. 親 NOTIFICATION_READY
16. 親 ready シグナル
17. 親 _process()
18. 子 _process()

ノードツリーに加えられたことを知らせるenter_tree系の処理までは、親→子の順番で、ready系では子→親となり、_processで再び親→子の順番に戻ることがわかりますね。

子が2つ以上ある場合

続いては、子ノードが2つある場合の挙動です。

1. 親 _init()
2. 子A _init()
3. 子B _init()
4. 親 _enter_tree()
5. 子A _enter_tree()
6. 子B _enter_tree()
7. 子A _ready()
8. 子B _ready()
9. 親 _ready()
10. 親 _process()
11. 子A _process()
12. 子B _process()

通知とシグナルを含めた順番を表示

1. 親 _init()
2. 子A _init()
3. 子B _init()
4. 親 NOTIFICATION_ENTER_CANVAS
5. 親 NOTIFICATION_ENTER_TREE
6. 親 _enter_tree()
7. 親 tree_entered シグナル
8. 子A NOTIFICATION_ENTER_CANVAS
9. 子A NOTIFICATION_ENTER_TREE
10. 子A _enter_tree()
11. 子A tree_entered シグナル
12. 子B NOTIFICATION_ENTER_CANVAS
13. 子B NOTIFICATION_ENTER_TREE
14. 子B _enter_tree()
15. 子B tree_entered シグナル
16. 子A _ready()
17. 子A NOTIFICATION_READY
18. 子A ready シグナル
19. 子B _ready()
20. 子B NOTIFICATION_READY
21. 子B ready シグナル
22. 親 _ready()
23. 親 NOTIFICATION_READY
24. 親 ready シグナル
25. 親 _process()
26. 子A _process()
27. 子B _process()

基本的には、上述の親子関係にある場合と同様です。

ただ、子ノードが同階層に2つ以上ある場合は、常にシーンエディタで「上」にあるノードから順番に処理されることがわかります。

同じ階層のノードが処理される順番は常に「上」から

子ノード2つと、孫ノードがある場合

今度は、先ほどの子ノードのうち、「Child_A」に孫ノードを加えた場合の挙動を見てみましょう。

1. 親 _init()
2. 子A _init()
3. 孫 _init()
4. 子B _init()
5. 親 _enter_tree()
6. 子A _enter_tree()
7. 孫 _enter_tree()
8. 子B _enter_tree()
9. 孫 _ready()
10. 子A _ready()
11. 子B _ready()
12. 親 _ready()
13. 親 _process()
14. 子A _process()
15. 孫 _process()
16. 子B _process()

通知とシグナルを含めた順番を表示

1. 親 _init()
2. 子A _init()
3. 孫 _init()
4. 子B _init()
5. 親 NOTIFICATION_ENTER_CANVAS
6. 親 NOTIFICATION_ENTER_TREE
7. 親 _enter_tree()
8. 親 tree_entered シグナル
9. 子A NOTIFICATION_ENTER_CANVAS
10. 子A NOTIFICATION_ENTER_TREE
11. 子A _enter_tree()
12. 子A tree_entered シグナル
13. 孫 NOTIFICATION_ENTER_CANVAS
14. 孫 NOTIFICATION_ENTER_TREE
15. 孫 _enter_tree()
16. 孫 tree_entered シグナル
17. 子B NOTIFICATION_ENTER_CANVAS
18. 子B NOTIFICATION_ENTER_TREE
19. 子B _enter_tree()
20. 子B tree_entered シグナル
21. 孫 _ready()
22. 孫 NOTIFICATION_READY
23. 孫 ready シグナル
24. 子A _ready()
25. 子A NOTIFICATION_READY
26. 子A ready シグナル
27. 子B _ready()
28. 子B NOTIFICATION_READY
29. 子B ready シグナル
30. 親 _ready()
31. 親 NOTIFICATION_READY
32. 親 ready シグナル
33. 親 _process()
34. 子A _process()
35. 孫 _process()
36. 子B _process()

子Aの下に孫ノードがある場合は、基本的に子Bの処理の前に孫が処理されることがわかります。

また、_ready()については、常にノードの一番深いところにあるノードが優先して処理されることがわかります（今回の場合は孫ノード）。

まとめ

ポイント

親子関係にあるノードにおいては、以下の特徴を覚えておくと良いと思います。

• ready系は、ツリー上の一番深いノードの_ready()から処理される
• 同じ階層のノードは、基本的にシーンエディタで「上」に表示されているものから処理される
• 常に関数 → シグナルの順番で実行される（例:_ready()→ready シグナルの順）
• 通知の実行位置には、例えば「関数 → 通知 → シグナル」のような法則はない
• この記事とは関係ないですが、@onready修飾子の変数は_ready()実行前に代入されます

飛び道具の"通知"

また、普段あまり使われることがない通知 / _notification()ですが、_enter_tree()の前など、ピンポイントに「このタイミングで処理したい」みたいな処理に使うことが可能です。

とはいえ、乱用するとコードの見通しが悪くなる可能性もあるので注意が必要です。初期化周りの処理は、基本的に_init()、_enter_tree()、_ready()で事足りると思います^[3]。

おわり

ノードの初期化時の処理順は、最初はなかなか理解しづらいところが多いかもしれません。今回の記事が、その理解の手助けになるようであれば幸いです。

---

今回の記事で使ったコード

以下のコードを使っていただければ、ご自身の環境でも同様の順番になることが確認できると思います^[4]。

✅ Godot 4.2.2

extends Node

var is_process_started := false


func _init():
	print("_init()")
	self.ready.connect(func(): print(self.name + " ready シグナル"))
	self.tree_entered.connect(func(): print(self.name + " tree_entered シグナル"))


func _enter_tree():
	print(self.name + " _enter_tree()")


func _ready():
	print(self.name + " _ready()")


func _process(delta):
	if not is_process_started:
		is_process_started = true
		print(self.name + " _process()")


func _notification(what):
	match what:
		NOTIFICATION_ENTER_CANVAS:
			print(self.name + " NOTIFICATION_ENTER_CANVAS")
		NOTIFICATION_ENTER_TREE:
			print(self.name + " NOTIFICATION_ENTER_TREE")
		NOTIFICATION_READY:
			print(self.name + " NOTIFICATION_READY")

脚注

1. この題材については、すでに国内外で様々な記事において多数紹介されていて、今更記事にする必要もないかと考えていました。が、_notification()を含めて紹介しているものがあまりないことや、学びはじめの方には少し理解しづらい点もあり、同じ題材でも複数の記事で多角的に扱うメリットを念頭に、あえて記事化することとしました。なお、この記事の元ネタは、_notification()を含めたready, enter_treeなどの実行順というタイトルのスクラップで書いたものとなります。

2. 初期化時の処理については、Godotの公式ドキュメント内のシーンツリーでも詳しく触れられています。

3. 個人的には…ですが、_init()と_ready()で事足りることが多いです。

4. self.nameを使うことで、ノード名をそのままログに出力できるようにしています。ただ、_init()が実行される時点ではself.nameを参照できないため、そこだけself.nameを書いていません。コードは自由にお使いください。