Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

Singletons (Autoload)¶

前言¶

Godot 的场景系统虽然强大而灵活，但有一个缺点：无法保存多个场景都需要的信息（例如玩家的分数或者背包）。

可以通过一些变通方法来解决此问题，但是它们有其自身的局限性：

你可以使用“主”场景来把其它场景当作自己的子节点来加载和卸载。然而，这就意味着这些场景无法再独立正常运行。
信息可以存储在磁盘的 user:// 下，然后由需要它的场景加载，但是经常保存和加载数据很麻烦并且可能很慢。

单例模式是解决需要在场景之间存储持久性信息的常见用例的实用工具。在我们的示例中，只要多个单例具有不同的名称，就可以复用相同的场景或类。

利用这个概念，你可以创建这样的对象：

无论当前运行哪个场景，始终加载。
可以存储全局变量，如玩家信息。
可以处理切换场景和场景间的过渡。
行为类似单例，因为 GDScript 在设计上就不支持全局变量。

自动加载的节点和脚本可以为我们提供这些特征。

备注

Godot won't make an Autoload a "true" singleton as per the singleton design pattern. It may still be instanced more than once by the user if desired.

小技巧

如果你创建的自动加载是编辑器插件的一部分，请考虑在启用插件时将其自动注册到项目设置中。

Autoload¶

You can create an Autoload to load a scene or a script that inherits from Node.

备注

自动加载脚本时，会创建一个 Node 并把脚本附加上去。加载其它任何场景前，这个节点就会被加到根视图上。

To autoload a scene or script, select Project > Project Settings from the menu and switch to the Autoload tab.

你可以在这里添加任意数量的场景或脚本。列表中的每个条目都需要一个名称，会被用来给该节点的 name 属性赋值。使用上下箭头键可以操纵将条目添加到全局场景树时的顺序。与普通场景一样，引擎读取这些节点的顺序是从上到下的。

这意味着，任何节点都可以访问并使用一个名为“PlayerVariables”的单例：

var player_vars = get_node("/root/PlayerVariables")
player_vars.health -= 10

var playerVariables = GetNode<PlayerVariables>("/root/PlayerVariables");
playerVariables.Health -= 10; // Instance field.

If the Enable column is checked (which is the default), then the singleton can be accessed directly in GDScript, without requiring get_node():

PlayerVariables.health -= 10

请注意，访问自动加载对象（脚本、场景）的方式和访问场景树中的任何其他节点是一样的。实际上，如果你查看正在运行的场景树，就会看到自动加载的节点出现：

警告

运行时绝对不能通过 free() 或 queue_free() 去移除自动加载，否则引擎会崩溃。

自定义场景切换器¶

This tutorial will demonstrate building a scene switcher using autoloads. For basic scene switching, you can use the SceneTree.change_scene_to_file() method (see 使用 SceneTree for details). However, if you need more complex behavior when changing scenes, this method provides more functionality.

To begin, download the template from here: singleton_autoload_starter.zip and open it in Godot.

The project contains two scenes: scene_1.tscn and scene_2.tscn. Each scene contains a label displaying the scene name and a button with its pressed() signal connected. When you run the project, it starts in scene_1.tscn. However, pressing the button does nothing.

Creating the script¶

Open the Script window and create a new script called global.gd. Make sure it inherits from Node:

The next step is to add this script to the autoLoad list. Open Project > Project Settings from the menu, switch to the Autoload tab and select the script by clicking the browse button or typing its path: res://global.gd. Press Add to add it to the autoload list:

现在，无论何时在项目中运行任何场景，该脚本都将始终加载。

Returning to the script, it needs to fetch the current scene in the _ready() function. Both the current scene (the one with the button) and global.gd are children of root, but autoloaded nodes are always first. This means that the last child of root is always the loaded scene.

extends Node

var current_scene = null

func _ready():
    var root = get_tree().root
    current_scene = root.get_child(root.get_child_count() - 1)

using Godot;

public partial class Global : Node
{
    public Node CurrentScene { get; set; }

    public override void _Ready()
    {
        Viewport root = GetTree().Root;
        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.instantiate()

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

    # Optionally, to make it compatible with the SceneTree.change_scene_to_file() API.
    get_tree().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(MethodName.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.Instantiate();

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

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

使用 Object.call_deferred()，第二个函数将仅在当前场景中的所有代码完成后运行。因此，当前场景在仍在使用（即其代码仍在运行）时不会被删除。

最后，我们需要在两个场景中填充空的回调函数：

# Add to 'Scene1.gd'.

func _on_button_pressed():
    Global.goto_scene("res://scene_2.tscn")

// Add to 'Scene1.cs'.

private void OnButtonPressed()
{
    var global = GetNode<Global>("/root/Global");
    global.GotoScene("res://scene_2.tscn");
}

以及

# Add to 'Scene2.gd'.

func _on_button_pressed():
    Global.goto_scene("res://scene_1.tscn")

// Add to 'Scene2.cs'.

private void OnButtonPressed()
{
    var global = GetNode<Global>("/root/Global");
    global.GotoScene("res://scene_1.tscn");
}

运行该项目，并测试您可以通过按下按钮来切换场景。

备注

当场景较小时，过渡是瞬时的。但是，如果你的场景比较复杂，则可能需要花费相当长的时间才能显示出来。要了解如何处理此问题，请参阅下一个教程：后台加载。

另外，如果加载时间相对较短（少于 3 秒左右），你可以在改变场景之前，通过显示某种 2D 元素来显示一个“加载中图标”，然后在改变场景后隐藏它。这能让玩家知道场景正在载入。