GFGeneratedArtifactReport¶
API Reference / Kernel / 类索引
- 路径：
addons/gf/kernel/editor/gf_generated_artifact_report.gd - 模块：
Kernel - 继承：
RefCounted - API：
public - 类别：编辑器 API (
editor_api) - 首次版本：
6.0.0
生成文本产物的保存报告辅助。 用于编辑器代码生成、导表导出或项目工具在写入前后获得统一的 new / changed / unchanged / skipped / failed 状态，不绑定具体生成器语义。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 常量 | STATUS_NEW |
const STATUS_NEW: StringName = &"new" |
| 常量 | STATUS_CHANGED |
const STATUS_CHANGED: StringName = &"changed" |
| 常量 | STATUS_UNCHANGED |
const STATUS_UNCHANGED: StringName = &"unchanged" |
| 常量 | STATUS_SKIPPED |
const STATUS_SKIPPED: StringName = &"skipped" |
| 常量 | STATUS_FAILED |
const STATUS_FAILED: StringName = &"failed" |
| 方法 | make_report |
static func make_report( output_path: String, status: StringName, error_code: Error = OK, message: String = "", options: Dictionary = {} ) -> Dictionary: |
| 方法 | save_text |
static func save_text(output_path: String, text: String, options: Dictionary = {}) -> Dictionary: |
| 方法 | get_error_code |
static func get_error_code(report: Dictionary) -> Error: |
常量¶
STATUS_NEW¶
- API：
public - 首次版本：
6.0.0
目标文件不存在，本次产物是新增内容。
STATUS_CHANGED¶
- API：
public - 首次版本：
6.0.0
目标文件存在且内容不同。
STATUS_UNCHANGED¶
- API：
public - 首次版本：
6.0.0
目标文件存在且内容相同。
STATUS_SKIPPED¶
- API：
public - 首次版本：
6.0.0
目标文件因保存策略跳过。
STATUS_FAILED¶
- API：
public - 首次版本：
6.0.0
产物写入或准备失败。
方法¶
make_report¶
- API：
public - 首次版本：
6.0.0
static func make_report( output_path: String, status: StringName, error_code: Error = OK, message: String = "", options: Dictionary = {} ) -> Dictionary:
创建统一生成产物报告。
参数：
| 名称 | 说明 |
|---|---|
output_path |
产物输出路径。 |
status |
产物状态。 |
error_code |
Godot Error 错误码。 |
message |
错误或跳过说明。 |
options |
报告选项，支持 written、changed、dry_run、size_bytes 和 metadata。 |
返回：生成产物报告。
结构：
options: Dictionary，可包含 written、changed、dry_run、size_bytes 和 metadata。return: Dictionary，包含 success、path、status、error_code、error、written、changed、dry_run、size_bytes 和 metadata。
save_text¶
- API：
public - 首次版本：
6.0.0
保存文本产物并返回统一报告。 dry_run 为 true 时只比较目标文件状态，不创建目录或写入文件。 overwrite_existing 为 false 且目标文件需要改写时返回 skipped / ERR_ALREADY_EXISTS。
参数：
| 名称 | 说明 |
|---|---|
output_path |
产物输出路径。 |
text |
要写入的文本内容。 |
options |
保存选项，支持 overwrite_existing、dry_run、scan_filesystem、label 和 metadata。 |
返回：生成产物保存报告。
结构：
options: Dictionary，可包含 overwrite_existing、dry_run、scan_filesystem、label 和 metadata。return: Dictionary，包含 success、path、status、error_code、error、written、changed、dry_run、size_bytes 和 metadata。
get_error_code¶
- API：
public - 首次版本：
6.0.0
从报告读取 Error 错误码。
参数：
| 名称 | 说明 |
|---|---|
report |
make_report() 或 save_text() 返回的报告。 |
返回：Godot Error 错误码。
结构：
report: Dictionary，包含 error_code 字段。