Vision

Compare Image (experimental)

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
baseImage	image	The base image for comparison.	Yes	Yes
comparisonImage	image	The image to compare against the base image.	Yes	Yes

Outputs

Name	Type	Description
default	null

Wait for Text

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
text	string	The text to wait for.	Yes	No
timeout	duration	Maximum time waiting for the text to appear.	Yes	No

Outputs

Name	Type	Description
default	boolean	Whether the text was detected or not
time	number	The actual wait time (ms)
frame	image	Screen capture when text was detected (or timed out)

Text Exists (experimental)

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
allow_pattern	string	Regex pattern to match the text in the region. To allow all text, use .{1,}	Yes	No
allow_case_sensitive	boolean	Whether the regex pattern for Allow should be case sensitive.	Yes	No
reject_pattern	string	Regex pattern to reject the text in the region. Set to empty to disable.	Yes	No
reject_case_sensitive	boolean	Whether the regex pattern for Reject should be case sensitive.	Yes	No
region	region	The region to detect the text from.	Yes	Yes
threshold	number	The minimum confidence percentage required for a match, from 0 to 100.	Yes	No

Outputs

Name	Type	Description
default	boolean	If the text in the region matches any word in the allow list and none in the deny list, this will be true.
text	string	If the text in the region matches any word in the allow list and none in the deny list, this will be the first match found.
If text in the region matches any word in the deny list, this will be the first text that caused the match to fail.
detected_text	string	The text that was recognized by the OCR. If no text was recognized, this will be nil.

Wait for Region

Restrictions: "none"

Waits to match the intended content.

Inputs

Name	Type	Description	Required	Dynamic
matcher	region	Select a region for the selected matcher(s).	Yes	No
mode	enum	Wait for all or any of them to reach the expected status	Yes	No
timeout	duration	Maximum time waiting for the matcher to reach the expected status.	Yes	No
waitUntil	enum	Select the condition to wait for.	Yes	No

Outputs

Name	Type	Description
default	boolean	The matcher reach the expected status.
time	number	The actual wait time (ms)
frame	frame	The frame where the matcher matched the intended content.

Wait for Screen

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
screens	screen	The screen(s) to wait for. When multiple screens are selected, it will wait for any of the screens to appear. Screens are matched in order.	Yes	No
timeout	duration	Maximum time to wait for the screen to appear or disappear.	Yes	No
transitionType	enum	Whether to wait for screen to enter (appear) or exit (disappear)	No	No
waitForMotion	boolean	Wait for the screen to be fully rendered (no motion is detected) before continuing.	No	No
motionTimeout	duration	Maximum time to wait for motion to stop. Only used when the Fully Rendered option is enabled.	No	No
motionThreshold	number	Minimum percentage (0-100) of pixels that must change to detect motion. Only used when the Fully Rendered option is enabled.	No	No
stableFrames	number	The number of stable frames required for the wait for motion to succeed. Only used when the Fully Rendered option is enabled.	No	No
motionIgnore	region	Specify a region to ignore when detecting motion. This will apply a mask to the specified region, excluding it from motion detection. Only used when the Fully Rendered option is enabled.	No	No
motionOnly	region	Specify a region to focus on when detecting motion. This will crop the image to the specified region, only detecting motion within it. Only used when the Fully Rendered option is enabled.	No	No

Outputs

Name	Type	Description
default	screen	Detected screen (if multiple are selected); nil when error and "Continue on Error" is checked
frame	image	Screen capture when screen was detected
time	number	The total waiting time (ms), including motion detection time when enabled
motionTime	number	The total waiting time for the motion to stop (ms) when enabled

Detect Text (experimental)

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
text	string	The text to detect.	Yes	No
frame	image	The image frame to search for the text.	Yes	Yes

Outputs

Name	Type	Description
region	region	The region of the detected text.
default	null

Extract Text (experimental)

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
pattern	string	Match the text against this pattern.	Yes	No
region	region	The region to extract the text from.	Yes	Yes
case_sensitive	boolean	Whether the regex pattern should be case sensitive.	Yes	No
threshold	number	The minimum confidence percentage required for a match, from 0 to 100.	Yes	No

Outputs

Name	Type	Description
default	boolean	If a match was found.
matched_text	string	The text that matches the regex pattern. If no match was found, this will be nil.
detected_text	string	The text that was recognized by the OCR. If no text was recognized, this will be nil.

Wait for Motion

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
type	enum	Wait until motion starts or ends.	Yes	No
timeout	duration	Timeout if motion is not detected or stopped after this period of time.	No	No
stableFrames	number	Number of stable frames required. A frame is considered stable if the percentage of pixels that have changed is below the threshold.	No	No
threshold	number	Minimum percentage of pixels that must change to detect motion.	No	No
includeAudio	boolean	When detecting motion take audio signals into consideration. Audio is detect at a rms (root-mean-square) above 70 dB.	No	No
ignore	region	Specify a region to ignore when detecting motion. This will apply a mask to the specified region, excluding it from motion detection.	No	No
only	region	Specify a region to focus on when detecting motion. This will crop the image to the specified region, only detecting motion within it.	No	No

Outputs

Name	Type	Description
default	image	Screen capture when motion was detected
time	number	The actual wait time (ms)

Detect Color (experimental)

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
color	color	The color to detect.	Yes	No
frame	image	The image frame to search for the color.	Yes	Yes

Outputs

Name	Type	Description
default	null

Detect Image (experimental)

Restrictions: "none"

No docs available

Inputs

Name	Type	Description	Required	Dynamic
image	image	The image to detect within the frame.	Yes	Yes
frame	image	The image frame to search within.	Yes	Yes

Outputs

Name	Type	Description
default	null