使用指南
Cocos 组件 / 2D / SpriteRenderer节点
Cocos 组件 / 2D / SpriteRenderer 节点手册，包含 3 个节点的用途、引脚、使用场景和注意事项。
16
学习目标
访问 Cocos Creator 组件的属性、方法和事件，把引擎能力转成可视化工作流。
覆盖范围
- 节点数量：3
- 分类路径：Cocos 组件 / 2D / SpriteRenderer
典型使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
通用注意事项
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
- 部分组件能力受 Cocos Creator 版本限制，页面会标出版本字段。
节点索引
| 节点 | 节点 ID | 输入/输出 | 执行方式 |
|---|---|---|---|
| 获取常用属性 | spriteRendererGetProperties | 1 / 1 | 立即继续 |
| 获取精灵帧 | spriteRendererGetSpriteFrame | 1 / 1 | 立即继续 |
| 设置精灵帧 | spriteRendererSetSpriteFrame | 3 / 2 | 立即继续 |
获取常用属性
获取常用属性：一次性读取精灵渲染器的常用自身属性。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | spriteRendererGetProperties |
| 分类 | Cocos 组件 |
| 二级分类 | 2D |
| 分组 | SpriteRenderer |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
spriteRenderer | 精灵渲染器 | 数据 | cc.Component / SpriteRenderer | 目标精灵渲染器组件 要操作的 SpriteRenderer 组件。 该组件在 3D 空间中将精灵帧渲染为网格，适合制作”标签牌”、3D 场景中的 2D 贴片等效果。 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
spriteFrame | 精灵帧 | 数据 | cc.Asset / SpriteFrame | 精灵帧 精灵渲染器渲染到 3D 空间的精灵帧资产。 传入 null 可清空当前显示内容。该端口不提供内联选择器，请连接上游 SpriteFrame 资产节点或已加载实例。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
获取精灵帧
获取精灵帧：返回当前 SpriteRenderer 正在渲染的精灵帧。 SpriteRenderer 把精灵帧渲染到 3D 空间，适合制作”标签牌”、血条跟随、3D 场景中的 2D 装饰等效果。 输出为 null 表示当前未绑定精灵帧。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | spriteRendererGetSpriteFrame |
| 分类 | Cocos 组件 |
| 二级分类 | 2D |
| 分组 | SpriteRenderer |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
spriteRenderer | 精灵渲染器 | 数据 | cc.Component / SpriteRenderer | 目标精灵渲染器组件 要操作的 SpriteRenderer 组件。 该组件在 3D 空间中将精灵帧渲染为网格，适合制作”标签牌”、3D 场景中的 2D 贴片等效果。 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
spriteFrame | 精灵帧 | 数据 | cc.Asset / SpriteFrame | 精灵帧 精灵渲染器渲染到 3D 空间的精灵帧资产。 传入 null 可清空当前显示内容。该端口不提供内联选择器，请连接上游 SpriteFrame 资产节点或已加载实例。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
设置精灵帧
设置精灵帧：替换当前精灵渲染器渲染的精灵帧。 传入 null 可清空当前显示内容。该节点只负责替换精灵帧，不负责材质、排序或可见性配置。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | spriteRendererSetSpriteFrame |
| 分类 | Cocos 组件 |
| 二级分类 | 2D |
| 分组 | SpriteRenderer |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | - | 执行流 | 执行流 | 执行入口 | - | 可选 |
spriteRenderer | 精灵渲染器 | 数据 | cc.Component / SpriteRenderer | 目标精灵渲染器组件 要操作的 SpriteRenderer 组件。 该组件在 3D 空间中将精灵帧渲染为网格，适合制作”标签牌”、3D 场景中的 2D 贴片等效果。 | - | 必填 |
spriteFrame | 精灵帧 | 数据 | cc.Asset / SpriteFrame | 精灵帧 精灵渲染器渲染到 3D 空间的精灵帧资产。 传入 null 可清空当前显示内容。该端口不提供内联选择器，请连接上游 SpriteFrame 资产节点或已加载实例。 | - | 可选 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | - | 执行流 | 执行流 | 执行完成 | - | 可选 |
spriteRenderer | 精灵渲染器 | 数据 | cc.Component / SpriteRenderer | 目标精灵渲染器组件 透传当前操作的 SpriteRenderer 组件，便于链式操作。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。