シングルトンパターン

Singletonパターンを使うと、クラスが持つオブジェクトを必ず1つだけにでき、すべてのスクリプトからそのオブジェクトにアクセスする方法を1つに統一できます。設定、セーブシステム、スコア管理など、ゲーム内に1つだけあればよいものに使います。

GDScript では、static var が単一のオブジェクトを保持し、static func は誰かが初めてそのオブジェクトを求めたときに作成します：

# game_settings.gd
class_name GameSettings
extends RefCounted

static var _instance: GameSettings = null

var volume := 50

static func get_instance() -> GameSettings:
	if _instance == null:
		_instance = GameSettings.new()
		print("Creating settings")
	return _instance

_instanceはオブジェクトではなくクラスに属するため、すべてのスクリプトが同じ変数を参照します。最初の呼び出しでは空であることが確認され、オブジェクトが作成されます。それ以降の呼び出しでは、毎回同じオブジェクトが返されます。

# main.gd
var a := GameSettings.get_instance()
var b := GameSettings.get_instance()
a.volume = 80
print(b.volume)
print(a == b)

Creating settings
80
true

aとbは同じオブジェクトを保持する2つの変数なので、aを通じて加えた変更はbにも反映されます。オブジェクトの場合、==がtrueになるのは、両辺が同じオブジェクトであるときだけです。

GDScriptでは_init()を非公開にできないため、スクリプトがGameSettings.new()を呼び出して2つ目のオブジェクトを取得するのを止めるものはありません。_instanceのアンダースコアとget_instance()メソッドが、その取り決めを示しています。スクリプトはオブジェクトを要求し、自分で作成することはありません。

Godotプロジェクトで、共有オブジェクトを1つ取得する一般的な方法はオートロードです。これはProject Settingsで登録するスクリプトで、Godotがゲーム開始時に1度だけ作成し、すべてのスクリプトから名前で利用できるようにします。これはGodotが管理してくれるSingletonです。オートロードはエディターで設定するため、ここでの課題ではstatic varを使ってコードでこのパターンを構築します。