Hamibot 文档

深色模式

Console ​

控制台模块提供了一个和 Web 浏览器中相似的用于调试的控制台。用于输出一些调试信息、中间结果等。 console 模块中的一些函数也可以直接作为全局函数使用，例如 log, print 等。

console.show() ​

显示控制台。这会显示一个控制台的悬浮窗(需要悬浮窗权限)。

console.hide() ​

隐藏控制台悬浮窗。

Hamibot 1.6.0 在脚本结束时会自动隐藏悬浮窗

console.clear() ​

清空控制台。

console.log([data][, ...args]) ​

  • data <any>
  • ...args <any>

打印到控制台，并带上换行符。 可以传入多个参数，第一个参数作为主要信息，其他参数作为类似于 printf(3) 中的代替值（参数都会传给 util.format()）。

js
const count = 5;
console.log('count: %d', count);
// 打印: count: 5 到 stdout
console.log('count:', count);
// 打印: count: 5 到 stdout

详见 util.format()。

该函数也可以作为全局函数使用。

console.verbose([data][, ...args]) ​

  • data <any>
  • ...args <any>

与 console.log 类似，但输出结果以灰色字体显示。输出优先级低于 log，用于输出观察性质的信息。

console.info([data][, ...args]) ​

  • data <any>
  • ...args <any>

与 console.log 类似，但输出结果以绿色字体显示。输出优先级高于 log, 用于输出重要信息。

console.warn([data][, ...args]) ​

  • data <any>
  • ...args <any>

与 console.log 类似，但输出结果以蓝色字体显示。输出优先级高于 info, 用于输出警告信息。

console.error([data][, ...args]) ​

  • data <any>
  • ...args <any>

与 console.log 类似，但输出结果以红色字体显示。输出优先级高于 warn, 用于输出错误信息。

console.assert(value, message) ​

  • value <any> 要断言的布尔值
  • message <String> value 为 false 时要输出的信息

断言。如果 value 为 false 则输出错误信息 message 并停止脚本运行。

js
var a = 1 + 1;
console.assert(a == 2, '加法出错啦');

console.time([label]) ​

  • label <String> 计时器标签，可省略

启动一个定时器，用以计算一个操作的持续时间。 定时器由一个唯一的 label 标识。 当调用 console.timeEnd() 时，可以使用相同的 label 来停止定时器，并以毫秒为单位将持续时间输出到控制台。 重复启动同一个标签的定时器会覆盖之前启动同一标签的定时器。

console.timeEnd(label) ​

  • label <String> 计时器标签

停止之前通过调用 console.time() 启动的定时器，并打印结果到控制台。 调用 console.timeEnd() 后定时器会被删除。如果不存在标签指定的定时器则会打印 NaNms。

js
console.time('求和');
var sum = 0;
for (let i = 0; i < 100000; i++) {
  sum += i;
}
console.timeEnd('求和');
// 打印 求和: xxx ms

console.trace([data][, ...args]) ​

  • data <any>
  • ...args <any>

与 console.log 类似，同时会打印出调用这个函数所在的调用栈信息（即当前运行的文件、行数等信息）。

js
console.trace('Show me');
// 打印: (堆栈跟踪会根据被调用的跟踪的位置而变化)
// Show me
//  at <test>:7

console.input(data[, ...args]) ​

  • data <any>
  • ...args <any>

与 console.log 一样输出信息，并在控制台显示输入框等待输入。按控制台的确认按钮后会将输入的字符串用 eval 计算后返回。

部分机型可能会有控制台不显示输入框的情况，属于 bug。

例如：

js
var n = console.input('请输入一个数字:');
//输入123之后：
toast(n + 1);
//显示124

console.rawInput(data[, ...args]) ​

  • data <any>
  • ...args <any>

与 console.log 一样输出信息，并在控制台显示输入框等待输入。按控制台的确认按钮后会将输入的字符串直接返回。

部分机型可能会有控制台不显示输入框的情况，属于 bug。

例如：

js
var n = console.rawInput('请输入一个数字:');
//输入123之后：
toast(n + 1);
//显示1231

console.setSize(w, h) ​

  • w <Number> 宽度
  • h <Number> 高度

设置控制台的大小，单位像素。

js
console.show();
//设置控制台大小为屏幕的四分之一
console.setSize(device.width / 2, device.height / 2);

console.setPosition(x, y) ​

  • x <Number> 横坐标
  • y <Number> 纵坐标

设置控制台的位置，单位像素。

js
console.show();
console.setPosition(100, 100);

console.setGlobalLogConfig(config) ​

  • config <Object> 日志配置，可选的项有：
    • file <String> 日志文件路径，将会把日志写入该文件中
    • maxFileSize <Number> 最大文件大小，单位字节，默认为 512 * 1024 (512KB)
    • rootLevel <String> 写入的日志级别，默认为"ALL"（所有日志），可以为"OFF"(关闭), "DEBUG", "INFO", "WARN", "ERROR", "FATAL"等。
    • maxBackupSize <Number> 日志备份文件最大数量，默认为 5
    • filePattern <String> 日志写入格式，参见 PatternLayout

设置日志保存的路径和配置。例如把日志保存到"/sdcard/1.txt":

js
console.setGlobalLogConfig({
  file: '/sdcard/1.txt',
});

注意该函数会影响所有脚本的日志记录。

print(text) ​

  • text <String> | <Object> 要打印到控制台的信息

相当于 log(text)。

Copyright © Hamibot