Skip to main content

Click Image

Locates an image on the screen and performs a click action at its position.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.

Inputs​

This node does not have direct inputs. It uses a reference image for matching.

Options​

  • Confidence - Confidence level for image recognition (default: 0.95).
  • Mouse Button - Which mouse button to click. Options: Left Button, Center Button, Right Button (default: Left Button).
  • Click Type - Type of click to perform. Options: Single Click, Double Click (default: Single Click).
  • Key Modifier - Keyboard modifier to hold while clicking. Options: None, Alt, Ctrl, Shift, Win, CMD (default: None).

Outputs​

This node does not have outputs.

How It Works​

The Click Image node finds a specified image on the screen and clicks it. When executed, the node:

  1. Downloads and prepares the reference image if needed
  2. Uses pyautogui to locate the image on screen with the specified confidence level
  3. Moves the mouse cursor to the image's position (adjusted by deltaX and deltaY if specified)
  4. Performs the specified click action with any modifier keys
  5. Releases any modifier keys after clicking

Requirements​

  • Valid reference image for matching
  • Confidence value between 0 and 1
  • Valid mouse button and click type selections

Error Handling​

The node will return specific errors in the following cases:

  • Empty image - "Empty Image"
  • Could not read image - "Could not read image"
  • Missing confidence - "Confidence can not be empty"
  • Invalid confidence format - "Confidence is not valid"
  • Confidence out of range - "Confidence must be between 0 and 1"
  • Image not found - "Could not find image. Decreasing confidence may help"

Usage Notes​

  • The confidence level affects the accuracy of image matching
  • Higher confidence values require more precise image matching
  • Lower confidence values may result in false positives but can handle variations better
  • The deltaX and deltaY properties can be used to adjust the click position relative to the found image
  • Modifier keys can be used for special click actions (e.g., Ctrl+Click)
  • This node is useful for automating UI interactions where specific images need to be clicked
  • Works best with high-contrast, static images