Image Detection flow nodes

Set up detection before using these nodes. See how nodes work for the diagrams.

Triggers

Image Detection triggers only fire while detection is running, and only for enabled modules and targets.

Image Detected

Fires when an image target is found on screen.

Image DetectedTriggeredModule IDImage IDImage NameConfidenceMatch XMatch Y
Outputs
TriggeredFlow
Module IDString
Image IDString
Image NameString
ConfidenceNumber
How closely it matched, from 0 to 1.
Match XNumber
Where it was found, in pixels.
Match YNumber
Properties
Module Filter
Only fire for this module. Empty fires for every module.
Image Filter
Only fire for this image. Empty fires for every image.
Min Confidence
Ignore matches below this confidence, 0 to 1. Default 0.

It fires once the target has matched as many times in a row as its Consecutive matches to trigger setting, and not during the target's cooldown. For a target limited to a region, Match X and Y are measured from the region's corner.

Meter Changed

Fires when a health bar or meter goes up or down.

Meter ChangedTriggeredModule IDTarget IDTarget NameCurrent %Previous %Delta %Is DecreaseChange Type
Outputs
TriggeredFlow
Module IDString
Target IDString
Target NameString
Current %Number
Previous %Number
Delta %Number
The change: negative when the meter drops.
Is DecreaseBoolean
Change TypeString
DamageTaken or Healed.
Properties
Module Filter
Only fire for this module. Empty fires for every module.
Target Filter
Only fire for this target. Empty fires for every target.
Min Delta %
Ignore changes smaller than this, 0 to 100. Default 0.
Decreases Only
Only fire when the meter drops. Default off.

The first reading only sets the starting point. The target's own settings decide what counts as a change: Min Change % (2% by default) and Decreases only (damage), which is on by default. While that target setting is on, increases never reach this node, so turn it off to react to healing.

Damage Taken

Fires when a health bar or meter drops.

Damage TakenTriggeredModule IDTarget IDTarget NameCurrent %Previous %Delta %
Outputs
TriggeredFlow
Module IDString
Target IDString
Target NameString
Current %Number
Previous %Number
Delta %Number
Negative: the amount lost.
Properties
Module Filter
Only fire for this module. Empty fires for every module.
Target Filter
Only fire for this target. Empty fires for every target.
Min Damage %
Ignore drops smaller than this, 0 to 100. Default 0.

Delta % is negative. To use the damage as an intensity, make it positive first: add a Math node set to Subtract, wire Delta % to its B input, and leave A unconnected so it counts as 0.

OCR Detected

Fires when a text target sees one of its keywords, or its number changes.

OCR DetectedTriggeredModule IDTarget IDTarget NameRaw TextNormalized TextMatched KeywordCurrent NumberPrevious NumberDelta NumberChange Type
Outputs
TriggeredFlow
Module IDString
Target IDString
Target NameString
Raw TextString
Normalized TextString
Matched KeywordString
Current NumberNumber
Previous NumberNumber
Delta NumberNumber
Change TypeString
KeywordMatched, NumberIncreased, or NumberDecreased.
Properties
Module Filter
Only fire for this module. Empty fires for every module.
Target Filter
Only fire for this target. Empty fires for every target.
Change Type
keywordmatched, numberincreased, or numberdecreased. Empty fires for all.
Min Delta
Ignore number changes smaller than this. Default 0.

A keyword fires once when it appears, and not again until it has disappeared and come back. For keyword matches, Previous Number and Delta Number are empty. New text targets look for the keyword "Eliminated" until you change it.

Actions

The two screenshot actions let a flow check the screen on demand instead of using background detection. They continue through Done even when they fail; check Success, Found, or Error.

Take Screenshot

Captures the screen.

Take ScreenshotExecuteMonitor IndexDoneScreenshotWidthHeightSuccessError
Inputs
ExecuteFlow
Monitor IndexNumber
Outputs
DoneFlow
ScreenshotAny
The captured image, for Detect Image.
WidthNumber
HeightNumber
SuccessBoolean
ErrorString
Properties
Monitor Index
The monitor to capture, starting at 1. Default 1.
Use Global Config
Capture the monitor chosen on the Image Detection page instead. Default on.

Detect Image

Looks for an image file inside a screenshot.

Detect ImageExecuteScreenshotTemplate PathDoneFoundConfidenceMatch XMatch YError
Inputs
ExecuteFlow
ScreenshotAny
From Take Screenshot.
Template PathString
Overrides the property when connected and not empty.
Outputs
DoneFlow
FoundBoolean
ConfidenceNumber
Match XNumber
Match YNumber
ErrorString
Properties
Template Image Path
The image file to look for.
Match Threshold
How close a match must be, 0 to 1. Default 0.8.
Algorithm
template-matching or template-matching-masked. Default template-matching.

Found is false when nothing matched well enough; Error explains other failures, such as a missing file or an image larger than the screenshot.

Start Detection

Starts background detection, as if you clicked Start Detection on the page.

Start DetectionExecuteDoneWas Already Running
Inputs
ExecuteFlow
Outputs
DoneFlow
Was Already RunningBoolean

Stop Detection

Stops background detection.

Stop DetectionExecuteDoneWas Running
Inputs
ExecuteFlow
Outputs
DoneFlow
Was RunningBoolean

Contributors

Thank you to everyone who has helped improve this documentation.

bwmpbwmp