Wzorzec Singleton

Wzorzec Singleton gwarantuje, że klasa ma dokładnie jeden obiekt i zapewnia każdemu skryptowi jeden sposób dostępu do niego. Używaj go w przypadku elementów, które w grze występują tylko w jednym egzemplarzu: ustawień, systemu zapisu, menedżera wyników.

W GDScript static var przechowuje pojedynczy obiekt, a static func tworzy go za pierwszym razem, gdy ktoś o niego poprosi:

# 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 należy do klasy, a nie do obiektu, więc każdy skrypt widzi tę samą zmienną. Pierwsze wywołanie stwierdza, że jest pusta, i tworzy obiekt; każde kolejne wywołanie zwraca ten sam obiekt.

# 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 i b to dwie zmienne przechowujące jeden obiekt, więc zmiana dokonana za pośrednictwem a jest widoczna przez b. W przypadku obiektów == ma wartość true tylko wtedy, gdy obie strony są tym samym obiektem.

GDScript nie może uczynić funkcji _init() prywatną, więc nic nie powstrzymuje skryptu przed wywołaniem GameSettings.new() i uzyskaniem drugiego obiektu. Podkreślenie w _instance i metoda get_instance() to umowa: skrypty proszą o obiekt, nigdy go nie tworzą.

W projekcie Godot zwykle uzyskuje się jeden współdzielony obiekt za pomocą autoload: skryptu zarejestrowanego w ustawieniach projektu, który Godot tworzy raz po uruchomieniu gry i udostępnia pod nazwą w każdym skrypcie. To Singleton, którym Godot zarządza za Ciebie. Autoloady konfiguruje się w edytorze, więc w tych wyzwaniach wzorzec jest tworzony w kodzie za pomocą static var.