Skip to content
SettingService

设置 / SettingService

SettingService Class

设置面板相关API

Table of contents

Methods

collapseSettingPanel(): void client
收起设置面板,如果设置面板入口隐藏,可以通过此接口收起设置面板
promptSettingPanel(): void client
展示设置面板,如果设置面板入口隐藏,可以通过此接口展示设置面板
setOptionVisibility(option: SettingsOption, isVisible: boolean): void client
控制设置面板指定配置项的显隐状态
setSettingButtonVisible(visible: boolean): void client
控制设置面板与角编组件入口显隐

Methods

collapseSettingPanel

Static collapseSettingPanel(): void client

收起设置面板,如果设置面板入口隐藏,可以通过此接口收起设置面板


promptSettingPanel

Static promptSettingPanel(): void client

展示设置面板,如果设置面板入口隐藏,可以通过此接口展示设置面板


setOptionVisibility

Static setOptionVisibility(option, isVisible): void client

控制设置面板指定配置项的显隐状态

Parameters

option SettingsOption要设置的配置项,类型为SettingsOption枚举
isVisible boolean显隐状态,true表示显示,false表示隐藏

setSettingButtonVisible

Static setSettingButtonVisible(visible): void client

控制设置面板与角编组件入口显隐

Parameters

visible boolean是否显示设置面板入口

Precautions

游戏中提供给玩家的退出按钮在设置面板中,如果设置面板入口隐藏,玩家将无法退出游戏。使用此接口时请注意游戏退出逻辑。