文档脚本 API

模块 API

创建脚本模块,读取状态,并在卸载时注销。

本页目录

注册与查找#

调用返回值与含义
polaris.registerModule(name, description)返回新建模块;在工作区及全分类搜索中管理
polaris.getModules()返回当前已注册作弊模块的包装对象数组
polaris.getModule(name)按名称查找模块;需要使用存在的模块名称

自己创建的模块由自己的脚本负责注销。对其他模块修改开关或设置,会实时修改当前外挂实例的全局开关与参数。

读取模块#

调用返回值
module.getName()模块名称
module.getDescription()模块描述
module.getCategory()分类名称
module.isEnabled()是否开启,boolean
module.getTag()首个 ModeValue 对应的模式名;没有相应模式时为 null

开关与注销#

调用作用
module.setEnabled(boolean)设定开关状态
module.toggle()切换开关
module.handle(eventName, callback)注册命名回调
module.unregister()关闭模块、清空设置并从模块列表移除

unregister() 用于移除脚本自身创建的模块。切勿尝试用它清空外挂核心内置模块。

聊天与通知#

调用作用
polaris.displayChat(text)在本地聊天栏显示文本,不作为普通聊天消息发往服务器
polaris.displayInfoNotification(title, message)在已开启的 Dynamic Island 中显示信息,默认持续 2400 毫秒
polaris.displayInfoNotification(title, message, duration)在灵动岛显示信息;duration 为持续时间,单位毫秒

信息通知需要先开启 Dynamic Island;关闭灵动岛时不会显示。这与 Module Notifications 的右下角模块开关通知分别管理。

模块选项#

registerSetting、getSetting、setSetting 和 setSettingVisibility 操作模块自己的设置。名称查找不区分大小写;类型、默认值和附加参数必须对应。