使用指南
Cocos 组件 / UI / RichText节点
Cocos 组件 / UI / RichText 节点手册，包含 24 个节点的用途、引脚、使用场景和注意事项。
16
学习目标
访问 Cocos Creator 组件的属性、方法和事件，把引擎能力转成可视化工作流。
覆盖范围
- 节点数量：24
- 分类路径：Cocos 组件 / UI / RichText
典型使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
通用注意事项
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
- 部分组件能力受 Cocos Creator 版本限制，页面会标出版本字段。
节点索引
| 节点 | 节点 ID | 输入/输出 | 执行方式 |
|---|---|---|---|
| 获取触摸拦截 | richTextGetHandleTouchEvent | 1 / 1 | 立即继续 |
| 获取垂直对齐 | richTextGetVerticalAlign | 1 / 1 | 立即继续 |
| 获取富文本内容 | richTextGetString | 1 / 1 | 立即继续 |
| 获取缓存模式 | richTextGetCacheMode | 1 / 1 | 立即继续 |
| 获取默认文字颜色 | richTextGetFontColor | 1 / 1 | 立即继续 |
| 获取使用系统字体 | richTextGetUseSystemFont | 1 / 1 | 立即继续 |
| 获取水平对齐 | richTextGetHorizontalAlign | 1 / 1 | 立即继续 |
| 获取所有属性 | richTextGetProperties | 1 / 11 | 立即继续 |
| 获取系统字体名 | richTextGetFontFamily | 1 / 1 | 立即继续 |
| 获取行高 | richTextGetLineHeight | 1 / 1 | 立即继续 |
| 获取字号 | richTextGetFontSize | 1 / 1 | 立即继续 |
| 获取最大宽度 | richTextGetMaxWidth | 1 / 1 | 立即继续 |
| 设置触摸拦截 | richTextSetHandleTouchEvent | 3 / 2 | 立即继续 |
| 设置垂直对齐 | richTextSetVerticalAlign | 3 / 2 | 立即继续 |
| 设置富文本内容 | richTextSetString | 3 / 2 | 立即继续 |
| 设置缓存模式 | richTextSetCacheMode | 3 / 2 | 立即继续 |
| 设置默认文字颜色 | richTextSetFontColor | 3 / 2 | 立即继续 |
| 设置使用系统字体 | richTextSetUseSystemFont | 3 / 2 | 立即继续 |
| 设置水平对齐 | richTextSetHorizontalAlign | 3 / 2 | 立即继续 |
| 设置所有属性 | richTextSetProperties | 13 / 2 | 立即继续 |
| 设置系统字体名 | richTextSetFontFamily | 3 / 2 | 立即继续 |
| 设置行高 | richTextSetLineHeight | 3 / 2 | 立即继续 |
| 设置字号 | richTextSetFontSize | 3 / 2 | 立即继续 |
| 设置最大宽度 | richTextSetMaxWidth | 3 / 2 | 立即继续 |
获取触摸拦截
获取触摸拦截：返回 RichText 组件是否拦截触摸事件。 注意：为 true 时 RichText 会拦截包围盒内的触摸事件，阻止穿透到底层节点；为 false 时触摸事件正常穿透。如果富文本下面是按钮等可交互 UI，建议设为 false。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextGetHandleTouchEvent |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
handleTouchEvent | 触摸拦截 | 数据 | boolean | 触摸拦截 true 时拦截包围盒内触摸事件；false 时触摸穿透到底层节点。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
获取垂直对齐
获取垂直对齐：返回 RichText 组件的垂直对齐方式。 枚举值：TOP（=0）：顶部对齐、CENTER（=1）：居中对齐、BOTTOM（=2）：底部对齐。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextGetVerticalAlign |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
verticalAlign | 垂直对齐 | 数据 | number | 垂直对齐 TOP（=0）：顶部对齐 CENTER（=1）：居中对齐 BOTTOM（=2）：底部对齐 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
获取富文本内容
获取富文本内容：返回 RichText 组件的当前富文本字符串。
默认值：RichText。
标签支持：富文本字符串支持
、 等标签。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextGetString |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
string | 富文本内容 | 数据 | string | 富文本内容 RichText 组件显示的富文本字符串。 支持 、 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
获取缓存模式
获取缓存模式：返回 RichText 组件的缓存模式。合理使用位图缓存可提升文本渲染性能。
枚举值：NONE（=0）：无缓存、BITMAP（=1）：位图缓存、CHAR（=2）：字符缓存。
注意：缓存模式仅支持系统字体；CHAR 模式下对嵌入 标签的图文混排渲染可能存在限制，建议在
重度使用场景优先选择 NONE。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextGetCacheMode |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
cacheMode | 缓存模式 | 数据 | number | 缓存模式 NONE（=0）：无缓存 BITMAP（=1）：位图缓存 CHAR（=2）：字符缓存 仅支持系统字体；CHAR 模式下 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
获取默认文字颜色
获取默认文字颜色：返回 RichText 组件的默认文字颜色。
重要说明：fontColor 仅作为未被富文本
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextGetFontColor |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
fontColor | 默认文字颜色 | 数据 | color | 默认文字颜色 未被 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
获取使用系统字体
获取使用系统字体：返回 RichText 组件是否使用系统字体。 注意：当 关闭系统字体 时，需要在 Inspector 预先配置 TTF 字体资产（本版本未节点化 font）。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextGetUseSystemFont |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
useSystemFont | 系统字体 | 数据 | boolean | 使用系统字体 是否使用系统字体渲染富文本。 为 false 时需在 Inspector 预先配置 TTF 字体资产。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
获取水平对齐
获取水平对齐：返回 RichText 组件的水平对齐方式。 枚举值：LEFT（=0）：左对齐、CENTER（=1）：居中对齐、RIGHT（=2）：右对齐。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextGetHorizontalAlign |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
horizontalAlign | 水平对齐 | 数据 | number | 水平对齐 LEFT（=0）：左对齐 CENTER（=1）：居中对齐 RIGHT（=2）：右对齐 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
获取所有属性
一次性读出 RichText 组件的全部常用属性：富文本内容、对齐与布局、字号/行高、字体/颜色、缓存模式、触摸拦截。等同于连接多个 获取类节点，但只用一个节点即可。适合序列化、调试、批量比较等场景。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextGetProperties |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
string | 富文本内容 | 数据 | string | 富文本内容 RichText 组件显示的富文本字符串。 | - | 可选 |
horizontalAlign | 水平对齐 | 数据 | number | 水平对齐 LEFT = 0、CENTER = 1、RIGHT = 2。 | - | 可选 |
verticalAlign | 垂直对齐 | 数据 | number | 垂直对齐 TOP = 0、CENTER = 1、BOTTOM = 2。 | - | 可选 |
maxWidth | 最大宽度 | 数据 | number | 最大宽度 0 表示不限制宽度；> 0 时文本折行。 | - | 可选 |
fontSize | 字号 | 数据 | number | 字号 RichText 组件的字体大小。 | - | 可选 |
lineHeight | 行高 | 数据 | number | 行高 富文本行与行之间的高度。 | - | 可选 |
fontColor | 默认文字颜色 | 数据 | color | 默认文字颜色 未被 | - | 可选 |
useSystemFont | 系统字体 | 数据 | boolean | 使用系统字体 是否使用系统字体渲染富文本。 | - | 可选 |
fontFamily | 字体名 | 数据 | string | 系统字体名 仅在 useSystemFont = true 时生效。 | - | 可选 |
cacheMode | 缓存模式 | 数据 | number | 缓存模式 NONE = 0、BITMAP = 1、CHAR = 2。 | - | 可选 |
handleTouchEvent | 触摸拦截 | 数据 | boolean | 触摸拦截 true 时拦截包围盒内触摸事件；false 时触摸穿透。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
获取系统字体名
获取系统字体名：返回 RichText 组件使用的系统字体名称。 注意：fontFamily 仅在 useSystemFont = true 时生效。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextGetFontFamily |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
fontFamily | 字体名 | 数据 | string | 系统字体名 仅在 useSystemFont = true 时生效。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
获取行高
获取行高：返回 RichText 组件的行高。 默认值：40。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextGetLineHeight |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
lineHeight | 行高 | 数据 | number | 行高 富文本行与行之间的高度。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
获取字号
获取字号：返回 RichText 组件的字体大小。
默认值：40。
注意：该字号仅作用于未被
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextGetFontSize |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
fontSize | 字号 | 数据 | number | 字号 RichText 组件的字体大小。 仅作用于未被 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
获取最大宽度
获取最大宽度：返回 RichText 组件的最大宽度限制。 默认值：0。 注意：0 表示不限制宽度；大于 0 时文本会按换行符与英文分词策略进行折行。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextGetMaxWidth |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
maxWidth | 最大宽度 | 数据 | number | 最大宽度 0 表示不限制宽度；大于 0 时文本折行。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
设置触摸拦截
设置触摸拦截：设置 RichText 组件是否拦截触摸事件。 注意：为 true 时 RichText 会拦截包围盒内的触摸事件；为 false 时触摸事件穿透到底层节点。如果富文本下面是按钮等交互元素，建议设为 false。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextSetHandleTouchEvent |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | - | 执行流 | 执行流 | 执行入口 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
handleTouchEvent | 触摸拦截 | 数据 | boolean | 触摸拦截 true 时拦截包围盒内触摸事件；false 时触摸穿透到底层节点。 | 开关 默认值：true | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | - | 执行流 | 执行流 | 执行完成 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 透传当前操作的 RichText 组件，便于链式修改富文本样式。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
设置垂直对齐
设置垂直对齐：设置 RichText 组件的垂直对齐方式。 枚举值：TOP（=0）：顶部对齐、CENTER（=1）：居中对齐、BOTTOM（=2）：底部对齐。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextSetVerticalAlign |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | - | 执行流 | 执行流 | 执行入口 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
verticalAlign | 垂直对齐 | 数据 | number | 垂直对齐 TOP（=0）：顶部对齐 CENTER（=1）：居中对齐 BOTTOM（=2）：底部对齐 | 下拉选择 默认值：0 | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | - | 执行流 | 执行流 | 执行完成 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 透传当前操作的 RichText 组件，便于链式修改富文本样式。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
设置富文本内容
设置富文本内容：设置 RichText 组件的富文本字符串。
默认值：RichText。
标签支持：支持
、 等标签；
标签需搭配 imageAtlas 使用（本版本未节点化 imageAtlas，需在 Inspector 预先配置）。
提示：当前内联控件为单行文本输入。长文本与复杂标签建议通过字符串变量或上游字符串节点连线输入。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextSetString |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | - | 执行流 | 执行流 | 执行入口 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
string | 富文本内容 | 数据 | string | 富文本内容 RichText 组件显示的富文本字符串。 支持 、 | 输入框 默认值：“RichText” | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | - | 执行流 | 执行流 | 执行完成 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 透传当前操作的 RichText 组件，便于链式修改富文本样式。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
设置缓存模式
设置缓存模式：设置 RichText 组件的缓存模式。合理使用位图缓存可提升文本渲染性能。
枚举值：NONE（=0）：无缓存、BITMAP（=1）：位图缓存、CHAR（=2）：字符缓存。
注意：缓存模式仅支持系统字体；CHAR 模式下对嵌入 标签的图文混排渲染可能存在限制，建议在
重度使用场景优先选择 NONE。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextSetCacheMode |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | - | 执行流 | 执行流 | 执行入口 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
cacheMode | 缓存模式 | 数据 | number | 缓存模式 NONE（=0）：无缓存 BITMAP（=1）：位图缓存 CHAR（=2）：字符缓存 仅支持系统字体；CHAR 模式下 | 下拉选择 默认值：0 | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | - | 执行流 | 执行流 | 执行完成 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 透传当前操作的 RichText 组件，便于链式修改富文本样式。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
设置默认文字颜色
设置默认文字颜色：设置 RichText 组件的默认文字颜色。
重要说明：fontColor 仅作为未被富文本
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextSetFontColor |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | - | 执行流 | 执行流 | 执行入口 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
fontColor | 默认文字颜色 | 数据 | color | 默认文字颜色 未被 | 可编辑控件 | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | - | 执行流 | 执行流 | 执行完成 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 透传当前操作的 RichText 组件，便于链式修改富文本样式。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
设置使用系统字体
设置使用系统字体：设置 RichText 组件是否使用系统字体。 注意：当 关闭系统字体 时，需要在 Inspector 预先配置 TTF 字体资产（本版本未节点化 font）。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextSetUseSystemFont |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | - | 执行流 | 执行流 | 执行入口 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
useSystemFont | 系统字体 | 数据 | boolean | 使用系统字体 是否使用系统字体渲染富文本。 为 false 时需在 Inspector 预先配置 TTF 字体资产。 | 开关 默认值：true | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | - | 执行流 | 执行流 | 执行完成 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 透传当前操作的 RichText 组件，便于链式修改富文本样式。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
设置水平对齐
设置水平对齐：设置 RichText 组件的水平对齐方式。 枚举值：LEFT（=0）：左对齐、CENTER（=1）：居中对齐、RIGHT（=2）：右对齐。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextSetHorizontalAlign |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | - | 执行流 | 执行流 | 执行入口 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
horizontalAlign | 水平对齐 | 数据 | number | 水平对齐 LEFT（=0）：左对齐 CENTER（=1）：居中对齐 RIGHT（=2）：右对齐 | 下拉选择 默认值：0 | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | - | 执行流 | 执行流 | 执行完成 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 透传当前操作的 RichText 组件，便于链式修改富文本样式。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
设置所有属性
一次性批量修改 RichText 组件的多个常用属性。 公开引脚语义（重要）：除 exe 与 richText 外，所有可写属性引脚默认不公开（isPublic: false），只有被显式公开的引脚才参与写入。若想保留目标属性原值不变，必须保持引脚不公开——仅断开连线不够，已公开的引脚会用内联控件默认值覆盖原值。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextSetProperties |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | - | 执行流 | 执行流 | 执行入口 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
string | 富文本内容 | 数据 | string | 富文本内容 要设置的富文本字符串。默认不公开；公开后才参与写入。 | 输入框 默认值：“RichText” | 可选 默认隐藏 |
horizontalAlign | 水平对齐 | 数据 | number | 水平对齐 LEFT = 0、CENTER = 1、RIGHT = 2。默认不公开；公开后才参与写入。 | 下拉选择 默认值：0 | 可选 默认隐藏 |
verticalAlign | 垂直对齐 | 数据 | number | 垂直对齐 TOP = 0、CENTER = 1、BOTTOM = 2。默认不公开；公开后才参与写入。 | 下拉选择 默认值：0 | 可选 默认隐藏 |
maxWidth | 最大宽度 | 数据 | number | 最大宽度 0 表示不限制宽度；> 0 时文本折行。默认不公开；公开后才参与写入。 | 输入框 默认值：0 | 可选 默认隐藏 |
fontSize | 字号 | 数据 | number | 字号 RichText 字体大小。默认不公开；公开后才参与写入。 | 输入框 默认值：40 | 可选 默认隐藏 |
lineHeight | 行高 | 数据 | number | 行高 富文本行与行之间的高度。默认不公开；公开后才参与写入。 | 输入框 默认值：40 | 可选 默认隐藏 |
fontColor | 默认文字颜色 | 数据 | color | 默认文字颜色 未被 | 可编辑控件 | 可选 默认隐藏 |
useSystemFont | 系统字体 | 数据 | boolean | 使用系统字体 是否使用系统字体渲染富文本。默认不公开；公开后才参与写入。 | 开关 默认值：true | 可选 默认隐藏 |
fontFamily | 字体名 | 数据 | string | 系统字体名 仅在 useSystemFont = true 时生效。默认不公开；公开后才参与写入。 | 输入框 默认值：“Arial” | 可选 默认隐藏 |
cacheMode | 缓存模式 | 数据 | number | 缓存模式 NONE = 0、BITMAP = 1、CHAR = 2。默认不公开；公开后才参与写入。 | 下拉选择 默认值：0 | 可选 默认隐藏 |
handleTouchEvent | 触摸拦截 | 数据 | boolean | 触摸拦截 true 时拦截包围盒内触摸事件；false 时触摸穿透。默认不公开；公开后才参与写入。 | 开关 默认值：true | 可选 默认隐藏 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | - | 执行流 | 执行流 | 执行完成 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 透传当前操作的 RichText 组件，便于链式修改富文本样式。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
设置系统字体名
设置系统字体名：设置 RichText 组件使用的系统字体名称。 注意：fontFamily 仅在 useSystemFont = true 时生效。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextSetFontFamily |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | - | 执行流 | 执行流 | 执行入口 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
fontFamily | 字体名 | 数据 | string | 系统字体名 仅在 useSystemFont = true 时生效。 | 输入框 默认值：“Arial” | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | - | 执行流 | 执行流 | 执行完成 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 透传当前操作的 RichText 组件，便于链式修改富文本样式。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
设置行高
设置行高：设置 RichText 组件的行高。 默认值：40。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextSetLineHeight |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | - | 执行流 | 执行流 | 执行入口 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
lineHeight | 行高 | 数据 | number | 行高 富文本行与行之间的高度。 | 输入框 默认值：40 | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | - | 执行流 | 执行流 | 执行完成 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 透传当前操作的 RichText 组件，便于链式修改富文本样式。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
设置字号
设置字号：设置 RichText 组件的字体大小。
默认值：40。
注意：该字号仅作用于未被
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextSetFontSize |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | - | 执行流 | 执行流 | 执行入口 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
fontSize | 字号 | 数据 | number | 字号 RichText 组件的字体大小。 仅作用于未被 | 输入框 默认值：40 | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | - | 执行流 | 执行流 | 执行完成 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 透传当前操作的 RichText 组件，便于链式修改富文本样式。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。
设置最大宽度
设置最大宽度：设置 RichText 组件的最大宽度限制。 默认值：0。 注意：0 表示不限制宽度；大于 0 时文本会按换行符与英文分词策略进行折行。
节点信息
| 字段 | 值 |
|---|---|
| 节点 ID | richTextSetMaxWidth |
| 分类 | Cocos 组件 |
| 二级分类 | UI |
| 分组 | RichText |
| 是否需要等待结果 | 否 |
| 是否需要先选择目标 | 否 |
输入引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
exe | - | 执行流 | 执行流 | 执行入口 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 要操作的 RichText 组件。 该组件负责在当前节点上显示和控制富文本内容与样式。 | - | 必填 |
maxWidth | 最大宽度 | 数据 | number | 最大宽度 0 表示不限制宽度；大于 0 时文本折行。 | 输入框 默认值：0 | 必填 |
输出引脚
| 引脚 ID | 名称 | 连接方式 | 值类型 | 用途 | 默认或选择 | 连接要求 |
|---|---|---|---|---|---|---|
out | - | 执行流 | 执行流 | 执行完成 | - | 可选 |
richText | RichText 组件 | 数据 | cc.Component / RichText | 目标 RichText 组件 透传当前操作的 RichText 组件，便于链式修改富文本样式。 | - | 可选 |
使用场景
- 控制 UI、音频、动画、物理、灯光、粒子和渲染组件
- 读取组件状态后驱动游戏逻辑
- 批量设置组件属性完成游戏运行时效果
注意事项
- 适合的工作流类型：component、library、method、function、class。
- 目标组件引脚必须连接正确的组件实例。
- 设置类节点通常需要接入执行流，才会真正修改游戏运行时状态。