Синглтони (Автозавантаження)

Вступ

Система сцен Godot, хоча потужна і гнучка, має недолік: не існує способу зберігання інформації (наприклад, рахунок гравця, або інвентар), яка потрібна більше ніж одній сцені.

Можна вирішити це деякими обхідними шляхами, але вони мають свої обмеження:

  • Ви можете використовувати "майстер-сцену", яка завантажує та вивантажує інші сцени в вигляді своїх нащадків. Однак це означає, що ви більше не можете запускати ці сцени окремо і очікувати від них правильної роботи.

  • Інформація може бути збережена на диску в user://, а потім завантажена сценами, які цього потребують, але часте збереження та завантаження даних є громіздкими і може бути повільним.

Шаблон Singleton є корисним інструментом для вирішення загального випадку, коли вам потрібно зберігати постійну інформацію між сценами. У нашому випадку можливо повторне використання однієї і тієї ж сцени, або класу, для декількох синглтонів, якщо вони мають різні назви.

Використовуючи цю концепцію, ви можете створювати об'єкти, які:

  • Завжди завантажуються, незалежно від того, яка сцена працює в даний момент.

  • Можуть зберігати глобальні змінні, наприклад інформацію про гравця.

  • Можуть працювати з переключенням сцен і переходами між сценами.

  • Діють як синглтон, оскільки архітектура GDScript не дозволяє підтримувати глобальні змінні.

Автозавантаження вузлів та скриптів може дати нам ці характеристики.

Примітка

Godot не зробить AutoLoad "справжнім" синглтоном відповідно до шаблону архітектури синглтона. За потреби користувач може інсталювати його більше одного разу.

Автозавантаження

Ви можете створити AutoLoad для завантаження сцени, чи скрипту, успадкованого від Node.

Примітка

При автозавантеженні скрипту буде створений Node і цей скрипт буде прикріплений до нього. Цей вузол буде доданий до кореневого вікна перегляду перед завантаженням будь-яких інших сцен.

../../_images/singleton.png

Для автоматичного завантаження сцени, чи скрипту, виберіть у меню Проєкт -> Параметри проєкту та перейдіть на вкладку AutoLoad ("Автозавантаження").

../../_images/autoload_tab.png

Тут ви можете додати будь-яку кількість сцен, або скриптів. Кожен запис у списку вимагає імені, яке призначається як властивість вузла name. Порядком записів під час їх додавання до дерева глобальної сцени можна керувати за допомогою клавіш зі стрілками вгору/вниз.

../../_images/autoload_example.png

Це означає, що будь-який вузол може отримати доступ до синглтону по імені "PlayerVariables" за допомогою:

var player_vars = get_node("/root/PlayerVariables")
player_vars.health -= 10
var playerVariables = (PlayerVariables)GetNode("/root/PlayerVariables");
playerVariables.Health -= 10; // Instance field.

Якщо встановлено прапорець **Enable**("Увімкнути") (за замовчуванням), то до синглтона можна отримати доступ без get_node():

PlayerVariables.health -= 10
// Static members can be accessed by using the class name.
PlayerVariables.Health -= 10;

Зауважте, що до об'єктів автозавантаження (скриптів та/або сцени) доступ такий же, як і до будь-яких інших вузлів у дереві сцен. Насправді, якщо ви подивитесь на дерево запущеної сцени, ви побачите, що автоматично з'являються і завантажені вузли:

../../_images/autoload_runtime.png

Користувацький перемикач сцени

Цей урок продемонструє побудову перемикача сцени за допомогою автоматичного завантаження. Для базового перемикача сцен можна скористатися методом SceneTree.change_scene() (детальніше дивіться Дерево сцени). Однак якщо вам потрібна більш складна поведінка при зміні сцен, цей метод забезпечує більше функціональності.

Для початку завантажте звідси шаблон: autoload.zip і відкрийте його в Godot.

Проєкт містить дві сцени: Scene1.tscn і Scene2.tscn. Кожна сцена містить мітку, яка показує назву сцени та кнопку із підключеним сигналом pressed(). Коли ви запускаєте проєкт, він запускається в Scene1.tscn. Однак натискання кнопки нічого не робить.

Global.gd

Перейдіть на вкладку Скрипт і створіть новий скрипт під назвою Global.gd. Переконайтеся, що він нащадок Node:

../../_images/autoload_script.png

Наступним кроком є додавання цього скрипту до списку автозавантаження. Відкрийте Проєкт > Параметри проєкту, перейдіть на вкладку AutoLoad**("Автозавантаження") і виберіть скрипт, натиснувши кнопку Огляд, або ввівши його шлях: ``res://Global.gd``. Натисніть **Додати, щоб додати його до списку автоматичного завантаження:

../../_images/autoload_tutorial1.png

Тепер, при запуску будь-якої сцени проєкту, цей скрипт завжди буде завантажений.

Повертаючись до скрипту, він повинен отримати поточну сцену у функції _ready (). І поточна сцена (та, яка з кнопкою), і global.gd є діти кореня, але автозавантажені вузли завжди є першими. Це означає, що останній нащадок кореня - це завжди завантажена сцена.

extends Node

var current_scene = null

func _ready():
    var root = get_tree().get_root()
    current_scene = root.get_child(root.get_child_count() - 1)
using Godot;
using System;

public class Global : Godot.Node
{
    public Node CurrentScene { get; set; }

    public override void _Ready()
    {
        Viewport root = GetTree().GetRoot();
        CurrentScene = root.GetChild(root.GetChildCount() - 1);
    }
}

Тепер нам потрібна функція для зміни сцени. Ця функція повинна звільнити поточну сцену та замінити її на запитувану.

func goto_scene(path):
    # This function will usually be called from a signal callback,
    # or some other function in the current scene.
    # Deleting the current scene at this point is
    # a bad idea, because it may still be executing code.
    # This will result in a crash or unexpected behavior.

    # The solution is to defer the load to a later time, when
    # we can be sure that no code from the current scene is running:

    call_deferred("_deferred_goto_scene", path)


func _deferred_goto_scene(path):
    # It is now safe to remove the current scene
    current_scene.free()

    # Load the new scene.
    var s = ResourceLoader.load(path)

    # Instance the new scene.
    current_scene = s.instance()

    # Add it to the active scene, as child of root.
    get_tree().get_root().add_child(current_scene)

    # Optionally, to make it compatible with the SceneTree.change_scene() API.
    get_tree().set_current_scene(current_scene)
public void GotoScene(string path)
{
    // This function will usually be called from a signal callback,
    // or some other function from the current scene.
    // Deleting the current scene at this point is
    // a bad idea, because it may still be executing code.
    // This will result in a crash or unexpected behavior.

    // The solution is to defer the load to a later time, when
    // we can be sure that no code from the current scene is running:

    CallDeferred(nameof(DeferredGotoScene), path);
}

public void DeferredGotoScene(string path)
{
    // It is now safe to remove the current scene
    CurrentScene.Free();

    // Load a new scene.
    var nextScene = (PackedScene)GD.Load(path);

    // Instance the new scene.
    CurrentScene = nextScene.Instance();

    // Add it to the active scene, as child of root.
    GetTree().GetRoot().AddChild(CurrentScene);

    // Optionally, to make it compatible with the SceneTree.change_scene() API.
    GetTree().SetCurrentScene(CurrentScene);
}

Використовуючи Object.call_deferred (), друга функція запуститься лише після завершення всього коду з поточної сцени. Таким чином, поточна сцена не буде видалена під час її використання (тобто її код все ще працює).

Нарешті, нам потрібно заповнити порожні функції зворотного виклику в обох сценах:

# Add to 'Scene1.gd'.

func _on_Button_pressed():
    Global.goto_scene("res://Scene2.tscn")
// Add to 'Scene1.cs'.

public void OnButtonPressed()
{
    var global = (Global)GetNode("/root/Global");
    global.GotoScene("res://Scene2.tscn");
}

і

# Add to 'Scene2.gd'.

func _on_Button_pressed():
    Global.goto_scene("res://Scene1.tscn")
// Add to 'Scene2.cs'.

public void OnButtonPressed()
{
    var global = (Global)GetNode("/root/Global");
    global.GotoScene("res://Scene1.tscn");
}

Запустіть проєкт і перевірте, чи можете ви перемикатися між сценами при натисканні кнопки.

Примітка

Примітка: Коли сцен мало, перехід відбувається миттєво. Однак якщо ваші сцени складніші, для їх появи може знадобитися значна кількість часу. Щоб дізнатися, як впоратися з цим, дивіться наступний урок: Background loading.

Як варіант, якщо час завантаження відносно короткий (менше 3 секунд, або близько того), ви можете відобразити "талицю завантаження", показавши якийсь 2D-елемент безпосередньо перед зміною сцени. Потім ви можете приховати її відразу після зміни сцени. Це може бути використано, щоб вказати гравцеві, що сцена завантажується.