GFWaitAction¶
API Reference / Action Queue / 类索引
- 路径：
addons/gf/extensions/action_queue/actions/gf_wait_action.gd - 模块：
Action Queue - 继承：
GFVisualAction - API：
public - 类别：运行时句柄 (
runtime_handle) - 首次版本：
3.17.0
动作队列中的通用等待动作。 通过 SceneTreeTimer 表达一段时间等待，不携带业务含义。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 信号 | wait_completed |
signal wait_completed |
| 属性 | seconds |
var seconds: float = 0.0 |
| 属性 | host_node |
var host_node: Node |
| 属性 | process_always |
var process_always: bool = true |
| 属性 | process_in_physics |
var process_in_physics: bool = false |
| 属性 | ignore_time_scale |
var ignore_time_scale: bool = false |
| 方法 | execute |
func execute() -> Variant: |
| 方法 | cancel |
func cancel() -> void: |
| 方法 | finish |
func finish() -> void: |
信号¶
wait_completed¶
- API：
public
等待完成时发出。取消后的旧计时器不会触发该信号。
属性¶
seconds¶
- API：
public
等待秒数。
host_node¶
- API：
public
可选宿主节点。存在时优先从该节点获取 SceneTree。
process_always¶
- API：
public
计时器是否在暂停时继续处理。
process_in_physics¶
- API：
public
是否按物理帧处理。
ignore_time_scale¶
- API：
public
是否忽略 Engine.time_scale。
方法¶
execute¶
- API：
public
启动等待计时器。
返回：需要等待时返回 wait_completed Signal；无需等待或无法获取 SceneTree 时返回 null。
结构：
return: Variant，返回 wait_completed Signal 或 null。
cancel¶
- API：
public
取消当前等待。
finish¶
- API：
public
立即完成当前等待并发出 wait_completed。