Auto.js 4.1.0 文档

索引 |

目录

  • Engines#

    #
    • name <string> 要运行的脚本名称。这个名称和文件名称无关，只是在任务管理中显示的名称。
    • script <string> 要运行的脚本内容。
    • config <Object> 运行配置项
      • delay <number> 延迟执行的毫秒数，默认为0
      • loopTimes <number> 循环运行次数，默认为1。0为无限循环。
      • interval <number> 循环运行时两次运行之间的时间间隔，默认为0
      • path <Array> | <string> 指定脚本运行的目录。这些路径会用于require时寻找模块文件。

    在新的脚本环境中运行脚本script。返回一个#

    • path <string> 要运行的脚本路径。
    • config <Object> 运行配置项
      • delay <number> 延迟执行的毫秒数，默认为0
      • loopTimes <number> 循环运行次数，默认为1。0为无限循环。
      • interval <number> 循环运行时两次运行之间的时间间隔，默认为0
      • path <Array> | <string> 指定脚本运行的目录。这些路径会用于require时寻找模块文件。

    在新的脚本环境中运行脚本文件path。返回一个#

    • path <string> 要运行的录制文件路径。
    • config <Object> 运行配置项
      • delay <number> 延迟执行的毫秒数，默认为0
      • loopTimes <number> 循环运行次数，默认为1。0为无限循环。
      • interval <number> 循环运行时两次运行之间的时间间隔，默认为0
      • path <Array> | <string> 指定脚本运行的目录。这些路径会用于require时寻找模块文件。

    在新的脚本环境中运行录制文件path。返回一个#

    停止所有正在运行的脚本。包括当前脚本自身。

    engines.stopAllAndToast()#

    停止所有正在运行的脚本并显示停止的脚本数量。包括当前脚本自身。

    engines.myEngine()#

    返回当前脚本的脚本引擎对象(#

    返回当前所有正在运行的脚本的脚本引擎#

    执行脚本时返回的对象，可以通过他获取执行的引擎、配置等，也可以停止这个执行。

    要停止这个脚本的执行，使用exectuion.getEngine().forceStop().

    ScriptExecution.getEngine()#

    返回执行该脚本的脚本引擎对象(#

    返回该脚本的运行配置(#

    脚本引擎对象。

    ScriptEngine.forceStop()#

    停止脚本引擎的执行。

    ScriptEngine.cwd()#

    返回脚本执行的路径。对于一个脚本文件而言为这个脚本所在的文件夹；对于其他脚本，例如字符串脚本，则为null或者执行时的设置值。

    ScriptEngine.getSource()#

    • 返回 #
      • eventName <string> 事件名称
      • ...args <any> 事件参数

      向该脚本引擎发送一个事件，该事件可以在该脚本引擎对应的脚本的events模块监听到并在脚本主线程执行事件处理。

      例如脚本receiver.js的内容如下：

      //监听say事件
events.on("say", function(words){
    toastLog(words);
});
//保持脚本运行
setInterval(()=>{}, 1000);

      同一目录另一脚本可以启动他并发送该事件：

      //运行脚本
var e = engines.execScriptFile("./receiver.js");
//等待脚本启动
sleep(2000);
//向该脚本发送事件
e.getEngine().emit("say", "你好");

      ScriptConfig#

      脚本执行时的配置。

      delay#

      延迟执行的毫秒数

      interval#

      循环运行时两次运行之间的时间间隔

      loopTimes#

      循环运行次数

      getPath()#

      返回一个字符串数组表示脚本运行时模块寻找的路径。