GFInstaller¶
API Reference / Kernel / 类索引
- 路径:
addons/gf/kernel/core/gf_installer.gd - 模块:
Kernel - 继承:
RefCounted - API:
public - 类别:协议与扩展点 (
protocol) - 首次版本:
3.17.0
项目启动装配脚本基类。 继承后重写 install(),并在 Project Settings 的 gf/project/installers 中登记脚本路径, Gf.init() 与 Gf.set_architecture() 会在架构初始化前自动执行这些安装器。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 方法 | install |
func install(_architecture: GFArchitecture, _scope: GFAsyncScope) -> void: |
| 方法 | install_bindings |
func install_bindings(_binder: Variant, _scope: GFAsyncScope) -> void: |
方法¶
install¶
- API:
public - 首次版本:
8.0.0
将项目模块注册到架构。 install() 可使用 await,但首个 await 前仍运行在主线程;不要在其中执行长同步工作。 需要耗时处理时应拆分为检查点,并在每个 await 或外部回调后检查 _scope。
参数:
| 名称 | 说明 |
|---|---|
_architecture |
当前即将初始化的架构实例。 |
_scope |
当前 Installer 步骤的可取消异步作用域。 |
install_bindings¶
- API:
public - 首次版本:
8.0.0
使用声明式装配器注册项目模块。 install_bindings() 与 install() 共享同一异步契约:首个 await 前不应执行长同步工作。 需要注册外部任务清理时应使用 _scope.register_cleanup()。 "type": "Variant", "description": "当前架构创建的装配器实例,实际类型为 GFBindBuilder。" }
参数:
| 名称 | 说明 |
|---|---|
_binder |
绑定到当前架构的装配器。 |
_scope |
当前 Installer 步骤的可取消异步作用域。 |
结构:
_binder {: