Imging module

This module handles Imaging related function used to find images on screen

locate(needle, haystack, locate_all=False, grayscale=False)

Locates one image in another

Parameters:

• locate_all (Optional[bool]) – Locate All ?
• needle (Image) – The image to find
• haystack (Image) – The image to search in
• grayscale (Optional[bool]) – Use grayscale in matching

Returns:

if found (x, y, width, height) of matching region , otherwise None

Return type:

Tuple

locate_in_game_screen(needle, locate_all=False, grayscale=False)

Continent wrapper to locate with region , locates an image in the game area

Parameters:

• needle (Image) – The image to find
• locate_all (Optional[bool]) – Locate All ?
• grayscale (Optional[bool]) – Use grayscale in matching

Returns:

if found (x, y, width, height) of matching region , otherwise None

Return type:

Tuple

locate_on_screen(needle, locate_all=False, grayscale=False)

Locate image on the screen

Parameters:

• needle (Image) – The image to find
• grayscale (Optional[bool]) – Use grayscale in matching
• locate_all (Optional[bool]) – Locate All ?

Returns:

if found (x, y, width, height) of matching region , otherwise None

Return type:

Tuple

locate_with_region(needle, region, locate_all=False, grayscale=False)

Locate image on the screen with a region

Parameters:

• needle (Image) – The image to find
• region (Tuple) – (x, y, width, height) of the region to match in
• grayscale (Optional[bool]) – Use grayscale in matching
• locate_all (Optional[bool]) – Locate All ?

Returns:

if found (x, y, width, height) of matching region , otherwise None

Return type:

Tuple