跳转至

GFNodeAnimationPlayerSerializer

API Reference / Save / 类索引

  • 路径:addons/gf/extensions/save/serializers/gf_node_animation_player_serializer.gd
  • 模块:Save
  • 继承:GFNodeSerializer
  • API:public
  • 类别:资源定义 (resource_definition)
  • 首次版本:3.17.0

AnimationPlayer 通用播放状态序列化器。 保存当前动画、播放位置与速度缩放等通用播放状态,不保存动画资源内容。

成员概览

类型 名称 签名
方法 supports_node func supports_node(node: Node) -> bool:
方法 gather func gather(node: Node, _context: Dictionary = {}) -> Dictionary:
方法 apply func apply(node: Node, payload: Dictionary, _context: Dictionary = {}) -> Dictionary:

方法

supports_node

  • API:public
func supports_node(node: Node) -> bool:

判断序列化器是否支持指定节点。

参数:

名称 说明
node 目标节点。

返回:节点是否为 AnimationPlayer。

gather

  • API:public
func gather(node: Node, _context: Dictionary = {}) -> Dictionary:

采集节点的可保存状态。

参数:

名称 说明
node 目标节点。
_context 操作上下文字典,默认实现不直接使用。

返回:AnimationPlayer 播放状态载荷。

结构:

  • _context: Dictionary,调用方附加上下文;当前实现不读取。
  • return: Dictionary,可包含 current_animation、assigned_animation、current_animation_position、speed_scale、playing 与 active。

apply

  • API:public
func apply(node: Node, payload: Dictionary, _context: Dictionary = {}) -> Dictionary:

将序列化数据应用到节点。

参数:

名称 说明
node 目标节点。
payload AnimationPlayer 播放状态载荷。
_context 操作上下文字典,默认实现不直接使用。

返回:应用结果字典。

结构:

  • payload: Dictionary,可包含 current_animation、assigned_animation、current_animation_position、speed_scale、playing 与 active。
  • _context: Dictionary,调用方附加上下文;当前实现不读取。
  • return: Dictionary,包含 ok: bool 与 error: String。