CogniTabDokumentasyon ng Script
/

Runtime v2.81 · Na-update noong Set 30, 2026

Region

Class

A rectangular region on the screen, measured in pixels on the current screen axes.

Syntax

Region(x, y, width, height, /, scale="fixed", anchor="none", scale_param=ScaleParam())

Mga parameter ng constructor

PangalanPaglalarawan
xNumber
Top-left X coordinate
Kailangan · Ayon lang sa posisyon
Walang default
yNumber
Top-left Y coordinate
Kailangan · Ayon lang sa posisyon
Walang default
widthNumber
Region width
Kailangan · Ayon lang sa posisyon
Walang default
heightNumber
Region height
Kailangan · Ayon lang sa posisyon
Walang default
scaleString
**Applies to region coordinates**. Optional full-screen scale mode on the current X/Y axes. Values: "fixed", "auto", "width", "height".
Opsyonal · Ayon sa posisyon o pangalan
Default: fixed
anchorString
**Applies to region coordinates**. Optional anchor mode. Values: none, center, top, bottom, left, right, top_left, top_right, bottom_left, bottom_right, auto.
Opsyonal · Ayon sa posisyon o pangalan
Default: none
scale_paramScaleParam
**Applies to templates**. Template matching scale parameters.
Opsyonal · Ayon sa posisyon o pangalan
Default: ScaleParam()

Ibinabalik na halaga

Region

Pagkilos / epekto

A rectangular region on the screen, measured in pixels on the current screen axes. Scale/anchor control coordinate mapping across full-screen sizes without rotating through portrait coordinates or using the app viewport; runtime consumers clip the final region to the current screen after mapping and offsets. ScaleParam controls template matching inside this region. Region can be destructured as x, y, width, height.

Pagpapatakbo

  • Naghihintay matapos: Hindi
  • Kaligtasan ng sabayang paggamit: Gumamit ng hiwalay na object sa bawat flow
  • Sabayang pagpapatakbo: Oo

Gumagawa o nagkukuwenta ng geometry sa tumawag na flow nang walang capture o pagkilala. Panatilihing hiwalay ang Region builder sa bawat flow.

Halimbawa

region = Region(100, 200, 300, 400)
hit = region.find("img", 3000, threshold=0.8, rate=3.0)

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Wala

Mga field

PangalanPaglalarawan
xNumber
Top-left horizontal coordinate.
yNumber
Top-left vertical coordinate.
widthNumber
Region width in pixels.
heightNumber
Region height in pixels.
scaleString
**Applies to region coordinates**. Coordinate scale mode using full-screen dimensions on the current X/Y axes, without app viewport scaling or portrait rotation. Values: "fixed" keeps saved pixels unchanged; "auto" scales X by width and Y by height; "width" scales both axes by screen width; "height" scales both axes by screen height.
Default: fixed
anchorString
**Applies to region coordinates**. Coordinate anchor. Values: none, center, top, bottom, left, right, top_left, top_right, bottom_left, bottom_right, auto.
Default: none
scale_paramScaleParam
**Applies to templates**. Template matching scale parameters used by find/wait methods on this region.
Default: ScaleParam()
middle_pointPoint
Center point of this region.
Halimbawa ng field
search_area = Region(120, 240, 360, 420)
left = search_area.x
top = search_area.y
w = search_area.width
h = search_area.height
scale = search_area.scale
anchor = search_area.anchor
search_area.x = 300
search_area.scale_param = ScaleParam(auto_scale=True, template_scale="LONG_EDGE")
center = search_area.middle_point

# I-unpack ang Region bilang x, y, width, height
x, y, width, height = search_area
Halimbawa ng constructor
search_region = Region(120, 240, 360, 420)
fixed_center = Region(120, 240, 360, 420, "fixed", "center")
left_lane = Region(120, 240, 360, 420, scale="width", anchor="left", scale_param=ScaleParam(auto_scale=True, template_scale="LONG_EDGE"))

Mga method

25 method

Region.highlighted

Static Method

Kunin ang lahat ng rehiyon na kasalukuyang naka-highlight ng mga instance ng script.

Syntax

Region.highlighted()

Mga parameter

Wala

Ibinabalik na halaga

list[Region] — listahan ng mga aktibong naka-highlight na rehiyon.

Pagkilos / epekto

Kunin ang lahat ng rehiyon na kasalukuyang naka-highlight ng mga instance ng script.

Pagpapatakbo

  • Naghihintay matapos: May kondisyon
  • Kaligtasan ng sabayang paggamit: Hindi garantisado
  • Sabayang pagpapatakbo: May kondisyon

Ang oras ng pagproseso at paghihintay ay depende sa operasyon. Panatilihin ang nababagong mga value sa flow na may-ari nito; walang pangkalahatang garantiya sa kaligtasan ng pagbabahagi ng mga object sa iba’t ibang flow.

Halimbawa

active_regions = Region.highlighted()
for area in active_regions:
    area.highlight("yellow", auto_hide_ms=500)

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.full_screen

Static Method

Ibalik ang buong kasalukuyang rehiyon ng screen.

Syntax

Region.full_screen()

Mga parameter

Wala

Ibinabalik na halaga

Region — Rehiyon na kasing laki ng screen mula sa host ng runtime.

Pagkilos / epekto

Ibalik ang buong kasalukuyang rehiyon ng screen.

Pagpapatakbo

  • Naghihintay matapos: May kondisyon
  • Kaligtasan ng sabayang paggamit: Hindi garantisado
  • Sabayang pagpapatakbo: May kondisyon

Ang oras ng pagproseso at paghihintay ay depende sa operasyon. Panatilihin ang nababagong mga value sa flow na may-ari nito; walang pangkalahatang garantiya sa kaligtasan ng pagbabahagi ng mga object sa iba’t ibang flow.

Halimbawa

scan = Region.full_screen()
hit = scan.find("ok", 2000)

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.highlight_off

Static Method

I-off ang lahat ng aktibong highlight ng rehiyon.

Syntax

Region.highlight_off()

Mga parameter

Wala

Ibinabalik na halaga

None — Walang halaga.

Pagkilos / epekto

I-off ang lahat ng aktibong highlight ng rehiyon.

Pagpapatakbo

  • Naghihintay matapos: May kondisyon
  • Kaligtasan ng sabayang paggamit: Hindi garantisado
  • Sabayang pagpapatakbo: May kondisyon

Ang oras ng pagproseso at paghihintay ay depende sa operasyon. Panatilihin ang nababagong mga value sa flow na may-ari nito; walang pangkalahatang garantiya sa kaligtasan ng pagbabahagi ng mga object sa iba’t ibang flow.

Halimbawa

scan = Region(120, 260, 280, 160)
scan.highlight("green")
wait(1000)
Region.highlight_off()

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.macro_width

Static Method

Return the screen width of the device that created this macro, adapted to current screen orientation, when available.

Syntax

Region.macro_width()

Mga parameter

Wala

Ibinabalik na halaga

Number? — Lapad ng screen ng macro source, o Wala kapag hindi available.

Pagkilos / epekto

Return the screen width of the device that created this macro, adapted to current screen orientation, when available.

Pagpapatakbo

  • Naghihintay matapos: May kondisyon
  • Kaligtasan ng sabayang paggamit: Hindi garantisado
  • Sabayang pagpapatakbo: May kondisyon

Ang oras ng pagproseso at paghihintay ay depende sa operasyon. Panatilihin ang nababagong mga value sa flow na may-ari nito; walang pangkalahatang garantiya sa kaligtasan ng pagbabahagi ng mga object sa iba’t ibang flow.

Halimbawa

macro_w = Region.macro_width()

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.macro_height

Static Method

Return the screen height of the device that created this macro, adapted to current screen orientation, when available.

Syntax

Region.macro_height()

Mga parameter

Wala

Ibinabalik na halaga

Number? — Taas ng screen ng macro source, o Wala kapag hindi available.

Pagkilos / epekto

Return the screen height of the device that created this macro, adapted to current screen orientation, when available.

Pagpapatakbo

  • Naghihintay matapos: May kondisyon
  • Kaligtasan ng sabayang paggamit: Hindi garantisado
  • Sabayang pagpapatakbo: May kondisyon

Ang oras ng pagproseso at paghihintay ay depende sa operasyon. Panatilihin ang nababagong mga value sa flow na may-ari nito; walang pangkalahatang garantiya sa kaligtasan ng pagbabahagi ng mga object sa iba’t ibang flow.

Halimbawa

macro_h = Region.macro_height()

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.find

Method

Mag-scan sa loob ng rehiyong ito hanggang may tumugmang template o maubos ang oras.

Syntax

region.find(template, timeout=0, threshold=0.7, rate=3.0)

Mga parameter

PangalanPaglalarawan
templateString | Template
Template name, relative folder path, or a Template object in current macro.
Kailangan · Ayon sa posisyon o pangalan
Walang default
timeoutNumber
Maximum wait time in milliseconds. Omit this argument to scan only once.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0
thresholdNumber
Match threshold from 0.0 to 1.0.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0.7
rateNumber
Scan attempts per second (1-60).
Opsyonal · Ayon sa posisyon o pangalan
Default: 3.0

Ibinabalik na halaga

Match — Unang matagumpay na laban, o natagpuan=false kapag nag-time out.

Pagkilos / epekto

Mag-scan sa loob ng rehiyong ito hanggang may tumugmang template o maubos ang oras. Kung walang timeout, isang scan lang ang gagawin. Gamitin ang ScreenCapture.cache_on() upang suriin ang ilang larawan sa iisang naka-pin na frame, saka cache_off() upang alisin ang pagka-pin. Para sa madalas na pagkilala gamit ang pinakabagong available na frame, gamitin din ang ScreenCapture.auto_cache_off(); kung hindi, ginagamit muli ng awtomatikong cache ang mga frame nang hanggang 100 ms. Ang pag-off nito ay nagdaragdag ng trabaho sa pagkuha at hindi garantisadong mas mabilis ang eksekusyon.

Pagpapatakbo

  • Naghihintay matapos: Oo
  • Kaligtasan ng sabayang paggamit: May limitasyon
  • Sabayang pagpapatakbo: May kondisyon

Tumatakbo ang pagkilala sa tumawag na flow at gumagamit ng shared capture. Hinahanap ng find ang paglitaw; hinihintay ng wait ang pagkawala. Kahit isang scan ay nangangailangan ng oras para sa capture at pagkilala; hindi nagiging asynchronous ang tawag dahil sa timeout o polling rate.

Halimbawa

region = Region(80, 220, 420, 520)
hit = region.find("ok", 4000, 0.8, 4.0)
MacroPanel.notify(str(hit))

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.find_multi

Method

I-scan sa loob ng rehiyong ito at ibalik ang lahat ng mga tugma para sa isang template kapag may nakitang kahit isa.

Syntax

region.find_multi(template, timeout=0, threshold=0.7, rate=3.0)

Mga parameter

PangalanPaglalarawan
templateString | Template
Template name, relative folder path, or a Template object in current macro.
Kailangan · Ayon sa posisyon o pangalan
Walang default
timeoutNumber
Maximum wait time in milliseconds. Omit this argument to scan only once.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0
thresholdNumber
Match threshold from 0.0 to 1.0.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0.7
rateNumber
Scan attempts per second (1-60).
Opsyonal · Ayon sa posisyon o pangalan
Default: 3.0

Ibinabalik na halaga

MatchList — Lahat ng mga tugma para sa template, o walang laman na listahan sa timeout.

Pagkilos / epekto

I-scan sa loob ng rehiyong ito at ibalik ang lahat ng mga tugma para sa isang template kapag may nakitang kahit isa. Kung aalisin ang timeout, isang scan pass lang ang gagawin.

Pagpapatakbo

  • Naghihintay matapos: Oo
  • Kaligtasan ng sabayang paggamit: May limitasyon
  • Sabayang pagpapatakbo: May kondisyon

Tumatakbo ang pagkilala sa tumawag na flow at gumagamit ng shared capture. Hinahanap ng find ang paglitaw; hinihintay ng wait ang pagkawala. Kahit isang scan ay nangangailangan ng oras para sa capture at pagkilala; hindi nagiging asynchronous ang tawag dahil sa timeout o polling rate.

Halimbawa

region = Region(80, 220, 420, 520)
matches = region.find_multi("enemy", 3000)
MacroPanel.notify(str(matches))

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.find_any

Method

I-scan ang rehiyong ito at bumalik kapag may nakitang template sa listahan.

Syntax

region.find_any(templates, timeout=0, threshold=0.7, rate=3.0)

Mga parameter

PangalanPaglalarawan
templateslist[String | Template]
Template names or Template objects.
Kailangan · Ayon sa posisyon o pangalan
Walang default
timeoutNumber
Maximum wait time in milliseconds. Omit this argument to scan only once.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0
thresholdNumber
Match threshold from 0.0 to 1.0.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0.7
rateNumber
Scan attempts per second (1-60).
Opsyonal · Ayon sa posisyon o pangalan
Default: 3.0

Ibinabalik na halaga

MatchList — Mga resulta ng batch match kapag may nakitang template, o walang laman na listahan sa timeout.

Pagkilos / epekto

I-scan ang rehiyong ito at bumalik kapag may nakitang template sa listahan. Kung aalisin ang timeout, isang scan pass lang ang gagawin.

Pagpapatakbo

  • Naghihintay matapos: Oo
  • Kaligtasan ng sabayang paggamit: May limitasyon
  • Sabayang pagpapatakbo: May kondisyon

Tumatakbo ang pagkilala sa tumawag na flow at gumagamit ng shared capture. Hinahanap ng find ang paglitaw; hinihintay ng wait ang pagkawala. Kahit isang scan ay nangangailangan ng oras para sa capture at pagkilala; hindi nagiging asynchronous ang tawag dahil sa timeout o polling rate.

Halimbawa

region = Region(80, 220, 420, 520)
matches = region.find_any(["enemy_a", "enemy_b"], 2500)
MacroPanel.notify(str(matches))

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.find_all

Method

I-scan ang rehiyong ito at bumalik lamang kapag nakita ang bawat template sa listahan.

Syntax

region.find_all(templates, timeout=0, threshold=0.7, rate=3.0)

Mga parameter

PangalanPaglalarawan
templateslist[String | Template]
Template names or Template objects.
Kailangan · Ayon sa posisyon o pangalan
Walang default
timeoutNumber
Maximum wait time in milliseconds. Omit this argument to scan only once.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0
thresholdNumber
Match threshold from 0.0 to 1.0.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0.7
rateNumber
Scan attempts per second (1-60).
Opsyonal · Ayon sa posisyon o pangalan
Default: 3.0

Ibinabalik na halaga

MatchList — Mga resulta ng batch match kapag nakita ang lahat ng template, o walang laman na listahan sa timeout.

Pagkilos / epekto

I-scan ang rehiyong ito at bumalik lamang kapag nakita ang bawat template sa listahan. Kung aalisin ang timeout, isang scan pass lang ang gagawin.

Pagpapatakbo

  • Naghihintay matapos: Oo
  • Kaligtasan ng sabayang paggamit: May limitasyon
  • Sabayang pagpapatakbo: May kondisyon

Tumatakbo ang pagkilala sa tumawag na flow at gumagamit ng shared capture. Hinahanap ng find ang paglitaw; hinihintay ng wait ang pagkawala. Kahit isang scan ay nangangailangan ng oras para sa capture at pagkilala; hindi nagiging asynchronous ang tawag dahil sa timeout o polling rate.

Halimbawa

region = Region(80, 220, 420, 520)
matches = region.find_all(["hp", "mp"], 5000)
MacroPanel.notify(str(matches))

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.find_color

Method

I-scan ang rehiyong ito para sa isang target na kulay gamit ang parehong raw-frame RGB tolerance rule bilang pagkilala sa kulay ng UI.

Syntax

region.find_color(color, timeout=0, tolerance=0, rate=3, interval=10)

Mga parameter

PangalanPaglalarawan
colorColor | String | Number
Target color.
Kailangan · Ayon sa posisyon o pangalan
Walang default
timeoutNumber
Maximum wait time in milliseconds. 0 performs one scan pass.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0
toleranceNumber
Allowed per-channel RGB delta from 0 to 255.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0
rateNumber
Scan attempts per second while waiting.
Opsyonal · Ayon sa posisyon o pangalan
Default: 3
intervalNumber
Sampling step in pixels.
Opsyonal · Ayon sa posisyon o pangalan
Default: 10

Ibinabalik na halaga

Match — Itugma sa punto bilang listahan[Point]; ang find_color ay bumabalik ng hindi hihigit sa isang punto.

Pagkilos / epekto

I-scan ang rehiyong ito para sa isang target na kulay gamit ang parehong raw-frame RGB tolerance rule bilang pagkilala sa kulay ng UI. Ang pinakamagandang punto ay pinili ng pinakamaliit na max RGB channel delta.

Pagpapatakbo

  • Naghihintay matapos: Oo
  • Kaligtasan ng sabayang paggamit: May limitasyon
  • Sabayang pagpapatakbo: May kondisyon

Tumatakbo ang pagkilala sa tumawag na flow at gumagamit ng shared capture. Hinahanap ng find ang paglitaw; hinihintay ng wait ang pagkawala. Kahit isang scan ay nangangailangan ng oras para sa capture at pagkilala; hindi nagiging asynchronous ang tawag dahil sa timeout o polling rate.

Halimbawa

scan = Region(80, 220, 420, 520)
hit = scan.find_color("#FF4CAF50", tolerance=8, interval=4)
if hit.found:
    click(hit.point[0], random=0)

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.find_any_color

Method

I-scan ang rehiyong ito para sa maraming target na kulay.

Syntax

region.find_any_color(colors, timeout=0, tolerance=0, rate=3, interval=10)

Mga parameter

PangalanPaglalarawan
colorslist[Color | String | Number] | tuple[Color | String | Number]
Target colors.
Kailangan · Ayon sa posisyon o pangalan
Walang default
timeoutNumber
Maximum wait time in milliseconds. 0 performs one scan pass.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0
toleranceNumber
Allowed per-channel RGB delta from 0 to 255.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0
rateNumber
Scan attempts per second while waiting.
Opsyonal · Ayon sa posisyon o pangalan
Default: 3
intervalNumber
Sampling step in pixels.
Opsyonal · Ayon sa posisyon o pangalan
Default: 10

Ibinabalik na halaga

Match — Itugma sa punto bilang listahan[Point]; isang pinakamagandang punto sa bawat nakitang kulay ng input.

Pagkilos / epekto

I-scan ang rehiyong ito para sa maraming target na kulay. Ang bawat kulay ng input ay nag-aambag ng hindi hihigit sa isang pinakamahusay na punto, na inayos ayon sa listahan ng kulay ng input.

Pagpapatakbo

  • Naghihintay matapos: Oo
  • Kaligtasan ng sabayang paggamit: May limitasyon
  • Sabayang pagpapatakbo: May kondisyon

Tumatakbo ang pagkilala sa tumawag na flow at gumagamit ng shared capture. Hinahanap ng find ang paglitaw; hinihintay ng wait ang pagkawala. Kahit isang scan ay nangangailangan ng oras para sa capture at pagkilala; hindi nagiging asynchronous ang tawag dahil sa timeout o polling rate.

Halimbawa

colors = ["#FF0000", "#00FF00", "#0000FF"]
hit = Region.full_screen().find_any_color(colors, tolerance=6)
if hit.found:
    click(hit, random=0)

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.find_multi_color

Method

I-scan ang rehiyong ito para sa maraming naka-sample na posisyon ng isang target na kulay.

Syntax

region.find_multi_color(color, timeout=0, tolerance=0, rate=3, interval=10)

Mga parameter

PangalanPaglalarawan
colorColor | String | Number
Single target color.
Kailangan · Ayon sa posisyon o pangalan
Walang default
timeoutNumber
Maximum wait time in milliseconds. 0 performs one scan pass.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0
toleranceNumber
Allowed per-channel RGB delta from 0 to 255.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0
rateNumber
Scan attempts per second while waiting.
Opsyonal · Ayon sa posisyon o pangalan
Default: 3
intervalNumber
Sampling step in pixels.
Opsyonal · Ayon sa posisyon o pangalan
Default: 10

Ibinabalik na halaga

Match — Itugma sa punto bilang listahan[Point]; Ang pagtutugma ng mga sample na punto ay pinagbukud-bukod muna gamit ang pinakamalapit na kulay.

Pagkilos / epekto

I-scan ang rehiyong ito para sa maraming naka-sample na posisyon ng isang target na kulay. Ang pagpasa ng isang listahan o tuple ay tinanggihan upang hindi ito tahimik na maging multi-target na paghahanap ng kulay.

Pagpapatakbo

  • Naghihintay matapos: Oo
  • Kaligtasan ng sabayang paggamit: May limitasyon
  • Sabayang pagpapatakbo: May kondisyon

Tumatakbo ang pagkilala sa tumawag na flow at gumagamit ng shared capture. Hinahanap ng find ang paglitaw; hinihintay ng wait ang pagkawala. Kahit isang scan ay nangangailangan ng oras para sa capture at pagkilala; hindi nagiging asynchronous ang tawag dahil sa timeout o polling rate.

Halimbawa

hit = Region(80, 220, 420, 520).find_multi_color("red", tolerance=4, interval=3)
if hit.found:
    first = hit.point[0]
    hit.highlight(color="yellow", auto_hide_ms=800)

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.wait

Method

Maghintay hanggang mawala ang template sa rehiyong ito.

Syntax

region.wait(template, timeout=0, threshold=0.7, rate=3.0)

Mga parameter

PangalanPaglalarawan
templateString | Template
Template name, relative folder path, or a Template object in current macro.
Kailangan · Ayon sa posisyon o pangalan
Walang default
timeoutNumber
Maximum wait time in milliseconds. Omit this argument to scan only once.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0
thresholdNumber
Match threshold from 0.0 to 1.0.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0.7
rateNumber
Scan attempts per second (1-60).
Opsyonal · Ayon sa posisyon o pangalan
Default: 3.0

Ibinabalik na halaga

Match — Pinakabagong katayuan ng tugma kapag nawala ang template o naabot ang timeout.

Pagkilos / epekto

Maghintay hanggang mawala ang template sa rehiyong ito. Kung aalisin ang timeout, isang scan pass lang ang gagawin.

Pagpapatakbo

  • Naghihintay matapos: Oo
  • Kaligtasan ng sabayang paggamit: May limitasyon
  • Sabayang pagpapatakbo: May kondisyon

Tumatakbo ang pagkilala sa tumawag na flow at gumagamit ng shared capture. Hinahanap ng find ang paglitaw; hinihintay ng wait ang pagkawala. Kahit isang scan ay nangangailangan ng oras para sa capture at pagkilala; hindi nagiging asynchronous ang tawag dahil sa timeout o polling rate.

Halimbawa

region = Region(0, 0, 1080, 2400)
result = region.wait("loading", 8000)
MacroPanel.notify(str(result))

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.wait_any

Method

Maghintay hanggang sa mawala ang anumang template sa listahan mula sa rehiyong ito.

Syntax

region.wait_any(templates, timeout=0, threshold=0.7, rate=3.0)

Mga parameter

PangalanPaglalarawan
templateslist[String | Template]
Template names or Template objects.
Kailangan · Ayon sa posisyon o pangalan
Walang default
timeoutNumber
Maximum wait time in milliseconds. Omit this argument to scan only once.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0
thresholdNumber
Match threshold from 0.0 to 1.0.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0.7
rateNumber
Scan attempts per second (1-60).
Opsyonal · Ayon sa posisyon o pangalan
Default: 3.0

Ibinabalik na halaga

MatchList — Isinasaad ng batch match kung kailan hindi na nakita ang kahit isang template.

Pagkilos / epekto

Maghintay hanggang sa mawala ang anumang template sa listahan mula sa rehiyong ito. Kung aalisin ang timeout, isang scan pass lang ang gagawin.

Pagpapatakbo

  • Naghihintay matapos: Oo
  • Kaligtasan ng sabayang paggamit: May limitasyon
  • Sabayang pagpapatakbo: May kondisyon

Tumatakbo ang pagkilala sa tumawag na flow at gumagamit ng shared capture. Hinahanap ng find ang paglitaw; hinihintay ng wait ang pagkawala. Kahit isang scan ay nangangailangan ng oras para sa capture at pagkilala; hindi nagiging asynchronous ang tawag dahil sa timeout o polling rate.

Halimbawa

watch = ["loading", "syncing"]
result = region.wait_any(watch, 10000)
MacroPanel.notify(str(result))

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.wait_all

Method

Maghintay hanggang mawala ang lahat ng template sa listahan sa rehiyong ito.

Syntax

region.wait_all(templates, timeout=0, threshold=0.7, rate=3.0)

Mga parameter

PangalanPaglalarawan
templateslist[String | Template]
Template names or Template objects.
Kailangan · Ayon sa posisyon o pangalan
Walang default
timeoutNumber
Maximum wait time in milliseconds. Omit this argument to scan only once.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0
thresholdNumber
Match threshold from 0.0 to 1.0.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0.7
rateNumber
Scan attempts per second (1-60).
Opsyonal · Ayon sa posisyon o pangalan
Default: 3.0

Ibinabalik na halaga

MatchList — Isinasaad ng batch match kung kailan hindi na matagpuan ang lahat ng template.

Pagkilos / epekto

Maghintay hanggang mawala ang lahat ng template sa listahan sa rehiyong ito. Kung aalisin ang timeout, isang scan pass lang ang gagawin.

Pagpapatakbo

  • Naghihintay matapos: Oo
  • Kaligtasan ng sabayang paggamit: May limitasyon
  • Sabayang pagpapatakbo: May kondisyon

Tumatakbo ang pagkilala sa tumawag na flow at gumagamit ng shared capture. Hinahanap ng find ang paglitaw; hinihintay ng wait ang pagkawala. Kahit isang scan ay nangangailangan ng oras para sa capture at pagkilala; hindi nagiging asynchronous ang tawag dahil sa timeout o polling rate.

Halimbawa

watch = ["loading", "syncing"]
result = region.wait_all(watch, 10000)
MacroPanel.notify(str(result))

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.capture

Method

Kunin ang screen at i-crop sa rehiyong ito, pagkatapos ay ibalik ang resulta bilang isang Template.

Syntax

region.capture(name=None)

Mga parameter

PangalanPaglalarawan
nameString?
Optional template name to save into current macro immediately.
Opsyonal · Ayon sa posisyon o pangalan
Default: None

Ibinabalik na halaga

Template — Na-capture na object ng template.

Pagkilos / epekto

Kunin ang screen at i-crop sa rehiyong ito, pagkatapos ay ibalik ang resulta bilang isang Template.

Pagpapatakbo

  • Naghihintay matapos: Oo
  • Kaligtasan ng sabayang paggamit: May limitasyon
  • Sabayang pagpapatakbo: May kondisyon

Tumatakbo ang pagkilala sa tumawag na flow at gumagamit ng shared capture. Hinahanap ng find ang paglitaw; hinihintay ng wait ang pagkawala. Kahit isang scan ay nangangailangan ng oras para sa capture at pagkilala; hindi nagiging asynchronous ang tawag dahil sa timeout o polling rate.

Halimbawa

sample = Region(120, 280, 220, 120).capture()
saved = sample.save_as("buttons/top/enemy_slot")

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.left

Method

Paliitin ang rehiyong ito patungo sa kaliwang bahagi.

Syntax

region.left(value=0.5)

Mga parameter

PangalanPaglalarawan
valueNumber
Shrink amount: 0 -> 1 means ratio of current width, >1 means pixels.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0.5

Ibinabalik na halaga

Region — Ang isang bagong rehiyon ay makitid mula sa kanang gilid.

Pagkilos / epekto

Paliitin ang rehiyong ito patungo sa kaliwang bahagi. Ang kanang gilid ay gumagalaw pakaliwa ayon sa hiniling na halaga.

Pagpapatakbo

  • Naghihintay matapos: Hindi
  • Kaligtasan ng sabayang paggamit: Gumamit ng hiwalay na object sa bawat flow
  • Sabayang pagpapatakbo: Oo

Gumagawa o nagkukuwenta ng geometry sa tumawag na flow nang walang capture o pagkilala. Panatilihing hiwalay ang Region builder sa bawat flow.

Halimbawa

full = Region(100, 200, 1000, 500)
left_focus = full.left(0.4)
left_focus_px = full.left(400)

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.right

Method

Paliitin ang rehiyong ito patungo sa kanang bahagi.

Syntax

region.right(value=0.5)

Mga parameter

PangalanPaglalarawan
valueNumber
Shrink amount: 0 -> 1 means ratio of current width, >1 means pixels.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0.5

Ibinabalik na halaga

Region — Isang bagong rehiyon ang pinaliit mula sa kaliwang gilid.

Pagkilos / epekto

Paliitin ang rehiyong ito patungo sa kanang bahagi. Ang kaliwang gilid ay gumagalaw pakanan sa hiniling na halaga.

Pagpapatakbo

  • Naghihintay matapos: Hindi
  • Kaligtasan ng sabayang paggamit: Gumamit ng hiwalay na object sa bawat flow
  • Sabayang pagpapatakbo: Oo

Gumagawa o nagkukuwenta ng geometry sa tumawag na flow nang walang capture o pagkilala. Panatilihing hiwalay ang Region builder sa bawat flow.

Halimbawa

full = Region(100, 200, 1000, 500)
right_focus = full.right(0.3)
right_focus_px = full.right(240)

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.top

Method

Paliitin ang rehiyong ito patungo sa itaas na bahagi.

Syntax

region.top(value=0.5)

Mga parameter

PangalanPaglalarawan
valueNumber
Shrink amount: 0 -> 1 means ratio of current height, >1 means pixels.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0.5

Ibinabalik na halaga

Region — Ang isang bagong rehiyon ay makitid mula sa ilalim na gilid.

Pagkilos / epekto

Paliitin ang rehiyong ito patungo sa itaas na bahagi. Ang ilalim na gilid ay gumagalaw paitaas ayon sa hiniling na halaga.

Pagpapatakbo

  • Naghihintay matapos: Hindi
  • Kaligtasan ng sabayang paggamit: Gumamit ng hiwalay na object sa bawat flow
  • Sabayang pagpapatakbo: Oo

Gumagawa o nagkukuwenta ng geometry sa tumawag na flow nang walang capture o pagkilala. Panatilihing hiwalay ang Region builder sa bawat flow.

Halimbawa

full = Region(100, 200, 1000, 500)
top_focus = full.top(0.25)
top_focus_px = full.top(120)

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.bottom

Method

Paliitin ang rehiyong ito patungo sa ibabang bahagi.

Syntax

region.bottom(value=0.5)

Mga parameter

PangalanPaglalarawan
valueNumber
Shrink amount: 0 -> 1 means ratio of current height, >1 means pixels.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0.5

Ibinabalik na halaga

Region — Isang bagong rehiyon ang pinaliit mula sa tuktok na gilid.

Pagkilos / epekto

Paliitin ang rehiyong ito patungo sa ibabang bahagi. Ang tuktok na gilid ay gumagalaw pababa ayon sa hiniling na halaga.

Pagpapatakbo

  • Naghihintay matapos: Hindi
  • Kaligtasan ng sabayang paggamit: Gumamit ng hiwalay na object sa bawat flow
  • Sabayang pagpapatakbo: Oo

Gumagawa o nagkukuwenta ng geometry sa tumawag na flow nang walang capture o pagkilala. Panatilihing hiwalay ang Region builder sa bawat flow.

Halimbawa

full = Region(100, 200, 1000, 500)
bottom_focus = full.bottom(0.25)
bottom_focus_px = full.bottom(120)

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.horizontal

Method

Paliitin nang pahalang patungo sa gitna sa pamamagitan ng paggalaw sa kaliwa at kanang mga gilid papasok.

Syntax

region.horizontal(value=0.5)

Mga parameter

PangalanPaglalarawan
valueNumber
Total horizontal shrink: 0 -> 1 means ratio of current width, >1 means pixels.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0.5

Ibinabalik na halaga

Region — Isang nakasentro na rehiyon na may pinababang lapad.

Pagkilos / epekto

Paliitin nang pahalang patungo sa gitna sa pamamagitan ng paggalaw sa kaliwa at kanang mga gilid papasok.

Pagpapatakbo

  • Naghihintay matapos: Hindi
  • Kaligtasan ng sabayang paggamit: Gumamit ng hiwalay na object sa bawat flow
  • Sabayang pagpapatakbo: Oo

Gumagawa o nagkukuwenta ng geometry sa tumawag na flow nang walang capture o pagkilala. Panatilihing hiwalay ang Region builder sa bawat flow.

Halimbawa

full = Region(100, 200, 1000, 500)
center_lane = full.horizontal(0.5)
center_lane_px = full.horizontal(300)

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.vertical

Method

Paliitin nang patayo patungo sa gitna sa pamamagitan ng paggalaw sa itaas at ibabang mga gilid papasok.

Syntax

region.vertical(value=0.5)

Mga parameter

PangalanPaglalarawan
valueNumber
Total vertical shrink: 0 -> 1 means ratio of current height, >1 means pixels.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0.5

Ibinabalik na halaga

Region — Isang nakasentro na rehiyon na may pinababang taas.

Pagkilos / epekto

Paliitin nang patayo patungo sa gitna sa pamamagitan ng paggalaw sa itaas at ibabang mga gilid papasok.

Pagpapatakbo

  • Naghihintay matapos: Hindi
  • Kaligtasan ng sabayang paggamit: Gumamit ng hiwalay na object sa bawat flow
  • Sabayang pagpapatakbo: Oo

Gumagawa o nagkukuwenta ng geometry sa tumawag na flow nang walang capture o pagkilala. Panatilihing hiwalay ang Region builder sa bawat flow.

Halimbawa

full = Region(100, 200, 1000, 500)
center_band = full.vertical(0.5)
center_band_px = full.vertical(200)

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.middle

Method

Paliitin ang parehong lapad at taas patungo sa gitna.

Syntax

region.middle(value=0.5)

Mga parameter

PangalanPaglalarawan
valueNumber
Shrink amount for both axes: 0 -> 1 means ratio per axis, >1 means pixels per axis.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0.5

Ibinabalik na halaga

Region — Ang isang nakasentro na rehiyon ay nabawasan sa parehong mga palakol.

Pagkilos / epekto

Paliitin ang parehong lapad at taas patungo sa gitna.

Pagpapatakbo

  • Naghihintay matapos: Hindi
  • Kaligtasan ng sabayang paggamit: Gumamit ng hiwalay na object sa bawat flow
  • Sabayang pagpapatakbo: Oo

Gumagawa o nagkukuwenta ng geometry sa tumawag na flow nang walang capture o pagkilala. Panatilihing hiwalay ang Region builder sa bawat flow.

Halimbawa

full = Region(100, 200, 1000, 500)
focus = full.middle(0.4)
focus_px = full.middle(160)

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.highlight

Method

Gumuhit ng naka-highlight na parihaba para sa rehiyong ito.

Syntax

region.highlight(color="green", line_width=2, auto_hide_ms=0, movable=False)

Mga parameter

PangalanPaglalarawan
colorColor | String | Number
Highlight color.
Opsyonal · Ayon sa posisyon o pangalan
Default: green
line_widthNumber
Stroke thickness in dp.
Opsyonal · Ayon sa posisyon o pangalan
Default: 2
auto_hide_msNumber
Auto-hide after N milliseconds. 0 disables auto-hide.
Opsyonal · Ayon sa posisyon o pangalan
Default: 0
movableBoolean
Allow dragging the highlighted region and write the moved coordinates back into this Region.
Opsyonal · Ayon sa posisyon o pangalan
Default: False

Ibinabalik na halaga

Region — Ibinabalik ang parehong rehiyon pagkatapos ng pagguhit ng highlight.

Pagkilos / epekto

Gumuhit ng naka-highlight na parihaba para sa rehiyong ito. Sa movable=True, maaaring i-drag ng user ang rehiyon at ang parehong object ng Rehiyon ay makakatanggap ng na-update na mga coordinate ng screen. Ang muling pag-highlight sa parehong instance ng rehiyon ay papalitan ang nauna.

Pagpapatakbo

  • Naghihintay matapos: May kondisyon
  • Kaligtasan ng sabayang paggamit: Hindi garantisado
  • Sabayang pagpapatakbo: May kondisyon

Ang oras ng pagproseso at paghihintay ay depende sa operasyon. Panatilihin ang nababagong mga value sa flow na may-ari nito; walang pangkalahatang garantiya sa kaligtasan ng pagbabahagi ng mga object sa iba’t ibang flow.

Halimbawa

scan = Region(120, 260, 280, 160)
scan.highlight("#FF00BCD4", line_width=3, auto_hide_ms=1500, movable=True)

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API

Region.highlight_off

Method

I-off ang highlight para sa instance ng rehiyon na ito.

Syntax

region.highlight_off()

Mga parameter

Wala

Ibinabalik na halaga

Region — Ibinabalik ang parehong rehiyon pagkatapos i-off ang highlight.

Pagkilos / epekto

I-off ang highlight para sa instance ng rehiyon na ito.

Pagpapatakbo

  • Naghihintay matapos: May kondisyon
  • Kaligtasan ng sabayang paggamit: Hindi garantisado
  • Sabayang pagpapatakbo: May kondisyon

Ang oras ng pagproseso at paghihintay ay depende sa operasyon. Panatilihin ang nababagong mga value sa flow na may-ari nito; walang pangkalahatang garantiya sa kaligtasan ng pagbabahagi ng mga object sa iba’t ibang flow.

Halimbawa

scan = Region(120, 260, 280, 160)
scan.highlight("green")
wait(1000)
scan.highlight_off()

Mga error / limitasyon

Walang karagdagang limitasyong nakadokumento; sundin ang mga parameter at pagkilos sa itaas.

Mga kaugnay na API