GFDialogueTextCompiler¶
API Reference / Tool Packages / 类索引
- 路径：
addons/gf/tools/dialogue_text/gf_dialogue_text_compiler.gd - 模块：
Tool Packages - 继承：
RefCounted - API：
public - 类别：工具 API (
tool_api) - 首次版本：
unreleased
对话 JSON 文本编译器。 在制作期、编辑器期或 CI 中把严格、可审计的 JSON 文本编译为 GFDialogueResource。 编译器只解释对话资源已有字段，不定义角色、任务、本地化、UI 或项目状态语义。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 常量 | SOURCE_FORMAT |
const SOURCE_FORMAT: String = "gf.dialogue" |
| 常量 | SOURCE_SCHEMA_VERSION |
const SOURCE_SCHEMA_VERSION: int = 1 |
| 方法 | compile_text |
func compile_text(text: String, options: Dictionary = {}) -> Dictionary: |
| 方法 | compile_source |
func compile_source( source_key: String, loader: GFSourceTextLoader, options: Dictionary = {} ) -> Dictionary: |
常量¶
SOURCE_FORMAT¶
- API：
public - 首次版本：
unreleased
对话文本格式标识。
SOURCE_SCHEMA_VERSION¶
- API：
public - 首次版本：
unreleased
当前对话文本 schema 版本。
方法¶
compile_text¶
- API：
public - 首次版本：
unreleased
编译 JSON 文本。 未知结构字段会作为错误报告；项目扩展数据应放入 metadata 或 payload 字段。
参数：
| 名称 | 说明 |
|---|---|
text |
UTF-8 JSON 文本。 |
options |
编译选项，支持 source_path、subject 和 metadata。 |
返回：编译结果。
结构：
options: Dictionary，可包含 source_path、subject 和报告 metadata。return: Dictionary，包含 success、resource、report、source_path、content_hash 和 line_count；失败时 resource 为 null。
compile_source¶
- API：
public - 首次版本：
unreleased
func compile_source( source_key: String, loader: GFSourceTextLoader, options: Dictionary = {} ) -> Dictionary:
通过受根路径约束的源码加载器编译文本。
参数：
| 名称 | 说明 |
|---|---|
source_key |
注册文本 key 或加载器根目录内的相对路径。 |
loader |
源码文本加载器。 |
options |
编译选项；source_path 会默认使用加载结果路径。 |
返回：编译结果。
结构：
options: Dictionary，支持 compile_text() 的选项。return: Dictionary，包含 success、resource、report、source_path、content_hash 和 line_count；失败时 resource 为 null。