GFFlowNode¶
API Reference / Flow / 类索引
- 路径：
addons/gf/extensions/flow/resources/gf_flow_node.gd - 模块：
Flow - 继承：
Resource - API：
public - 类别：资源定义 (
resource_definition) - 首次版本：
3.17.0
通用流程图节点基类。 节点只描述执行入口和默认后继节点。具体条件、命令、等待逻辑由项目继承实现。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | node_id |
var node_id: StringName = &"" |
| 属性 | display_name |
var display_name: String = "" |
| 属性 | category |
var category: StringName = &"" |
| 属性 | next_node_ids |
var next_node_ids: PackedStringArray = PackedStringArray() |
| 属性 | wait_for_result |
var wait_for_result: bool = true |
| 属性 | input_ports |
var input_ports: Array[GFFlowPort] = [] |
| 属性 | output_ports |
var output_ports: Array[GFFlowPort] = [] |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 属性 | editor_position |
var editor_position: Vector2 = Vector2.ZERO |
| 属性 | editor_size |
var editor_size: Vector2 = Vector2.ZERO |
| 属性 | editor_collapsed |
var editor_collapsed: bool = false |
| 属性 | runtime_state |
var runtime_state: Dictionary = {} |
| 方法 | execute |
func execute(_context: GFFlowContext) -> Variant: |
| 方法 | get_next_nodes |
func get_next_nodes(context: GFFlowContext) -> PackedStringArray: |
| 方法 | get_display_name |
func get_display_name() -> String: |
| 方法 | get_input_ports |
func get_input_ports() -> Array[GFFlowPort]: |
| 方法 | get_output_ports |
func get_output_ports() -> Array[GFFlowPort]: |
| 方法 | get_input_port |
func get_input_port(port_id: StringName) -> GFFlowPort: |
| 方法 | get_output_port |
func get_output_port(port_id: StringName) -> GFFlowPort: |
| 方法 | describe_ports |
func describe_ports() -> Dictionary: |
| 方法 | describe_editor |
func describe_editor() -> Dictionary: |
| 方法 | describe_node |
func describe_node() -> Dictionary: |
| 方法 | set_runtime_value |
func set_runtime_value(key: StringName, value: Variant) -> void: |
| 方法 | get_runtime_value |
func get_runtime_value(key: StringName, default_value: Variant = null) -> Variant: |
| 方法 | clear_runtime_state |
func clear_runtime_state() -> void: |
| 方法 | serialize_runtime_state |
func serialize_runtime_state() -> Dictionary: |
| 方法 | deserialize_runtime_state |
func deserialize_runtime_state(data: Dictionary) -> void: |
属性¶
node_id¶
- API：
public
节点稳定标识。
display_name¶
- API：
public
节点显示名；为空时回退到 node_id。
category¶
- API：
public
节点分类，仅供编辑器、搜索或项目工具使用。
next_node_ids¶
- API：
public
默认后继节点列表。
wait_for_result¶
- API：
public
返回 Signal 时是否等待。
input_ports¶
- API：
public
输入端口描述。仅用于编辑器、校验和项目层数据连接。
output_ports¶
- API：
public
输出端口描述。仅用于编辑器、校验和项目层数据连接。
metadata¶
- API：
public
项目自定义元数据。框架不解释该字段。
结构：
metadata: 项目自定义元数据 Dictionary；框架保留并复制该字段，但不解释其中键值。
editor_position¶
- API：
public
编辑器中的节点位置。
editor_size¶
- API：
public
编辑器中的节点尺寸；为 ZERO 时表示由编辑器自行决定。
editor_collapsed¶
- API：
public
编辑器中是否折叠显示。
runtime_state¶
- API：
public
节点运行态数据。默认不导出，项目可通过序列化接口自行存档或迁移。
结构：
runtime_state: 项目自定义运行态 Dictionary；键和值由节点实现维护。
方法¶
execute¶
- API：
public
执行节点。
参数：
| 名称 | 说明 |
|---|---|
_context |
流程上下文。 |
返回：可返回 null 或 Signal。
结构：
return: null、Signal 或项目节点实现约定的结果值。
get_next_nodes¶
- API：
public
获取执行完成后的后继节点。
参数：
| 名称 | 说明 |
|---|---|
context |
流程上下文。 |
返回：后继节点标识列表。
get_display_name¶
- API：
public
获取节点显示名。
返回：显示名。
get_input_ports¶
- API：
public
获取输入端口。
返回：输入端口数组。
get_output_ports¶
- API：
public
获取输出端口。
返回：输出端口数组。
get_input_port¶
- API：
public
按端口标识查找输入端口。
参数：
| 名称 | 说明 |
|---|---|
port_id |
端口标识。 |
返回：输入端口；不存在时返回 null。
get_output_port¶
- API：
public
按端口标识查找输出端口。
参数：
| 名称 | 说明 |
|---|---|
port_id |
端口标识。 |
返回：输出端口；不存在时返回 null。
describe_ports¶
- API：
public
描述节点端口。
返回：端口描述字典。
结构：
return: 包含 inputs 和 outputs 字段的 Dictionary；每个字段为端口描述数组。
describe_editor¶
- API：
public
描述节点编辑器元数据。
返回：编辑器元数据字典。
结构：
return: 包含 display_name、category、position、size 和 collapsed 字段的 Dictionary。
describe_node¶
- API：
public
描述节点。
返回：节点描述字典。
结构：
return: 包含 node_id、display_name、category、next_node_ids、wait_for_result、ports、editor 和 metadata 字段的 Dictionary。
set_runtime_value¶
- API：
public
写入节点运行态值。
参数：
| 名称 | 说明 |
|---|---|
key |
键。 |
value |
值。 |
结构：
value: 任意可写入 runtime_state 的项目值。
get_runtime_value¶
- API：
public
读取节点运行态值。
参数：
| 名称 | 说明 |
|---|---|
key |
键。 |
default_value |
默认值。 |
返回：运行态值或默认值。
结构：
default_value: 缺失时返回的任意项目值。return: 找到的运行态值，或传入的 default_value。
clear_runtime_state¶
- API：
public
清空节点运行态数据。
serialize_runtime_state¶
- API：
public
序列化节点运行态数据。
返回：运行态数据副本。
结构：
return: runtime_state 的深拷贝 Dictionary。
deserialize_runtime_state¶
- API：
public
反序列化节点运行态数据。
参数：
| 名称 | 说明 |
|---|---|
data |
运行态数据。 |
结构：
data: serialize_runtime_state() 返回的运行态 Dictionary。