跳转至

GFFlashAction

API Reference / Action Queue / 类索引

  • 路径:addons/gf/extensions/action_queue/actions/gf_flash_action.gd
  • 模块:Action Queue
  • 继承:GFVisualAction
  • API:public
  • 类别:运行时句柄 (runtime_handle)
  • 首次版本:3.17.0

通用 CanvasItem 闪色动作。 将目标节点的颜色属性短暂切到指定颜色,再恢复为原始值。 默认等待 Tween 完成后队列才会继续。

成员概览

类型 名称 签名
属性 target var target: CanvasItem
属性 flash_color var flash_color: Color = Color.WHITE
属性 duration var duration: float = 0.12
属性 property_name var property_name: NodePath = ^"modulate"
方法 execute func execute() -> Variant:
方法 cancel func cancel() -> void:
方法 get_wait_guard_node func get_wait_guard_node() -> Node:

属性

target

  • API:public
var target: CanvasItem

需要闪色的目标节点。

flash_color

  • API:public
var flash_color: Color = Color.WHITE

闪色时写入的颜色。

duration

  • API:public
var duration: float = 0.12

闪色总时长。

property_name

  • API:public
var property_name: NodePath = ^"modulate"

要缓动的颜色属性名。

方法

execute

  • API:public
func execute() -> Variant:

执行闪色 Tween。

返回:需要等待时返回内部完成 Signal;目标无效、属性无效或瞬时写入时返回 null。

结构:

  • return: Variant,返回内部完成 Signal 或 null。

cancel

  • API:public
func cancel() -> void:

取消当前 Tween 并释放等待者。

get_wait_guard_node

  • API:public
func get_wait_guard_node() -> Node:

获取用于保护等待生命周期的目标节点。

返回:有效目标节点;无效时返回 null。