Definition and Usage
This command allows you to pause the workflow execution until a specified image appears or disappears on the screen. It is useful for synchronizing automation steps with visual elements on the screen, ensuring that the workflow proceeds only when the target image is visible or has disappeared.
Parameter Values
Input parameters
Parameter | Description | Possible Values | Required | Options / Notes |
Search scope | Specify the scope to search for the target image | Entire screen, Specific window, Currently active window | Yes | Determines where the system will look for the image |
Window | Select a window object that was obtained earlier | - | Only if "Specific window" is selected | Must reference a previously captured window object |
Select image | The image to locate on the screen or within the selected window | - | Yes | Use the Capture button to select an image from the screen |
Wait for image | Wait for image to appear/disappear | Appear, Disappear | Yes | Determines the wait condition |
Timeout (s) | Set maximum wait time | - | Yes | Maximum time in seconds the command will wait before timing out |
Advanced settings
Parameter | Description | Possible Values | Required | Options / Notes |
Match mode | Method for comparing images | Color matching, Grayscale matching | No | Grayscale matching is faster but less precise |
Similarity (%) | Sets the similarity threshold for image matching | 0-100 | No | Recommended: 80%; higher values require more exact matches |
Error handling
Parameter Name | Description |
Throw error & stop | When an error occurs, the action will trigger an error and stop the execution of the entire app. |
Retry command | If an error occurs, the action will retry the command in an attempt to resolve the issue and continue the process. |
Ignore error & continue | When an error occurs, the action will be ignored, and the workflow will continue without interruption. |
Variables produced
This action produces a variable that stores the result of the wait operation. This is typically a boolean value indicating whether the image was found (true) or not found (false) within the specified timeout period.
Using Variables in Conditions
You can use the output variable in conditional statements to make decisions based on whether the image was successfully found. For example, you could create an If condition that checks if the wait operation was successful before proceeding with subsequent steps.
Notes
The image recognition quality depends on screen resolution, color settings, and the uniqueness of the target image.
For better reliability, select distinctive images with clear edges and avoid images that might change appearance (like animated elements).
If the command frequently times out, consider:
Increasing the timeout value
Lowering the similarity threshold
Capturing a more distinctive portion of the screen
The command will continue execution immediately after finding the image (for "Appear") or confirming its absence (for "Disappear"), without waiting for the full timeout period.