场景组织

本文讨论与场景内容的有效组织相关的主题。应该使用哪些节点？应该把它们放在哪里？它们应该如何互动？

如何有效地建立关系

当Godot用户开始制作自己的场景时, 他们经常遇到以下问题:

他们创建了自己的第一个场景, 并将其内容填满, 但最终却将自己场景的分支保存为独立的场景, 因为他们应该拆分东西的纠结感开始累积. 然而, 他们会发现, 之前能够依赖的强引用已经不能用了. 在多个地方重新使用场景会产生问题, 因为节点路径找不到目标, 在编辑器中建立的信号连接也会中断.

要解决这些问题, 必须实例化子场景, 而子场景不需要有关其环境的详细信息. 人们必须能够相信子场景会自己创建自己, 而无需挑剔人们如何使用它.

在OOP中需要考虑的最大的事情之一是维护重点的, 单一目的的类, 并与代码库的其他部分进行 松散的耦合 . 这样可以使对象的大小保持在较小的范围内(便于维护), 并提高它们的可重用性.

这些OOP对场景结构和脚本使用的最佳实践有 多个 的意义.

如果可能的话, 应该设计没有依赖性的场景. 也就是说, 人们应该创建场景, 而场景将所需的一切保留在其内部.

如果一个场景必须与外部环境交互, 经验丰富的开发人员建议使用 依赖注入. 该技术涉及使高级API提供低级API的依赖关系. 为什么是这样？因为依赖于其外部环境的类, 可能会无意中触发, 错误和意外行为.

要做到这一点, 必须公开数据, 然后依赖父级上下文来初始化它:

  1. 连接到一个信号。极其安全，但只能用于“响应”行为，而不是启动它。请注意，信号名称通常是过去式动词，如“entered”“skill_activated”“item_collected”（已进入、已激活技能、已收集道具）。

    GDScriptC#

    1. # Parent
    2. $Child.connect("signal_name", object_with_method, "method_on_the_object")
    4. # Child
    5. emit_signal("signal_name") # Triggers parent-defined behavior.
    1. // Parent
    2. GetNode("Child").Connect("SignalName", ObjectWithMethod, "MethodOnTheObject");
    4. // Child
    5. EmitSignal("SignalName"); // Triggers parent-defined behavior.

  2. 调用方法。用于启动行为。

    GDScriptC#

    1. # Parent
    2. $Child.method_name = "do"
    4. # Child, assuming it has String property 'method_name' and method 'do'.
    5. call(method_name) # Call parent-defined method (which child must own).
    1. // Parent
    2. GetNode("Child").Set("MethodName", "Do");
    4. // Child
    5. Call(MethodName); // Call parent-defined method (which child must own).

  3. 初始化 FuncRef 属性。比方法更安全，因为方法无须考虑所有权。用于启动行为。

    GDScriptC#

    1. # Parent
    2. $Child.func_property = funcref(object_with_method, "method_on_the_object")
    4. # Child
    5. func_property.call_func() # Call parent-defined method (can come from anywhere).
    1. // Parent
    2. GetNode("Child").Set("FuncProperty", GD.FuncRef(ObjectWithMethod, "MethodOnTheObject"));
    4. // Child
    5. FuncProperty.CallFunc(); // Call parent-defined method (can come from anywhere).

  4. 初始化 Node 或其他 Object 的引用。

    GDScriptC#

    1. # Parent
    2. $Child.target = self
    4. # Child
    5. print(target) # Use parent-defined node.
    1. // Parent
    2. GetNode("Child").Set("Target", this);
    4. // Child
    5. GD.Print(Target); // Use parent-defined node.

  5. 初始化 NodePath。

    GDScriptC#

    1. # Parent
    2. $Child.target_path = ".."
    4. # Child
    5. get_node(target_path) # Use parent-defined NodePath.
    1. // Parent
    2. GetNode("Child").Set("TargetPath", NodePath(".."));
    4. // Child
    5. GetNode(TargetPath); // Use parent-defined NodePath.

这些选项隐藏了子节点的访问点. 这反过来又使子节点与环境保持 松耦合 . 人们可以在另外一个上下文中重新使用它, 而不需要对API做任何额外的改变.

备注

虽然上面的例子说明了父子关系, 但是同样的原则也适用于所有对象之间的关系. 兄弟节点应该只知道它们的层次结构, 而先祖节点则负责协调它们的通信和引用.

GDScriptC#

  1. # Parent
  2. $Left.target = $Right.get_node("Receiver")
  4. # Left
  5. var target: Node
  6. func execute():
  7.     # Do something with 'target'.
  9. # Right
  10. func _init():
  11.     var receiver = Receiver.new()
  12.     add_child(receiver)
  1. // Parent
  2. GetNode<Left>("Left").Target = GetNode("Right/Receiver");
  4. public class Left : Node
  5. {
  6.     public Node Target = null;
  8.     public void Execute()
  9.     {
  10.         // Do something with 'Target'.
  11.     }
  12. }
  14. public class Right : Node
  15. {
  16.     public Node Receiver = null;
  18.     public Right()
  19.     {
  20.         Receiver = ResourceLoader.Load<Script>("Receiver.cs").New();
  21.         AddChild(Receiver);
  22.     }
  23. }

同样的原则也适用于, 维护对其他对象依赖关系的非节点对象. 无论哪个对象实际拥有这些对象, 都应该管理它们之间的关系.

警告

人们应该倾向于将数据保存在内部(场景内部), 尽管它对外部上下文有一个依赖, 即使是一个松散耦合的依赖, 仍然意味着节点, 将期望其环境中的某些内容为真. 项目的设计理念应防止这种情况的发生. 如果不是这样, 代码的继承的责任将迫使开发人员使用文档, 以在微观尺度上跟踪对象关系；这就是所谓的开发地狱. 默认情况下, 编写依赖于外部文档的代码, 让人们安全地使用它, 是很容易出错的.

为了避免创建和维护此类文档, 可以将依赖节点(上面的子级)转换为工具脚本, 该脚本实现 _get_configuration_warning(). 从中返回一个非空字符串, 将使场景停靠面板生成警告图标, 该字符串作为节点的工具提示. 当它没有定义 CollisionShape2D 子节点时, 是相同图标, 即显示为节点如 Area2D 节点的图标. 然后, 编辑器通过脚本代码自行记录场景. 通过文档, 没有内容复制是必要的.

这样的GUI可以更好地通知项目用户有关节点的关键信息. 它具有外部依赖性吗？这些依赖性是否得到满足？其他程序员, 尤其是设计师和作家, 将需要消息中的明确指示, 告诉他们如何进行配置.

那么, 为什么这些复杂的开关都起作用呢？嗯, 因为场景在单独工作时运行得最好. 如果不能单独工作, 那么与别人匿名运行(最小化强依赖, 即松散耦合)是下下之策. 不可避免地, 可能需要对一个类进行更改, 如果这些更改导致它以不可预见的方式与其他场景交互, 那么事情就会开始崩溃. 所有这些间接性的目的就是为了避免最终出现改变一个类导致对其他类产生不利影响的情况.

脚本和场景作为引擎类的扩展, 应该遵守 所有 的OOP原则. 例如…

选择节点树结构

从前有个开发者开始开发游戏，却因为海量的可能性而犹豫不前。他可能知道自己想做什么、想要什么样的系统，但是应该把这些东西落实在 哪里 呢？好吧，自己做的游戏当然自己说了算。虽然节点树的构造方法有无数种，但对于没把握的人而言，这份指南可以展示一个比较像样的结构作为基础。

一个游戏总是应该有一种“入口点”；这是开发者可以明确地追踪到运行的开始位置，以便他们可以在其他地方继续运行逻辑。这个地方也可以作为程序中所有其他数据和逻辑的总览图。对于传统的应用程序，这将是“main”函数。在这种情况下，它将是一个 Main 节点。

  • “Main”节点（main.gd）

main.gd 脚本将作为游戏的主要控制器。

然后你便拥有了真正的游戏“世界”（二维或三维）。这可以是 Main 的子节点。另外，他们的游戏将需要一个主要的 GUI，来管理项目所需的各种菜单和小部件。

  • “Main”节点（main.gd）

    • Node2D/Spatial“世界”（game_world.gd）

    • Control“GUI”（gui.gd）

当变更关卡时，可以稍后换出“World”节点的子级。手动更换场景让用户完全控制他们的游戏世界如何过渡。

下一步是考虑项目需要什么样的游戏系统。如果有这么一个系统……

  1. 跟踪所有的内部数据

  2. 应该是全局可访问的

  3. 应该是独立存在的

…那么应该创建一个 自动加载单例节点 节点.

备注

对于较小的游戏, 一个更简单, 具有更少控制的选择, 是拥有一个游戏单例, 简单地调用 SceneTree.change_scene() 方法以交换出主场景的内容. 这种结构或多或少保留“World”作为主要游戏节点.

任何GUI也需要是一个单例；是 “世界” 的一个过渡部分；或者是作为根节点的直接子节点手动添加. 否则,GUI节点也会在场景转换时自行删除.

如果一个系统需要修改另一个系统的数据，那么就应该把它们分别定义成单独的脚本或者场景，不应该使用自动加载。其原因请参考文档自动加载与普通节点。

游戏中的每个子系统在 SceneTree 中应有其自己的部分. 仅在节点是其父级的有效元素的情况下, 才应使用父子关系. 合理地移除父级是否意味着也应删除子级？如果没有, 那么它应在层次结构中有自己的位置, 作为同级关系或其他关系.

备注

在某些情况下，我们会需要让这些分离的节点仍然相对彼此进行定位。为此，可以使用 RemoteTransform / RemoteTransform2D 节点。它们将允许目标节点有条件地从 Remote* 节点继承选定的变换元素。要分配 target 的 NodePath，请使用以下方法之一：

  1. 一个可靠的第三方, 可能是一个父节点, 来协调分配任务.

  2. 一个编组, 轻松提取对所需节点的引用(假设只有一个目标).

什么时候应该这样做呢？哎，这是比较主观了。当一个节点必须在 SceneTree 上移动以保护自己时，就会出现两难的局面。例如……

  • 将“玩家”节点到“房间”。

  • 要改变房间，那么就必须删除当前房间。

  • 在删除这个房间之前，必须保留并且/或者移动玩家。

    需要关心内存吗？

    • 如果不关心，那么就可以创建两个房间，移动玩家，然后删掉旧房间。没有问题。

    如果关心，那么就需要……

    • 将玩家移动到树的其他地方。

    • 删除房间。

    • 实例化并添加房间。

    • 重新添加玩家。

问题是, 这里的角色是一个 “特殊情况” ；开发者必须 知道 需要以这种方式处理项目中的角色. 因此, 作为一个团队可靠地分享这些信息的唯一方法就是 文档化 . 而将实现细节保留在文档中是很危险的, 它是一种维护负担, 使代码可读性下降, 不必要地膨胀项目的知识内容.

在拥有更多的素材的, 更复杂的游戏, 简单地将玩家完全保留在 SceneTree 中的其他地方会更好. 这样的好处是:

  1. 更多的一致性.

  2. 没有必须被记录和维护在某地的 特殊情况.

  3. 因为没有考虑这些细节, 所以没有机会发生错误.

相比之下, 如果需要一个子节点 不 继承父节点的转换, 那么具有以下选项:

  1. 声明性 解决方案: 在它们之间放置一个 Node . 作为没有转换的节点, 节点不会将这些信息传递给其子节点.

  2. 命令性 解决方案: 对 CanvasItem 或者 Spatial 节点, 使用 set_as_toplevel 设值函数. 这将使节点忽略其继承的转换.

备注

如果构建的是网络游戏，请记住哪些节点和游戏系统与所有玩家相关，而哪些只与权威服务器相关。例如，用户并不需要所有人都拥有每个玩家的“PlayerController”逻辑的副本。相反，他们只需要自己的。这样，将它们保持在从“世界”分离的独立的分支中，可以帮助简化游戏连接等的管理。

场景组织的关键是用关系树而不是空间树来考虑 SceneTree。节点是否依赖于其父节点的存在？如果不是，那么它们可以自己在别的地方茁壮成长。如果它们是依赖性的，那么理所当然它们应该是父节点的子节点（如果它们还不是父节点场景的一部分，那么很可能是父节点场景的一部分）。

这是否意味着节点本身就是组件？并不是这样.Godot的节点树形成的是聚合关系, 而不是组合关系. 虽然我们依旧可以灵活地移动节点, 但在默认情况下, 无需移动, 仍然是最好的选择.