Wait for Image
Command description
Wait for the specified image to appear or disappear on the Entire Screen, in the Active Window, or in a Specified Window. This command compares images through Python OpenCV and is sensitive to image and screen size. If the screen resolution differs between the computer where the workflow is built and the computer where it runs, the image may not match.
Command Input Parameters
| input parameters | Input parameter type | Description |
|---|---|---|
| Search Scope | enum | Entire Screen, Active Window, Specified Window |
| Window Object | WindowInstance | Required when Search Scope is Specified Window |
| Image Name | str | Captured image name |
| Condition | enum | Appears, Disappears |
| Match Mode | enum | Auto, Color, Grayscale |
| Wait Duration | number | Maximum time to wait, in seconds |
Command Output Parameters
| Output parameters | Output parameter type | Description |
|---|---|---|
| Wait Result | bool |
Waiting for result description
| Current status | Conditions | return value |
|---|---|---|
| Image exists | Appears | Returns True immediately |
| Image exists | Disappears | Returns True when the image disappears, or False if it still exists when the timeout expires |
| Image does not exist | Disappears | Returns True immediately |
| Image does not exist | Appears | Returns True when the image appears, or False if it is still absent when the timeout expires |
Type definition reference
tip
Prefer element capture when the target can be identified as an element. Image matching is sensitive to display conditions and is not guaranteed to be exact.