跳转至

GFAudioAction

API Reference / Action Queue / 类索引

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

将一次 SFX 播放包装为视觉队列动作。 音效通常不应该阻塞表现队列,因此默认使用 fire-and-forget 完成模式。

成员概览

类型 名称 签名
属性 path var path: String = ""
属性 clip var clip: GFAudioClip = null
属性 bank var bank: GFAudioBank = null
属性 clip_id var clip_id: StringName = &""
方法 execute func execute() -> Variant:

属性

path

  • API:public
var path: String = ""

要播放的音频资源路径。

clip

  • API:public
var clip: GFAudioClip = null

要播放的音频片段配置。优先级高于 path。

bank

  • API:public
var bank: GFAudioBank = null

要播放的音频集合。与 clip_id 配合使用,优先级高于 clip。

clip_id

  • API:public
var clip_id: StringName = &""

音频集合中的片段标识。

方法

execute

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

执行动作并通过 GFAudioUtility 播放一次 SFX。

返回:始终返回 null,避免阻塞表现队列。

结构:

  • return: Variant,始终为 null。