文档脚本 API

设置类型与参数

用 registerSetting 为脚本模块添加 ClickGUI 控件。

本页目录

调用格式#

调用格式是 module.registerSetting(type, name, defaultValue, ...options)。前三项依次是类型、名称和默认值,其后按类型传入附加参数。

注册一个位置数值
hud.registerSetting("number", "X", 18, 0, 1000, 1);

type 使用下表中的类型字符串。数值参数按顺序传入,不使用 options 对象。mode 的默认值也需要出现在选项列表中。

六种设置类型#

类型调用格式读取结果
booleanregisterSetting("boolean", name, true)boolean
stringregisterSetting("string", name, "text")string
numberregisterSetting("number", name, value, min, max, step)number;step 省略时为 1
boundsnumberregisterSetting("boundsnumber", name, lower, upper, min, max, step)含两个数值的数组 [lower, upper]
moderegisterSetting("mode", name, defaultName, optionA, optionB, …)当前选项名称 string
colorregisterSetting("color", name, [r, g, b, a])四项颜色数组 [r, g, b, a]

注册示例#

在 onLoad 中注册选项
hud.registerSetting("boolean", "Show FPS", true);
hud.registerSetting("string", "Label", "Polaris");
hud.registerSetting("number", "X", 18, 0, 1000, 1);
hud.registerSetting("boundsnumber", "Range", 2, 4, 0, 10, 0.5);
hud.registerSetting("mode", "Layout", "Compact", "Compact", "Wide");
hud.registerSetting("color", "Text color", [240, 244, 255, 255]);

读取与更新#

调用说明
module.getSetting(name)读取当前值;找不到或读取失败时返回 undefined
module.setSetting(name, value)更新已有设置;标量值需要匹配对应类型
module.setSettingVisibility(name, true)显示已有设置
module.setSettingVisibility(name, false)隐藏已有设置,不删除或重置其值
读取并更新数值
var x = hud.getSetting("X");
hud.setSetting("X", x + 1);
hud.setSettingVisibility("X", true);

当前 color 和 boundsnumber 的 setSetting 实现接收 Java 数组。普通 JavaScript 数组不等同于这两个写入参数的类型;为这两类设置注册默认值后,可以直接在 ClickGUI 编辑。