Reading Guide (v8 / API v1)

This section documents v8 / API v1, which is the default engine in Auto.js Pro (Rhino). If you have never heard of “API v1/v2”, Rhino, or Node.js engine—this is the right place to start.

To view the Node.js-based docs (v9 / API v2), switch to the v9 section from the navbar.

API Stability

Auto.js Pro is under active development. APIs may change. We use Stability labels to describe maturity:

Stability: 0 - Deprecated

Deprecated functions/modules/features will be removed or changed soon. Remove them from your scripts to avoid future breakage.

Stability: 1 - Experimental

Experimental functions/modules/features may change or be removed. Use with caution.

Stability: 2 - Stable

Stable functions/modules/features are expected to be backward compatible.

How to read this documentation

Here is a quick example (from the “coordinates-based automation” chapter) for input:

input([i, ]text)

• i {number} index of the input box (the (i+1)-th input)
• text {string} text to input

Square brackets [] mean optional parameters. So you can call:

• input(1, "hello")
• or omit i: input("hello")

When calling functions, do not include the brackets themselves.

For default values, the docs may show something like:

images.detectsColor(image, color, x, y[, threshold = 16, algorithm = "diff"])

The parameters inside [, ...] are optional, and values after = are defaults.