学习目标
访问 Cocos Creator 组件的属性、方法和事件,把引擎能力转成可视化工作流。
覆盖范围
- 节点数量:13
- 分类路径:Cocos 组件 / 动画 / SkeletalAnimation
典型使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
通用注意事项
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。
- 部分组件能力受 Cocos Creator 版本限制,页面会标出版本字段。
节点索引
| 节点 | 节点 ID | 输入/输出 | 执行方式 |
|---|
| 按路径查询挂点 | skeletalAnimationGetSocketTargetByPath | 2 / 2 | 立即继续 |
| 创建挂点 | skeletalAnimationCreateSocket | 3 / 3 | 立即继续 |
| 恢复骨骼动画 | skeletalAnimationResume | 2 / 2 | 立即继续 |
| 获取挂点列表 | skeletalAnimationGetSockets | 1 / 1 | 立即继续 |
| 获取挂点路径 | skeletalAnimationGetSocketPaths | 1 / 1 | 立即继续 |
| 获取挂点数量 | skeletalAnimationGetSocketCount | 1 / 1 | 立即继续 |
| 获取全部属性 | skeletalAnimationGetProperties | 1 / 1 | 立即继续 |
| 获取预烘焙模式 | skeletalAnimationGetUseBakedAnimation | 1 / 1 | 立即继续 |
| 设置挂点列表 | skeletalAnimationSetSockets | 3 / 2 | 立即继续 |
| 设置预烘焙模式 | skeletalAnimationSetUseBakedAnimation | 3 / 2 | 立即继续 |
| 停止骨骼动画 | skeletalAnimationStop | 2 / 2 | 立即继续 |
| 暂停骨骼动画 | skeletalAnimationPause | 2 / 2 | 立即继续 |
| 重建挂点动画 | skeletalAnimationRebuildSocketAnimations | 2 / 2 | 立即继续 |
按路径查询挂点
按路径查询挂点:根据骨骼路径查找对应的挂点目标节点。用于获取指定骨骼上挂载的子节点。
路径格式示例:Armature/Hips/RightHand。
节点信息
| 字段 | 值 |
|---|
| 节点 ID | skeletalAnimationGetSocketTargetByPath |
| 分类 | 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。
节点信息
| 字段 | 值 |
|---|
| 节点 ID | skeletalAnimationCreateSocket |
| 分类 | 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。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。
恢复骨骼动画
恢复骨骼动画:恢复已暂停的骨骼动画,从暂停时的位置继续播放。配合 暂停 节点使用。
节点信息
| 字段 | 值 |
|---|
| 节点 ID | skeletalAnimationResume |
| 分类 | Cocos 组件 |
| 二级分类 | 动画 |
| 分组 | SkeletalAnimation |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|
exe | 执行 | 执行流 | 执行流 | 执行触发 | - | 必填 |
skeletalAnimation | 骨骼动画 | 数据 | cc.Component / SkeletalAnimation | 目标 SkeletalAnimation 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|
out | 完成 | 执行流 | 执行流 | 执行完成 | - | 可选 |
skeletalAnimation | 骨骼动画 | 数据 | cc.Component / SkeletalAnimation | 透传 SkeletalAnimation 组件 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型:component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。
获取挂点列表
获取挂点列表:返回当前维护的挂点数组。
每个挂点包含骨骼路径(path)与同步目标节点(target)两个字段。
节点信息
| 字段 | 值 |
|---|
| 节点 ID | skeletalAnimationGetSockets |
| 分类 | Cocos 组件 |
| 二级分类 | 动画 |
| 分组 | SkeletalAnimation |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|
skeletalAnimation | 骨骼动画 | 数据 | cc.Component / SkeletalAnimation | 目标 SkeletalAnimation 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|
sockets | 挂点列表 | 数据 | reference / array / SkeletalAnimation.Socket | 当前维护的挂点数组,每项包含 path 与 target | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型:component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。
获取挂点路径
获取骨骼路径:读取可用于挂接子节点的骨骼路径列表。用于确定角色骨骼结构,以便在指定骨骼上挂载武器、装备等。
需要有效的默认动画剪辑才能正常读取。
节点信息
| 字段 | 值 |
|---|
| 节点 ID | skeletalAnimationGetSocketPaths |
| 分类 | Cocos 组件 |
| 二级分类 | 动画 |
| 分组 | SkeletalAnimation |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|
skeletalAnimation | 骨骼动画 | 数据 | cc.Component / SkeletalAnimation | 目标 SkeletalAnimation 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|
socketPaths | 挂点路径 | 数据 | string / array | 可挂接的骨骼路径列表,依赖有效的默认动画剪辑 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型:component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。
获取挂点数量
获取挂点数量:返回当前已配置的挂点个数,便于快速判断是否已有挂点。
节点信息
| 字段 | 值 |
|---|
| 节点 ID | skeletalAnimationGetSocketCount |
| 分类 | Cocos 组件 |
| 二级分类 | 动画 |
| 分组 | SkeletalAnimation |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|
skeletalAnimation | 骨骼动画 | 数据 | cc.Component / SkeletalAnimation | 目标 SkeletalAnimation 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|
socketCount | 挂点数量 | 数据 | number | 当前已配置的挂点个数 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型:component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。
获取全部属性
获取全部属性:读取预烘焙模式的开关状态,用于快速判断当前是否启用了预烘焙动画。
节点信息
| 字段 | 值 |
|---|
| 节点 ID | skeletalAnimationGetProperties |
| 分类 | Cocos 组件 |
| 二级分类 | 动画 |
| 分组 | SkeletalAnimation |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|
skeletalAnimation | 骨骼动画 | 数据 | cc.Component / SkeletalAnimation | 目标 SkeletalAnimation 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|
useBakedAnimation | 预烘焙 | 数据 | boolean | 是否启用预烘焙动画 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型:component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。
获取预烘焙模式
获取预烘焙模式:读取当前是否启用了预烘焙动画。预烘焙模式能提升骨骼动画性能。
节点信息
| 字段 | 值 |
|---|
| 节点 ID | skeletalAnimationGetUseBakedAnimation |
| 分类 | Cocos 组件 |
| 二级分类 | 动画 |
| 分组 | SkeletalAnimation |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|
skeletalAnimation | 骨骼动画 | 数据 | cc.Component / SkeletalAnimation | 目标 SkeletalAnimation 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|
useBakedAnimation | 预烘焙 | 数据 | boolean | 是否启用预烘焙动画,启用后性能更高但不支持混合与游戏运行时编辑效果 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型:component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。
设置挂点列表
设置挂点列表:整体替换当前挂点列表。用于动态更新角色身上挂载的子节点,如武器、装备等。
传入的挂点列表需为合法的挂点实例数组。
节点信息
| 字段 | 值 |
|---|
| 节点 ID | skeletalAnimationSetSockets |
| 分类 | 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。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。
设置预烘焙模式
设置预烘焙模式:切换预烘焙动画开关。开启后提升性能,但不支持动画混合与游戏运行时编辑效果。
节点信息
| 字段 | 值 |
|---|
| 节点 ID | skeletalAnimationSetUseBakedAnimation |
| 分类 | 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。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。
停止骨骼动画
停止骨骼动画:停止当前播放的骨骼动画并将进度重置到起点。用于角色死亡、切换状态等需要立即结束动画的场景。
节点信息
| 字段 | 值 |
|---|
| 节点 ID | skeletalAnimationStop |
| 分类 | Cocos 组件 |
| 二级分类 | 动画 |
| 分组 | SkeletalAnimation |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|
exe | 执行 | 执行流 | 执行流 | 执行触发 | - | 必填 |
skeletalAnimation | 骨骼动画 | 数据 | cc.Component / SkeletalAnimation | 目标 SkeletalAnimation 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|
out | 完成 | 执行流 | 执行流 | 执行完成 | - | 可选 |
skeletalAnimation | 骨骼动画 | 数据 | cc.Component / SkeletalAnimation | 透传 SkeletalAnimation 组件 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型:component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。
暂停骨骼动画
暂停骨骼动画:暂停当前播放的骨骼动画,保留当前帧进度。可用于角色冻结、暂停菜单等场景。
节点信息
| 字段 | 值 |
|---|
| 节点 ID | skeletalAnimationPause |
| 分类 | Cocos 组件 |
| 二级分类 | 动画 |
| 分组 | SkeletalAnimation |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|
exe | 执行 | 执行流 | 执行流 | 执行触发 | - | 必填 |
skeletalAnimation | 骨骼动画 | 数据 | cc.Component / SkeletalAnimation | 目标 SkeletalAnimation 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|
out | 完成 | 执行流 | 执行流 | 执行完成 | - | 可选 |
skeletalAnimation | 骨骼动画 | 数据 | cc.Component / SkeletalAnimation | 透传 SkeletalAnimation 组件 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型:component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。
重建挂点动画
重建挂点动画:立即刷新所有挂点的同步状态,使挂载的子节点更新到正确的骨骼位置。
在批量修改挂点列表后,可调用此节点手动刷新。
节点信息
| 字段 | 值 |
|---|
| 节点 ID | skeletalAnimationRebuildSocketAnimations |
| 分类 | Cocos 组件 |
| 二级分类 | 动画 |
| 分组 | SkeletalAnimation |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|
exe | 执行 | 执行流 | 执行流 | 执行触发 | - | 必填 |
skeletalAnimation | 骨骼动画 | 数据 | cc.Component / SkeletalAnimation | 目标 SkeletalAnimation 组件 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|
out | 完成 | 执行流 | 执行流 | 执行完成 | - | 可选 |
skeletalAnimation | 骨骼动画 | 数据 | cc.Component / SkeletalAnimation | 透传 SkeletalAnimation 组件 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型:component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流,才会真正修改游戏运行时状态。