Help Centre › Building Processes
Wait for an image to appear on screen.
Add it to a process
In the process designer, open the Add step tab. Find Wait for an image to appear on screen under Screen › Wait, or type its name in the search box, and drag it onto the canvas.
Fields
| Field | Required | What it does |
|---|---|---|
| Template image path | Yes | The file path to the reference image |
| Variable | Yes | Name of the variable where the result will be stored Default: location. |
| Timeout (seconds) | No | Maximum time to wait in seconds Default: 30. |
| Check interval (seconds) | No | How often to check in seconds Default: 0.5. |
| Match confidence | No | The minimum match confidence (0-100). Higher values require a closer match Default: 0.9. |
| Search region (x,y,w,h) | No | The screen region to search in (x,y,width,height) |
What it gives back
{location}– Match location when found
See all Screen steps.
Errors
| Error | Description |
|---|---|
| Image file not found | The specified image file path does not exist |
Tips
- This function returns null on timeout rather than raising an exception; check the variable for null to determine if the image was found