Script Graph

使用指南

Cocos 组件 / 动画 / SkeletalAnimation节点

Cocos 组件 / 动画 / SkeletalAnimation 节点手册,包含 13 个节点的用途、引脚、使用场景和注意事项。

16

学习目标

访问 Cocos Creator 组件的属性、方法和事件,把引擎能力转成可视化工作流。

覆盖范围

  • 节点数量:13
  • 分类路径:Cocos 组件 / 动画 / SkeletalAnimation

典型使用场景

  • 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
  • 读取组件状态后驱动游戏逻辑
  • 批量设置组件属性完成游戏运行时效果

通用注意事项

  • 目标组件引脚必须连接正确的组件实例。
  • 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。
  • 部分组件能力受 Cocos Creator 版本限制,页面会标出版本字段。

节点索引

节点节点 ID输入/输出执行方式
按路径查询挂点skeletalAnimationGetSocketTargetByPath2 / 2立即继续
创建挂点skeletalAnimationCreateSocket3 / 3立即继续
恢复骨骼动画skeletalAnimationResume2 / 2立即继续
获取挂点列表skeletalAnimationGetSockets1 / 1立即继续
获取挂点路径skeletalAnimationGetSocketPaths1 / 1立即继续
获取挂点数量skeletalAnimationGetSocketCount1 / 1立即继续
获取全部属性skeletalAnimationGetProperties1 / 1立即继续
获取预烘焙模式skeletalAnimationGetUseBakedAnimation1 / 1立即继续
设置挂点列表skeletalAnimationSetSockets3 / 2立即继续
设置预烘焙模式skeletalAnimationSetUseBakedAnimation3 / 2立即继续
停止骨骼动画skeletalAnimationStop2 / 2立即继续
暂停骨骼动画skeletalAnimationPause2 / 2立即继续
重建挂点动画skeletalAnimationRebuildSocketAnimations2 / 2立即继续

按路径查询挂点

按路径查询挂点:根据骨骼路径查找对应的挂点目标节点。用于获取指定骨骼上挂载的子节点。 路径格式示例:Armature/Hips/RightHand。

节点信息

字段
节点 IDskeletalAnimationGetSocketTargetByPath
分类Cocos 组件
二级分类动画
分组SkeletalAnimation
是否需要等待结果
是否需要先选择目标

输入引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation目标 SkeletalAnimation 组件-必填
path骨骼路径数据string要查找的骨骼路径输入框
默认值:""
必填

输出引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
target目标节点数据cc.Node挂点同步输出节点,未找到时为 null-可选
exists存在数据boolean指定路径的挂点是否存在-可选

使用场景

  • 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
  • 读取组件状态后驱动游戏逻辑
  • 批量设置组件属性完成游戏运行时效果

注意事项

  • 适合的工作流类型:component、library、method、function、class。
  • 目标组件引脚必须连接正确的组件实例。
  • 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。

创建挂点

创建挂点:在指定的骨骼路径上创建挂点,用于在该骨骼上挂载子节点(如武器、帽子等装备)。 若该路径已有挂点,则直接返回对应的目标节点。路径格式示例:Armature/Hips/RightHand。

节点信息

字段
节点 IDskeletalAnimationCreateSocket
分类Cocos 组件
二级分类动画
分组SkeletalAnimation
是否需要等待结果
是否需要先选择目标

输入引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
exe执行执行流执行流执行触发-必填
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation目标 SkeletalAnimation 组件-必填
path骨骼路径数据string目标骨骼路径,相对于动画根节点的层级路径输入框
默认值:""
必填

输出引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
out完成执行流执行流执行完成-可选
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation透传 SkeletalAnimation 组件-可选
target目标节点数据cc.Node挂点同步输出节点,会跟随骨骼变换-可选

使用场景

  • 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
  • 读取组件状态后驱动游戏逻辑
  • 批量设置组件属性完成游戏运行时效果

注意事项

  • 适合的工作流类型:component、library、method、function、class。
  • 目标组件引脚必须连接正确的组件实例。
  • 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。

恢复骨骼动画

恢复骨骼动画:恢复已暂停的骨骼动画,从暂停时的位置继续播放。配合 暂停 节点使用。

节点信息

字段
节点 IDskeletalAnimationResume
分类Cocos 组件
二级分类动画
分组SkeletalAnimation
是否需要等待结果
是否需要先选择目标

输入引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
exe执行执行流执行流执行触发-必填
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation目标 SkeletalAnimation 组件-必填

输出引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
out完成执行流执行流执行完成-可选
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation透传 SkeletalAnimation 组件-可选

使用场景

  • 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
  • 读取组件状态后驱动游戏逻辑
  • 批量设置组件属性完成游戏运行时效果

注意事项

  • 适合的工作流类型:component、library、method、function、class。
  • 目标组件引脚必须连接正确的组件实例。
  • 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。

获取挂点列表

获取挂点列表:返回当前维护的挂点数组。 每个挂点包含骨骼路径(path)与同步目标节点(target)两个字段。

节点信息

字段
节点 IDskeletalAnimationGetSockets
分类Cocos 组件
二级分类动画
分组SkeletalAnimation
是否需要等待结果
是否需要先选择目标

输入引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation目标 SkeletalAnimation 组件-必填

输出引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
sockets挂点列表数据reference / array / SkeletalAnimation.Socket当前维护的挂点数组,每项包含 path 与 target-可选

使用场景

  • 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
  • 读取组件状态后驱动游戏逻辑
  • 批量设置组件属性完成游戏运行时效果

注意事项

  • 适合的工作流类型:component、library、method、function、class。
  • 目标组件引脚必须连接正确的组件实例。
  • 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。

获取挂点路径

获取骨骼路径:读取可用于挂接子节点的骨骼路径列表。用于确定角色骨骼结构,以便在指定骨骼上挂载武器、装备等。 需要有效的默认动画剪辑才能正常读取。

节点信息

字段
节点 IDskeletalAnimationGetSocketPaths
分类Cocos 组件
二级分类动画
分组SkeletalAnimation
是否需要等待结果
是否需要先选择目标

输入引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation目标 SkeletalAnimation 组件-必填

输出引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
socketPaths挂点路径数据string / array可挂接的骨骼路径列表,依赖有效的默认动画剪辑-可选

使用场景

  • 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
  • 读取组件状态后驱动游戏逻辑
  • 批量设置组件属性完成游戏运行时效果

注意事项

  • 适合的工作流类型:component、library、method、function、class。
  • 目标组件引脚必须连接正确的组件实例。
  • 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。

获取挂点数量

获取挂点数量:返回当前已配置的挂点个数,便于快速判断是否已有挂点。

节点信息

字段
节点 IDskeletalAnimationGetSocketCount
分类Cocos 组件
二级分类动画
分组SkeletalAnimation
是否需要等待结果
是否需要先选择目标

输入引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation目标 SkeletalAnimation 组件-必填

输出引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
socketCount挂点数量数据number当前已配置的挂点个数-可选

使用场景

  • 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
  • 读取组件状态后驱动游戏逻辑
  • 批量设置组件属性完成游戏运行时效果

注意事项

  • 适合的工作流类型:component、library、method、function、class。
  • 目标组件引脚必须连接正确的组件实例。
  • 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。

获取全部属性

获取全部属性:读取预烘焙模式的开关状态,用于快速判断当前是否启用了预烘焙动画。

节点信息

字段
节点 IDskeletalAnimationGetProperties
分类Cocos 组件
二级分类动画
分组SkeletalAnimation
是否需要等待结果
是否需要先选择目标

输入引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation目标 SkeletalAnimation 组件-必填

输出引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
useBakedAnimation预烘焙数据boolean是否启用预烘焙动画-可选

使用场景

  • 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
  • 读取组件状态后驱动游戏逻辑
  • 批量设置组件属性完成游戏运行时效果

注意事项

  • 适合的工作流类型:component、library、method、function、class。
  • 目标组件引脚必须连接正确的组件实例。
  • 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。

获取预烘焙模式

获取预烘焙模式:读取当前是否启用了预烘焙动画。预烘焙模式能提升骨骼动画性能。

节点信息

字段
节点 IDskeletalAnimationGetUseBakedAnimation
分类Cocos 组件
二级分类动画
分组SkeletalAnimation
是否需要等待结果
是否需要先选择目标

输入引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation目标 SkeletalAnimation 组件-必填

输出引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
useBakedAnimation预烘焙数据boolean是否启用预烘焙动画,启用后性能更高但不支持混合与游戏运行时编辑效果-可选

使用场景

  • 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
  • 读取组件状态后驱动游戏逻辑
  • 批量设置组件属性完成游戏运行时效果

注意事项

  • 适合的工作流类型:component、library、method、function、class。
  • 目标组件引脚必须连接正确的组件实例。
  • 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。

设置挂点列表

设置挂点列表:整体替换当前挂点列表。用于动态更新角色身上挂载的子节点,如武器、装备等。 传入的挂点列表需为合法的挂点实例数组。

节点信息

字段
节点 IDskeletalAnimationSetSockets
分类Cocos 组件
二级分类动画
分组SkeletalAnimation
是否需要等待结果
是否需要先选择目标

输入引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
exe执行执行流执行流执行触发-必填
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation目标 SkeletalAnimation 组件-必填
sockets挂点列表数据reference / array / SkeletalAnimation.Socket新的挂点列表,必须是合法的 Socket 类实例数组-必填

输出引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
out完成执行流执行流执行完成-可选
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation透传 SkeletalAnimation 组件-可选

使用场景

  • 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
  • 读取组件状态后驱动游戏逻辑
  • 批量设置组件属性完成游戏运行时效果

注意事项

  • 适合的工作流类型:component、library、method、function、class。
  • 目标组件引脚必须连接正确的组件实例。
  • 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。

设置预烘焙模式

设置预烘焙模式:切换预烘焙动画开关。开启后提升性能,但不支持动画混合与游戏运行时编辑效果。

节点信息

字段
节点 IDskeletalAnimationSetUseBakedAnimation
分类Cocos 组件
二级分类动画
分组SkeletalAnimation
是否需要等待结果
是否需要先选择目标

输入引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
exe执行执行流执行流执行触发-必填
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation目标 SkeletalAnimation 组件-必填
useBakedAnimation预烘焙数据boolean是否启用预烘焙动画开关
默认值:true
必填

输出引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
out完成执行流执行流执行完成-可选
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation透传 SkeletalAnimation 组件-可选

使用场景

  • 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
  • 读取组件状态后驱动游戏逻辑
  • 批量设置组件属性完成游戏运行时效果

注意事项

  • 适合的工作流类型:component、library、method、function、class。
  • 目标组件引脚必须连接正确的组件实例。
  • 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。

停止骨骼动画

停止骨骼动画:停止当前播放的骨骼动画并将进度重置到起点。用于角色死亡、切换状态等需要立即结束动画的场景。

节点信息

字段
节点 IDskeletalAnimationStop
分类Cocos 组件
二级分类动画
分组SkeletalAnimation
是否需要等待结果
是否需要先选择目标

输入引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
exe执行执行流执行流执行触发-必填
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation目标 SkeletalAnimation 组件-必填

输出引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
out完成执行流执行流执行完成-可选
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation透传 SkeletalAnimation 组件-可选

使用场景

  • 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
  • 读取组件状态后驱动游戏逻辑
  • 批量设置组件属性完成游戏运行时效果

注意事项

  • 适合的工作流类型:component、library、method、function、class。
  • 目标组件引脚必须连接正确的组件实例。
  • 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。

暂停骨骼动画

暂停骨骼动画:暂停当前播放的骨骼动画,保留当前帧进度。可用于角色冻结、暂停菜单等场景。

节点信息

字段
节点 IDskeletalAnimationPause
分类Cocos 组件
二级分类动画
分组SkeletalAnimation
是否需要等待结果
是否需要先选择目标

输入引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
exe执行执行流执行流执行触发-必填
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation目标 SkeletalAnimation 组件-必填

输出引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
out完成执行流执行流执行完成-可选
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation透传 SkeletalAnimation 组件-可选

使用场景

  • 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
  • 读取组件状态后驱动游戏逻辑
  • 批量设置组件属性完成游戏运行时效果

注意事项

  • 适合的工作流类型:component、library、method、function、class。
  • 目标组件引脚必须连接正确的组件实例。
  • 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。

重建挂点动画

重建挂点动画:立即刷新所有挂点的同步状态,使挂载的子节点更新到正确的骨骼位置。 在批量修改挂点列表后,可调用此节点手动刷新。

节点信息

字段
节点 IDskeletalAnimationRebuildSocketAnimations
分类Cocos 组件
二级分类动画
分组SkeletalAnimation
是否需要等待结果
是否需要先选择目标

输入引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
exe执行执行流执行流执行触发-必填
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation目标 SkeletalAnimation 组件-必填

输出引脚

引脚 ID名称连接方式值类型用途默认或选择连接要求
out完成执行流执行流执行完成-可选
skeletalAnimation骨骼动画数据cc.Component / SkeletalAnimation透传 SkeletalAnimation 组件-可选

使用场景

  • 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
  • 读取组件状态后驱动游戏逻辑
  • 批量设置组件属性完成游戏运行时效果

注意事项

  • 适合的工作流类型:component、library、method、function、class。
  • 目标组件引脚必须连接正确的组件实例。
  • 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。