跳转至

GFAsyncFlowTools

API Reference / Standard / 类索引

  • 路径：addons/gf/standard/common/gf_async_flow_tools.gd
  • 模块：Standard
  • 继承：RefCounted
  • API：public
  • 类别：运行时服务 (runtime_service)
  • 首次版本：6.0.0

小型异步流程辅助。 在现有 GFAsyncCompletion / GFAsyncWaitUtility 之上提供重试、顺序遍历和折叠。 它不引入 Promise 类型，不调度后台线程，也不规定业务任务模型；调用方只需要 提供 Callable，并接收稳定的结果字典。

成员概览

类型 名称 签名
常量 STATUS_SUCCEEDED const STATUS_SUCCEEDED: StringName = &"succeeded"
常量 STATUS_FAILED const STATUS_FAILED: StringName = &"failed"
常量 STATUS_CANCELLED const STATUS_CANCELLED: StringName = &"cancelled"
方法 retry_async static func retry_async(operation: Callable, options: Dictionary = {}) -> Dictionary:
方法 each_async static func each_async(items: Array, operation: Callable, options: Dictionary = {}) -> Dictionary:
方法 fold_async static func fold_async(items: Array, reducer: Callable, initial_value: Variant, options: Dictionary = {}) -> Dictionary:

常量

STATUS_SUCCEEDED

  • API：public
  • 首次版本：6.0.0
const STATUS_SUCCEEDED: StringName = &"succeeded"

流程成功完成。

STATUS_FAILED

  • API：public
  • 首次版本：6.0.0
const STATUS_FAILED: StringName = &"failed"

流程失败。

STATUS_CANCELLED

  • API：public
  • 首次版本：6.0.0
const STATUS_CANCELLED: StringName = &"cancelled"

流程被取消。

方法

retry_async

  • API：public
  • 首次版本：6.0.0
static func retry_async(operation: Callable, options: Dictionary = {}) -> Dictionary:

重试执行一个操作。

参数：

名称 说明
operation 要执行的操作。
options 重试选项。

返回：流程报告。

结构：

  • options: Dictionary，可包含 attempts、delay_seconds、tree、cancel_token、operation_options、pass_attempt 和 metadata。
  • return: Dictionary with ok, status, value, error, attempts, history, metadata, and optional cancel_reason.

each_async

  • API：public
  • 首次版本：6.0.0
static func each_async(items: Array, operation: Callable, options: Dictionary = {}) -> Dictionary:

顺序处理数组项。

参数：

名称 说明
items 要处理的项目列表。
operation 项目处理回调。
options 遍历选项。

返回：流程报告。

结构：

  • items: Array input items.
  • options: Dictionary，可包含 stop_on_failure、cancel_token、operation_options、pass_index 和 metadata。
  • return: Dictionary with ok, status, value, error, attempts, history, metadata, succeeded_count, and failed_count.

fold_async

  • API：public
  • 首次版本：6.0.0
static func fold_async(items: Array, reducer: Callable, initial_value: Variant, options: Dictionary = {}) -> Dictionary:

顺序折叠数组项。

参数：

名称 说明
items 要处理的项目列表。
reducer 折叠回调。
initial_value 初始累加值。
options 折叠选项。

返回：流程报告。

结构：

  • items: Array input items.
  • initial_value: Variant accumulator seed.
  • options: Dictionary，可包含 stop_on_failure、cancel_token、operation_options、pass_index 和 metadata。
  • return: Dictionary with ok, status, value, error, attempts, history, and metadata.