GFConfigPipelineCommitStage¶
API Reference / Tool Packages / 类索引
- 路径：
addons/gf/tools/config_pipeline/gf_config_pipeline_commit_stage.gd - 模块：
Tool Packages - 继承：
RefCounted - API：
public - 类别：工具 API (
tool_api) - 首次版本：
unreleased
Config Pipeline 的文件提交事务阶段。 在目标写入前捕获路径状态，并负责成功提交后的快照清理或失败后的逆序回滚。 该阶段不解释产物内容，也不决定输出路径策略。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 常量 | STAGE_ID |
const STAGE_ID: String = "gf.config.commit.filesystem" |
| 常量 | IMPLEMENTATION_VERSION |
const IMPLEMENTATION_VERSION: int = 1 |
| 方法 | begin |
func begin(paths: PackedStringArray) -> Dictionary: |
| 方法 | rollback |
func rollback(transaction: Dictionary) -> Dictionary: |
| 方法 | complete |
func complete(transaction: Dictionary) -> Dictionary: |
| 方法 | get_stage_descriptor |
func get_stage_descriptor() -> Dictionary: |
常量¶
STAGE_ID¶
- API：
public - 首次版本：
unreleased
Commit 阶段的稳定实现标识。
IMPLEMENTATION_VERSION¶
- API：
public - 首次版本：
unreleased
Commit 阶段的实现版本；改变事务或回滚语义时递增。
方法¶
begin¶
- API：
public - 首次版本：
unreleased
捕获待写入路径的事务前状态。
参数：
| 名称 | 说明 |
|---|---|
paths |
本次事务可能创建或覆盖的完整路径集合。 |
返回：提交事务。
结构：
return: Dictionary，包含 success、format、format_version、state、entries、error_kind 和 error。
rollback¶
- API：
public - 首次版本：
unreleased
逆序恢复事务前状态；已存在文件恢复快照，事务中新建文件被删除。
参数：
| 名称 | 说明 |
|---|---|
transaction |
begin() 返回且仍处于 open 状态的事务。 |
返回：回滚结果。
结构：
transaction: Dictionary，符合 gf.config_pipeline.commit_transaction@1。return: Dictionary，包含 success、phase、restored_paths、failed_paths、issues、error_kind 和 error。
complete¶
- API：
public - 首次版本：
unreleased
完成事务并删除全部回滚快照。
参数：
| 名称 | 说明 |
|---|---|
transaction |
begin() 返回且仍处于 open 状态的事务。 |
返回：提交完成结果。
结构：
transaction: Dictionary，符合 gf.config_pipeline.commit_transaction@1。return: Dictionary，包含 success、phase、restored_paths、failed_paths、issues、error_kind 和 error。
get_stage_descriptor¶
- API：
public - 首次版本：
unreleased
返回阶段实现的稳定描述，用于流水线诊断和编译指纹。
返回：阶段描述。
结构：
return: Dictionary，包含 stage_id、implementation_version、input_contract 和 output_contract。