CogniTabDokumentasyon ng Script
/

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

OverlayText

Class

Gumuhit ng text sa itaas ng screen na may opsyonal na pagsubaybay sa pakikipag-ugnayan (pindutin/ilipat/i-hold).

Syntax

OverlayText(text="", position=(0, 0), color="#FFFFFFFF", size=16, background=None)

Mga parameter ng constructor

PangalanPaglalarawan
textString
Initial text content.
Opsyonal · Ayon sa posisyon o pangalan
Default: ""
positionPoint | tuple[Number, Number]
Initial position as Point or tuple/list (x, y). Point carries scale/anchor metadata.
Opsyonal · Ayon sa posisyon o pangalan
Default: (0, 0)
colorColor | String | Number
Initial text color.
Opsyonal · Ayon sa posisyon o pangalan
Default: white
sizeNumber
Initial text size (sp).
Opsyonal · Ayon sa posisyon o pangalan
Default: 16
backgroundColor | String | Number | None
Initial background color. None means transparent/no background.
Opsyonal · Ayon sa posisyon o pangalan
Default: None

Ibinabalik na halaga

OverlayText

Pagkilos / epekto

Gumuhit ng text sa itaas ng screen na may opsyonal na pagsubaybay sa pakikipag-ugnayan (pindutin/ilipat/i-hold). Ang mga pangalan ng setter tulad ng text/background ay mga pamamaraan; basahin ang mga kasalukuyang halaga sa pamamagitan ng state().

Pagpapatakbo

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

Bawat flow ay may sariling overlay id; nililinis lang ng off_all() ang overlay ng flow na iyon. Ipinapadala sa Android Main ang gawain sa UI at maaaring maghintay ang caller. Panatilihin sa may-ari nitong flow ang nababagong overlay builder.

Halimbawa

badge = OverlayText("Running...", Point(320, 160, scale="width", anchor="top"), background=None)
badge.color("#FF00E676").background("#66000000").size(18).track(press=True, move=True, hold=True, hold_ms=700)
badge.show()

state = badge.state()
if state["status"] == 2:
    MacroPanel.notify("Badge is moving")

p = badge.get_point()
r = badge.get_region()
if r is not None:
    r.highlight("yellow", auto_hide_ms=600)

badge.hide()   # itago agad
badge.show()   # ipakita muli agad
badge.off()    # ganap na bitawan

Mga error / limitasyon

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

Mga kaugnay na API

Mga field

PangalanPaglalarawan
xNumber
Top-left X position in pixels. Writable before show().
Default: 0
yNumber
Top-left Y position in pixels. Writable before show().
Default: 0
scaleString
Coordinate scale copied from Point positions.
Default: fixed
anchorString
Coordinate anchor copied from Point positions.
Default: none
argbColor
Text color. Assign with Color/string/number values. Use overlay.color(value) for method chaining.
Default: white
size_spNumber
Text size in sp. Use overlay.size(sp) for method chaining.
Default: 16
Halimbawa ng constructor
badge = OverlayText("Ready", Point(420, 220, scale="width", anchor="top"), background=None)

Mga method

13 method

OverlayText.off_all

Static Method

I-off at bitawan ang lahat ng overlay text na ginawa ng kasalukuyang daloy, nang hindi naaapektuhan ang mga daloy na tumatakbo nang sabay.

Syntax

OverlayText.off_all()

Mga parameter

Wala

Ibinabalik na halaga

None — Walang return value.

Pagkilos / epekto

I-off at bitawan ang lahat ng overlay text na ginawa ng kasalukuyang daloy, nang hindi naaapektuhan ang mga daloy na tumatakbo nang sabay.

Pagpapatakbo

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

Bawat flow ay may sariling overlay id; nililinis lang ng off_all() ang overlay ng flow na iyon. Ipinapadala sa Android Main ang gawain sa UI at maaaring maghintay ang caller. Panatilihin sa may-ari nitong flow ang nababagong overlay builder.

Halimbawa

# Bitawan ang mga overlay na pag-aari ng flow na ito
a = OverlayText("Running", (24, 120))
a.show()
OverlayText.off_all()

Mga error / limitasyon

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

Mga kaugnay na API

OverlayText.text

Method

I-update ang ipinapakitang nilalaman ng teksto.

Syntax

overlay.text(value)

Mga parameter

PangalanPaglalarawan
valueString
Text content.
Kailangan · Ayon sa posisyon o pangalan
Walang default

Ibinabalik na halaga

OverlayText — Ibinabalik ang parehong tagabuo ng overlay na teksto.

Pagkilos / epekto

I-update ang ipinapakitang nilalaman ng teksto.

Pagpapatakbo

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

Bawat flow ay may sariling overlay id; nililinis lang ng off_all() ang overlay ng flow na iyon. Ipinapadala sa Android Main ang gawain sa UI at maaaring maghintay ang caller. Panatilihin sa may-ari nitong flow ang nababagong overlay builder.

Halimbawa

# I-configure o suriin ang overlay na pag-aari ng flow na ito
badge = OverlayText("Ready", (24, 120))
badge.text("Running")
badge.show()

Mga error / limitasyon

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

Mga kaugnay na API

OverlayText.color

Method

I-update ang kulay ng text.

Syntax

overlay.color(value)

Mga parameter

PangalanPaglalarawan
valueColor | String | Number
Color value.
Kailangan · Ayon sa posisyon o pangalan
Walang default

Ibinabalik na halaga

OverlayText — Ibinabalik ang parehong tagabuo ng overlay na teksto.

Pagkilos / epekto

I-update ang kulay ng text.

Pagpapatakbo

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

Bawat flow ay may sariling overlay id; nililinis lang ng off_all() ang overlay ng flow na iyon. Ipinapadala sa Android Main ang gawain sa UI at maaaring maghintay ang caller. Panatilihin sa may-ari nitong flow ang nababagong overlay builder.

Halimbawa

# I-configure o suriin ang overlay na pag-aari ng flow na ito
badge = OverlayText("Ready", (24, 120))
badge.color("#FF00E676")
badge.show()

Mga error / limitasyon

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

Mga kaugnay na API

OverlayText.background

Method

I-update ang kulay ng background.

Syntax

overlay.background(value=None)

Mga parameter

PangalanPaglalarawan
valueColor | String | Number | None
Background color, or None for transparent/no background.
Opsyonal · Ayon sa posisyon o pangalan
Default: None

Ibinabalik na halaga

OverlayText — Ibinabalik ang parehong tagabuo ng overlay na teksto.

Pagkilos / epekto

I-update ang kulay ng background. Ang pagpasa sa Wala ay nag-aalis ng background.

Pagpapatakbo

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

Bawat flow ay may sariling overlay id; nililinis lang ng off_all() ang overlay ng flow na iyon. Ipinapadala sa Android Main ang gawain sa UI at maaaring maghintay ang caller. Panatilihin sa may-ari nitong flow ang nababagong overlay builder.

Halimbawa

# I-configure o suriin ang overlay na pag-aari ng flow na ito
badge = OverlayText("Ready", (24, 120))
badge.background("#66000000")
badge.show()
badge.background(None)

Mga error / limitasyon

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

Mga kaugnay na API

OverlayText.size

Method

I-update ang laki ng teksto (sp).

Syntax

overlay.size(sp)

Mga parameter

PangalanPaglalarawan
spNumber
Text size in sp.
Kailangan · Ayon sa posisyon o pangalan
Walang default

Ibinabalik na halaga

OverlayText — Ibinabalik ang parehong tagabuo ng overlay na teksto.

Pagkilos / epekto

I-update ang laki ng teksto (sp).

Pagpapatakbo

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

Bawat flow ay may sariling overlay id; nililinis lang ng off_all() ang overlay ng flow na iyon. Ipinapadala sa Android Main ang gawain sa UI at maaaring maghintay ang caller. Panatilihin sa may-ari nitong flow ang nababagong overlay builder.

Halimbawa

# I-configure o suriin ang overlay na pag-aari ng flow na ito
badge = OverlayText("Ready", (24, 120))
badge.size(20)
badge.show()

Mga error / limitasyon

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

Mga kaugnay na API

OverlayText.position

Method

I-update ang posisyon ng draw gamit ang Point o tuple/list (x, y).

Syntax

overlay.position(position)

Mga parameter

PangalanPaglalarawan
positionPoint | tuple[Number, Number]
New position.
Kailangan · Ayon sa posisyon o pangalan
Walang default

Ibinabalik na halaga

OverlayText — Ibinabalik ang parehong tagabuo ng overlay na teksto.

Pagkilos / epekto

I-update ang posisyon ng draw gamit ang Point o tuple/list (x, y). Ang punto ay nagdadala ng sukat/anchor metadata.

Pagpapatakbo

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

Bawat flow ay may sariling overlay id; nililinis lang ng off_all() ang overlay ng flow na iyon. Ipinapadala sa Android Main ang gawain sa UI at maaaring maghintay ang caller. Panatilihin sa may-ari nitong flow ang nababagong overlay builder.

Halimbawa

# I-configure o suriin ang overlay na pag-aari ng flow na ito
badge = OverlayText("Ready", (24, 120))
badge.position((80, 160))
badge.show()

Mga error / limitasyon

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

Mga kaugnay na API

OverlayText.track

Method

I-configure ang pagsubaybay sa pakikipag-ugnayan.

Syntax

overlay.track(press=False, move=False, hold=False, hold_ms=600)

Mga parameter

PangalanPaglalarawan
pressBoolean
Track press/release state.
Opsyonal · Ayon sa posisyon o pangalan
Default: False
moveBoolean
Allow user drag to move text.
Opsyonal · Ayon sa posisyon o pangalan
Default: False
holdBoolean
Track hold state.
Opsyonal · Ayon sa posisyon o pangalan
Default: False
hold_msNumber
Hold threshold to treat interaction as holding, measured in milliseconds.
Opsyonal · Ayon sa posisyon o pangalan
Default: 600

Ibinabalik na halaga

OverlayText — Ibinabalik ang parehong tagabuo ng overlay na teksto.

Pagkilos / epekto

I-configure ang pagsubaybay sa pakikipag-ugnayan. Kung ang lahat ng mga flag ay Mali, ang teksto ay mananatiling maayos sa ipinahayag na posisyon.

Pagpapatakbo

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

Bawat flow ay may sariling overlay id; nililinis lang ng off_all() ang overlay ng flow na iyon. Ipinapadala sa Android Main ang gawain sa UI at maaaring maghintay ang caller. Panatilihin sa may-ari nitong flow ang nababagong overlay builder.

Halimbawa

# I-configure o suriin ang overlay na pag-aari ng flow na ito
badge = OverlayText("Ready", (24, 120))
badge.track(press=True, move=True, hold=True, hold_ms=700)
badge.show()
print(badge.state())

Mga error / limitasyon

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

Mga kaugnay na API

OverlayText.get_point

Method

Kunin ang kasalukuyang tuktok na kaliwang punto ng overlay na text na ito.

Syntax

overlay.get_point()

Mga parameter

Wala

Ibinabalik na halaga

Point — Kasalukuyang posisyon ng overlay sa mga pixel ng screen.

Pagkilos / epekto

Kunin ang kasalukuyang tuktok na kaliwang punto ng overlay na text na ito. Ina-update ang posisyong ito pagkatapos ng mga galaw ng drag.

Pagpapatakbo

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

Bawat flow ay may sariling overlay id; nililinis lang ng off_all() ang overlay ng flow na iyon. Ipinapadala sa Android Main ang gawain sa UI at maaaring maghintay ang caller. Panatilihin sa may-ari nitong flow ang nababagong overlay builder.

Halimbawa

# I-configure o suriin ang overlay na pag-aari ng flow na ito
badge = OverlayText("Ready", (24, 120))
badge.show()
point = badge.get_point()
print(point.x, point.y)

Mga error / limitasyon

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

Mga kaugnay na API

OverlayText.get_region

Method

Kumuha ng rehiyon na bumabalot sa kasalukuyang mga hangganan ng overlay na text.

Syntax

overlay.get_region()

Mga parameter

Wala

Ibinabalik na halaga

Region? — Bounding region para sa overlay na text, o Wala. Palaging suriin ang Wala bago gamitin ang rehiyon.

Pagkilos / epekto

Kumuha ng rehiyon na bumabalot sa kasalukuyang mga hangganan ng overlay na text. Nagbabalik ng Wala kapag ang overlay ay hindi nakikita o hindi pa nasusukat.

Pagpapatakbo

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

Bawat flow ay may sariling overlay id; nililinis lang ng off_all() ang overlay ng flow na iyon. Ipinapadala sa Android Main ang gawain sa UI at maaaring maghintay ang caller. Panatilihin sa may-ari nitong flow ang nababagong overlay builder.

Halimbawa

# I-configure o suriin ang overlay na pag-aari ng flow na ito
badge = OverlayText("Ready", (24, 120))
badge.show()
bounds = badge.get_region()
if bounds is not None:
    print(bounds.width, bounds.height)

Mga error / limitasyon

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

Mga kaugnay na API

OverlayText.show

Method

Ipakita ang overlay ng teksto (o ipakita muli pagkatapos itago()).

Syntax

overlay.show()

Mga parameter

Wala

Ibinabalik na halaga

dict — Kasalukuyang overlay state dictionary.

Pagkilos / epekto

Ipakita ang overlay ng teksto (o ipakita muli pagkatapos itago()).

Pagpapatakbo

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

Bawat flow ay may sariling overlay id; nililinis lang ng off_all() ang overlay ng flow na iyon. Ipinapadala sa Android Main ang gawain sa UI at maaaring maghintay ang caller. Panatilihin sa may-ari nitong flow ang nababagong overlay builder.

Halimbawa

# I-configure o suriin ang overlay na pag-aari ng flow na ito
badge = OverlayText("Ready", (24, 120))
print(badge.show())

Mga error / limitasyon

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

Mga kaugnay na API

OverlayText.hide

Method

Itago ang overlay na text ngunit panatilihin ang naka-cache na view para sa mas mabilis na palabas().

Syntax

overlay.hide()

Mga parameter

Wala

Ibinabalik na halaga

dict — Kasalukuyang overlay state dictionary.

Pagkilos / epekto

Itago ang overlay na text ngunit panatilihin ang naka-cache na view para sa mas mabilis na palabas().

Pagpapatakbo

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

Bawat flow ay may sariling overlay id; nililinis lang ng off_all() ang overlay ng flow na iyon. Ipinapadala sa Android Main ang gawain sa UI at maaaring maghintay ang caller. Panatilihin sa may-ari nitong flow ang nababagong overlay builder.

Halimbawa

# I-configure o suriin ang overlay na pag-aari ng flow na ito
badge = OverlayText("Ready", (24, 120))
badge.show()
badge.hide()
badge.show()

Mga error / limitasyon

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

Mga kaugnay na API

OverlayText.off

Method

Turn off overlay text and release resources.

Syntax

overlay.off()

Mga parameter

Wala

Ibinabalik na halaga

dict — Kasalukuyang overlay state dictionary.

Pagkilos / epekto

Turn off overlay text and release resources.

Pagpapatakbo

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

Bawat flow ay may sariling overlay id; nililinis lang ng off_all() ang overlay ng flow na iyon. Ipinapadala sa Android Main ang gawain sa UI at maaaring maghintay ang caller. Panatilihin sa may-ari nitong flow ang nababagong overlay builder.

Halimbawa

# I-configure o suriin ang overlay na pag-aari ng flow na ito
badge = OverlayText("Ready", (24, 120))
badge.show()
print(badge.off())

Mga error / limitasyon

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

Mga kaugnay na API

OverlayText.state

Method

Ibalik ang kasalukuyang estado ng pakikipag-ugnayan.

Syntax

overlay.state()

Mga parameter

Wala

Ibinabalik na halaga

dict — Diksyonaryo ng estado na may status/status_label, mga flag sa pagsubaybay, at opsyonal na lapad/taas ng overlay sa mga pixel.

Pagkilos / epekto

Ibalik ang kasalukuyang estado ng pakikipag-ugnayan. Mapa ng katayuan: 0=IDLE, 1=PIINIS, 2=GUMILOS, 3=HAWAK, 4=BINIWALA, 5=NATAGO, 6=OFF. Ang pagbabasa ng state() ay awtomatikong nagre-reset ng PRESED at INILABAS pabalik sa IDLE para sa susunod na poll; Ang MOVING at HOLDING ay hindi auto-reset.

Pagpapatakbo

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

Bawat flow ay may sariling overlay id; nililinis lang ng off_all() ang overlay ng flow na iyon. Ipinapadala sa Android Main ang gawain sa UI at maaaring maghintay ang caller. Panatilihin sa may-ari nitong flow ang nababagong overlay builder.

Halimbawa

# I-configure o suriin ang overlay na pag-aari ng flow na ito
badge = OverlayText("Ready", (24, 120))
badge.track(press=True, move=True)
badge.show()
state = badge.state()
print(state["status_label"])

Mga error / limitasyon

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

Mga kaugnay na API