类的注册

类是 Godot 数据建模的核心。如果你想以类型安全的方式构建复杂的用户定义类型，就无法避免使用类。数组、字典和简单类型只能满足基本需求，过度使用它们会使得使用静态类型语言的意义大打折扣。

Rust 使得类注册变得简单。如前所述，Rust 语法作为基础，并加入了特定于 gdext 的扩展。

另请参见 GDScript 类参考。

目录

• 定义一个 Rust 结构体
• 选择基类
• 基类字段
• 结论

定义一个 Rust 结构体

在 Rust 中，Godot 类由结构体表示。结构体的定义方式与平常一样，可以包含任意数量的字段。为了将它们注册到 Godot 中，你需要派生 GodotClass trait。

让我们定义一个简单的类，命名为 Monster：

#![allow(unused)]
fn main() {
#[derive(GodotClass)]
#[class(init)] // 稍后会详细说明这个
struct Monster {
    name: String,
    hitpoints: i32,
}
}

就这样。在编译后，这个类通过热重载（在 Godot 4.2 之前是重启后）会立即在 Godot 中可用。虽然它还不太有用，但上述定义足以将 Monster 类注册到引擎中。

选择基类

默认情况下，Rust 类的基类是 RefCounted。这和 GDScript 在省略 extends 关键字时的行为一致。

RefCounted 对于数据包非常有用。顾名思义，它允许通过引用计数器来共享实例，因此你不需要担心内存管理。Resource 是 RefCounted 的子类，适用于需要序列化到文件系统的数据。

然而，如果你希望你的类成为场景树的一部分，则需要使用 Node（或其派生类）作为基类。

这里，我们使用一个更具体的节点类型 Node3D。这可以通过在结构体定义上指定 #[class(base=Node3D)] 来实现：

#![allow(unused)]
fn main() {
#[derive(GodotClass)]
#[class(base=Node3D)]
struct Monster {
    name: String,
    hitpoints: i32,
}
}

基类字段

由于 Rust 没有继承机制，我们需要使用组合来实现相同的效果。gdext 提供了一个 Base<T>类型，它允许我们将 Godot 超类（基类）的实例作为字段存储在我们的 Monster 类中。

#![allow(unused)]
fn main() {
#[derive(GodotClass)]
#[class(base=Node3D)]
struct Monster {
    name: String,
    hitpoints: i32,
    base: Base<Node3D>,
}
}

关键部分是 Base<T> 类型。T 必须与你在 #[class(base=...)] 属性中指定的基类相匹配。你也可以使用关联类型 Self::Base 来代替 T。

当你在结构体中声明基类字段时，#[derive] 过程宏会自动检测到 Base<T> 类型。¹ 这使得你可以通过提供的方法 self.base() 和 self.base_mut() 访问 Node API，稍后我们会详细介绍。

结论

你已经学会了如何定义一个 Rust 类并将其注册到 Godot 中。你现在知道了不同的基类存在，并且了解如何选择一个基类。

接下来的章节将介绍函数和构造函数。