GFEditorCommand¶
API Reference / Kernel / 类索引
- 路径：
addons/gf/kernel/editor/gf_editor_command.gd - 模块：
Kernel - 继承：
RefCounted - API：
public - 类别：编辑器 API (
editor_api) - 首次版本：
3.17.0
可撤销编辑器操作的通用基类。 用于把编辑器 UI、快捷键或交互工具产生的修改收敛成可执行、可撤销的命令。 命令只描述操作协议，不绑定具体资源、节点类型或业务含义。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | command_name |
var command_name: String: |
| 属性 | metadata |
var metadata: Dictionary: |
| 方法 | execute |
func execute() -> Error: |
| 方法 | revert |
func revert() -> Error: |
| 方法 | add_to_undo_manager |
func add_to_undo_manager(undo_manager: Object, execute_immediately: bool = true) -> Error: |
| 方法 | get_last_execute_error |
func get_last_execute_error() -> Error: |
| 方法 | get_last_revert_error |
func get_last_revert_error() -> Error: |
| 方法 | is_executed |
func is_executed() -> bool: |
| 方法 | is_sealed |
func is_sealed() -> bool: |
| 方法 | can_execute |
func can_execute() -> bool: |
| 方法 | can_revert_before_execute |
func can_revert_before_execute() -> bool: |
| 方法 | get_debug_snapshot |
func get_debug_snapshot() -> Dictionary: |
| 方法 | _do_it |
func _do_it() -> Error: |
| 方法 | _undo_it |
func _undo_it() -> Error: |
| 方法 | _can_change_configuration |
func _can_change_configuration(field_name: String) -> bool: |
属性¶
command_name¶
- API：
public - 首次版本：
3.17.0
命令显示名称，会作为 UndoRedo action 名称使用。
metadata¶
- API：
public - 首次版本：
3.17.0
调用方可附加的上下文数据。
结构：
metadata: Dictionary for caller-defined command metadata.
方法¶
execute¶
- API：
public
执行命令。
返回：Godot 错误码。
revert¶
- API：
public
撤销命令。
返回：Godot 错误码。
add_to_undo_manager¶
- API：
public - 首次版本：
3.17.0
将命令写入 Godot 编辑器 UndoRedo 管理器。 返回值只表示 action 已成功写入并提交给 UndoRedo 管理器；Godot 原生 EditorUndoRedoManager 不会把 do/undo 回调的错误码回传给提交方。需要诊断 回调执行结果时，读取命令自身的最近执行/撤销错误或调试快照。
参数：
| 名称 | 说明 |
|---|---|
undo_manager |
EditorUndoRedoManager 或兼容对象。 |
execute_immediately |
提交 action 时是否立即执行 do 方法。 |
返回：Godot 错误码。
get_last_execute_error¶
- API：
public - 首次版本：
7.0.0
获取最近一次 execute() 的错误码。
返回：最近 execute() 返回的 Godot 错误码。
get_last_revert_error¶
- API：
public - 首次版本：
7.0.0
获取最近一次 revert() 的错误码。
返回：最近 revert() 返回的 Godot 错误码。
is_executed¶
- API：
public
当前命令是否已执行。
返回：已执行时返回 true。
is_sealed¶
- API：
public - 首次版本：
8.0.0
返回命令配置是否已经冻结。 已执行或写入 UndoRedo 的命令实例代表一次编辑动作，冻结后不应再修改配置字段。
返回：配置已冻结时返回 true。
can_execute¶
- API：
public
命令当前是否允许执行。
返回：允许执行时返回 true。
can_revert_before_execute¶
- API：
public
未执行时是否仍允许调用 revert()。
返回：未执行时允许撤销返回 true。
get_debug_snapshot¶
- API：
public
获取调试快照。
返回：调试信息字典。
结构：
return: Dictionary containing command_name, executed, and metadata.
_do_it¶
- API：
protected
执行具体编辑器操作，供子类重写。
返回：Godot 错误码。
_undo_it¶
- API：
protected
撤销具体编辑器操作，供子类重写。
返回：Godot 错误码。
_can_change_configuration¶
- API：
protected - 首次版本：
8.0.0
返回指定配置字段当前是否可修改。
参数：
| 名称 | 说明 |
|---|---|
field_name |
配置字段名。 |
返回：配置未冻结时返回 true；已冻结时报告错误并返回 false。