Cocos 组件 / UI / ScrollBar节点

学习目标

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

覆盖范围

• 节点数量：12
• 分类路径：Cocos 组件 / UI / ScrollBar

典型使用场景

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

通用注意事项

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

节点索引

节点	节点 ID	输入/输出	执行方式
获取滚动方向	scrollBarGetDirection	1 / 1	立即继续
获取滑块 Sprite	scrollBarGetHandle	1 / 1	立即继续
获取所有属性	scrollBarGetProperties	1 / 4	立即继续
获取自动隐藏	scrollBarGetEnableAutoHide	1 / 1	立即继续
获取自动隐藏时长	scrollBarGetAutoHideTime	1 / 1	立即继续
设置滚动方向	scrollBarSetDirection	3 / 2	立即继续
设置滑块 Sprite	scrollBarSetHandle	3 / 2	立即继续
设置所有属性	scrollBarSetProperties	6 / 2	立即继续
设置自动隐藏	scrollBarSetEnableAutoHide	3 / 2	立即继续
设置自动隐藏时长	scrollBarSetAutoHideTime	3 / 2	立即继续
显示滚动条	scrollBarShow	2 / 2	立即继续
隐藏滚动条	scrollBarHide	2 / 2	立即继续

获取滚动方向

获取滚动方向：返回滚动条的排列方向。

节点信息

字段	值
节点 ID	scrollBarGetDirection
分类	Cocos 组件
二级分类	UI
分组	ScrollBar
是否需要等待结果	否
是否需要先选择目标	否

输入引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	必填

输出引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
direction	方向	数据	number	滚动方向 水平（=0）：左右滚动 垂直（=1）：上下滚动	-	可选

使用场景

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

注意事项

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

---

获取滑块 Sprite

获取滑块 Sprite：返回 ScrollBar 用于显示滑块的 Sprite 组件。

节点信息

字段	值
节点 ID	scrollBarGetHandle
分类	Cocos 组件
二级分类	UI
分组	ScrollBar
是否需要等待结果	否
是否需要先选择目标	否

输入引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	必填

输出引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
handle	滑块	数据	cc.Component / Sprite	滑块 Sprite 用于显示滑块的 Sprite 组件	-	可选

使用场景

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

注意事项

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

---

获取所有属性

一次性读出滚动条的全部常用属性：滑块引用、滚动方向、自动隐藏开关与时长。等同于连接多个 获取类节点，但只用一个节点即可。

节点信息

字段	值
节点 ID	scrollBarGetProperties
分类	Cocos 组件
二级分类	UI
分组	ScrollBar
是否需要等待结果	否
是否需要先选择目标	否

输入引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	必填

输出引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
handle	滑块	数据	cc.Component / Sprite	滑块 Sprite 用于显示滑块的 Sprite 组件	-	可选
direction	方向	数据	number	滚动方向 0=HORIZONTAL（水平） 1=VERTICAL（垂直）	-	可选
enableAutoHide	自动隐藏	数据	boolean	自动隐藏开关 滚动条是否自动隐藏	-	可选
autoHideTime	隐藏时长	数据	number	自动隐藏时长 自动隐藏等待时长（秒），仅在 enableAutoHide=true 时有效	-	可选

使用场景

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

注意事项

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

---

获取自动隐藏

获取自动隐藏开关：返回 ScrollBar 是否启用自动隐藏。

节点信息

字段	值
节点 ID	scrollBarGetEnableAutoHide
分类	Cocos 组件
二级分类	UI
分组	ScrollBar
是否需要等待结果	否
是否需要先选择目标	否

输入引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	必填

输出引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
enableAutoHide	自动隐藏	数据	boolean	自动隐藏开关 滚动条是否自动隐藏	-	可选

使用场景

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

注意事项

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

---

获取自动隐藏时长

获取自动隐藏时长：返回 ScrollBar 自动隐藏的等待时长（秒）。 仅在 enableAutoHide=true 时有效。

节点信息

字段	值
节点 ID	scrollBarGetAutoHideTime
分类	Cocos 组件
二级分类	UI
分组	ScrollBar
是否需要等待结果	否
是否需要先选择目标	否

输入引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	必填

输出引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
autoHideTime	隐藏时长	数据	number	自动隐藏时长 自动隐藏等待时长（秒），仅在 enableAutoHide=true 时有效	-	可选

使用场景

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

注意事项

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

---

设置滚动方向

设置滚动方向：更改滚动条的排列方向。 水平滚动条适合横向内容，垂直滚动条适合纵向内容。

节点信息

字段	值
节点 ID	scrollBarSetDirection
分类	Cocos 组件
二级分类	UI
分组	ScrollBar
是否需要等待结果	否
是否需要先选择目标	否

输入引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
exe	-	执行流	执行流	执行入口	-	可选
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	必填
direction	方向	数据	number	滚动方向 水平（=0）：左右滚动 垂直（=1）：上下滚动	下拉选择 默认值：0	必填

输出引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
out	-	执行流	执行流	执行完成	-	可选
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	可选

使用场景

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

注意事项

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

---

设置滑块 Sprite

设置滑块 Sprite：设置 ScrollBar 用于显示滑块的 Sprite 组件。 传入 null 可清空引用。

节点信息

字段	值
节点 ID	scrollBarSetHandle
分类	Cocos 组件
二级分类	UI
分组	ScrollBar
是否需要等待结果	否
是否需要先选择目标	否

输入引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
exe	-	执行流	执行流	执行入口	-	可选
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	必填
handle	滑块	数据	cc.Component / Sprite	滑块 Sprite 用于显示滑块的 Sprite 组件，传入 null 可清空	-	可选

输出引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
out	-	执行流	执行流	执行完成	-	可选
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	可选

使用场景

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

注意事项

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

---

设置所有属性

一次性批量修改滚动条的多个常用属性。 公开引脚语义（重要）：除 exe 与 scrollBar 外，所有可写属性引脚默认不公开（isPublic: false），只有被显式公开的引脚才参与写入。若想保留目标属性原值不变，必须保持引脚不公开——仅断开连线不够，已公开的引脚会用内联控件默认值覆盖原值。

节点信息

字段	值
节点 ID	scrollBarSetProperties
分类	Cocos 组件
二级分类	UI
分组	ScrollBar
是否需要等待结果	否
是否需要先选择目标	否

输入引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
exe	-	执行流	执行流	执行入口	-	可选
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	必填
handle	滑块	数据	cc.Component / Sprite	滑块 Sprite 用于显示滑块的 Sprite 组件。默认不公开；公开后才参与写入。	-	可选 默认隐藏
direction	方向	数据	number	滚动方向 0=HORIZONTAL（水平）, 1=VERTICAL（垂直）。默认不公开；公开后才参与写入。	下拉选择 默认值：0	可选 默认隐藏
enableAutoHide	自动隐藏	数据	boolean	自动隐藏开关 滚动条是否自动隐藏。默认不公开；公开后才参与写入。	开关 默认值：false	可选 默认隐藏
autoHideTime	隐藏时长	数据	number	自动隐藏时长 自动隐藏等待时长（秒），仅在 enableAutoHide=true 时有效。默认不公开；公开后才参与写入。	输入框 默认值：0	可选 默认隐藏

输出引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
out	-	执行流	执行流	执行完成	-	可选
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	可选

使用场景

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

注意事项

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

---

设置自动隐藏

设置自动隐藏开关：设置 ScrollBar 是否启用自动隐藏。

节点信息

字段	值
节点 ID	scrollBarSetEnableAutoHide
分类	Cocos 组件
二级分类	UI
分组	ScrollBar
是否需要等待结果	否
是否需要先选择目标	否

输入引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
exe	-	执行流	执行流	执行入口	-	可选
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	必填
enableAutoHide	自动隐藏	数据	boolean	自动隐藏开关 滚动条是否自动隐藏	开关 默认值：false	必填

输出引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
out	-	执行流	执行流	执行完成	-	可选
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	可选

使用场景

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

注意事项

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

---

设置自动隐藏时长

设置自动隐藏时长：设置 ScrollBar 自动隐藏的等待时长（秒）。 仅在 enableAutoHide=true 时有效。

节点信息

字段	值
节点 ID	scrollBarSetAutoHideTime
分类	Cocos 组件
二级分类	UI
分组	ScrollBar
是否需要等待结果	否
是否需要先选择目标	否

输入引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
exe	-	执行流	执行流	执行入口	-	可选
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	必填
autoHideTime	隐藏时长	数据	number	自动隐藏时长 自动隐藏等待时长（秒），仅在 enableAutoHide=true 时有效	输入框 默认值：0	必填

输出引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
out	-	执行流	执行流	执行完成	-	可选
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	可选

使用场景

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

注意事项

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

---

显示滚动条

显示滚动条：调用 ScrollBar 的 show() 方法，使滚动条立即显示。

节点信息

字段	值
节点 ID	scrollBarShow
分类	Cocos 组件
二级分类	UI
分组	ScrollBar
是否需要等待结果	否
是否需要先选择目标	否

输入引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
exe	-	执行流	执行流	执行入口	-	可选
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	必填

输出引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
out	-	执行流	执行流	执行完成	-	可选
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	可选

使用场景

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

注意事项

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

---

隐藏滚动条

隐藏滚动条：调用 ScrollBar 的 hide() 方法，使滚动条立即隐藏。

节点信息

字段	值
节点 ID	scrollBarHide
分类	Cocos 组件
二级分类	UI
分组	ScrollBar
是否需要等待结果	否
是否需要先选择目标	否

输入引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
exe	-	执行流	执行流	执行入口	-	可选
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	必填

输出引脚

引脚 ID	名称	连接方式	值类型	用途	默认或选择	连接要求
out	-	执行流	执行流	执行完成	-	可选
scrollBar	滚动条	数据	cc.Component / ScrollBar	目标滚动条 要操作的 ScrollBar 组件	-	可选

使用场景

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

注意事项

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