Runtime v2.81 · Diperbarui 30 Sep 2026

OverlayText

Class

Gambar teks di atas layar dengan pelacakan interaksi opsional (tekan/pindahkan/tahan).

Sintaks

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

Parameter konstruktor

Nama	Deskripsi
`textString`	Initial text content. Opsional · Posisi atau nama Default: `""`
`positionPoint \| tuple[Number, Number]`	Initial position as Point or tuple/list (x, y). Point carries scale/anchor metadata. Opsional · Posisi atau nama Default: `(0, 0)`
`colorColor \| String \| Number`	Initial text color. Opsional · Posisi atau nama Default: `white`
`sizeNumber`	Initial text size (sp). Opsional · Posisi atau nama Default: `16`
`backgroundColor \| String \| Number \| None`	Initial background color. None means transparent/no background. Opsional · Posisi atau nama Default: `None`

Nilai yang dikembalikan

OverlayText

Perilaku / efek samping

Gambar teks di atas layar dengan pelacakan interaksi opsional (tekan/pindahkan/tahan). Nama penyetel seperti teks/latar belakang adalah metode; membaca nilai saat ini melalui state().

Eksekusi

Menunggu selesai: Bersyarat
Keamanan akses bersamaan: Gunakan objek terpisah di tiap alur
Eksekusi paralel: Bersyarat

Setiap alur memiliki id overlay sendiri; off_all() hanya melepas overlay alur tersebut. Pekerjaan UI dikirim ke Android Main dan dapat menangguhkan pemanggil. Simpan builder overlay yang dapat berubah dalam alur pemiliknya.

Contoh

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()   # sembunyikan cepat
badge.show()   # tampilkan lagi dengan cepat
badge.off()    # lepas sepenuhnya

Kesalahan / batasan

Tidak ada batasan tambahan yang didokumentasikan; ikuti kontrak parameter dan perilaku di atas.

API terkait

Field

Nama	Deskripsi
`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`

Contoh konstruktor

badge = OverlayText("Ready", Point(420, 220, scale="width", anchor="top"), background=None)

Metode

13 metode

OverlayText.off_all

Static Method

Matikan dan lepaskan semua teks overlay yang dibuat alur saat ini, tanpa memengaruhi alur yang berjalan paralel.

Sintaks

OverlayText.off_all()

Parameter

Tidak ada

Nilai yang dikembalikan

None — Tidak ada nilai kembalian.

Perilaku / efek samping

Matikan dan lepaskan semua teks overlay yang dibuat alur saat ini, tanpa memengaruhi alur yang berjalan paralel.

Eksekusi

Menunggu selesai: Bersyarat
Keamanan akses bersamaan: Gunakan objek terpisah di tiap alur
Eksekusi paralel: Bersyarat

Contoh

# Lepaskan overlay yang dimiliki alur ini
a = OverlayText("Running", (24, 120))
a.show()
OverlayText.off_all()

Kesalahan / batasan

Tidak ada batasan tambahan yang didokumentasikan; ikuti kontrak parameter dan perilaku di atas.

API terkait

OverlayText.text

Method

Perbarui konten teks yang ditampilkan.

Sintaks

overlay.text(value)

Parameter

Nama	Deskripsi
`valueString`	Text content. Wajib · Posisi atau nama Tanpa nilai bawaan

Nilai yang dikembalikan

OverlayText — Mengembalikan pembuat teks overlay yang sama.

Perilaku / efek samping

Perbarui konten teks yang ditampilkan.

Eksekusi

Menunggu selesai: Bersyarat
Keamanan akses bersamaan: Gunakan objek terpisah di tiap alur
Eksekusi paralel: Bersyarat

Contoh

# Atur atau periksa overlay milik alur ini
badge = OverlayText("Ready", (24, 120))
badge.text("Running")
badge.show()

Kesalahan / batasan

Tidak ada batasan tambahan yang didokumentasikan; ikuti kontrak parameter dan perilaku di atas.

API terkait

OverlayText.color

Method

Perbarui warna teks.

Sintaks

overlay.color(value)

Parameter

Nama	Deskripsi
`valueColor \| String \| Number`	Color value. Wajib · Posisi atau nama Tanpa nilai bawaan

Nilai yang dikembalikan

OverlayText — Mengembalikan pembuat teks overlay yang sama.

Perilaku / efek samping

Perbarui warna teks.

Eksekusi

Menunggu selesai: Bersyarat
Keamanan akses bersamaan: Gunakan objek terpisah di tiap alur
Eksekusi paralel: Bersyarat

Contoh

# Atur atau periksa overlay milik alur ini
badge = OverlayText("Ready", (24, 120))
badge.color("#FF00E676")
badge.show()

Kesalahan / batasan

Tidak ada batasan tambahan yang didokumentasikan; ikuti kontrak parameter dan perilaku di atas.

API terkait

OverlayText.background

Method

Perbarui warna latar belakang.

Sintaks

overlay.background(value=None)

Parameter

Nama	Deskripsi
`valueColor \| String \| Number \| None`	Background color, or None for transparent/no background. Opsional · Posisi atau nama Default: `None`

Nilai yang dikembalikan

OverlayText — Mengembalikan pembuat teks overlay yang sama.

Perilaku / efek samping

Perbarui warna latar belakang. Melewati Tidak Ada menghapus latar belakang.

Eksekusi

Menunggu selesai: Bersyarat
Keamanan akses bersamaan: Gunakan objek terpisah di tiap alur
Eksekusi paralel: Bersyarat

Contoh

# Atur atau periksa overlay milik alur ini
badge = OverlayText("Ready", (24, 120))
badge.background("#66000000")
badge.show()
badge.background(None)

Kesalahan / batasan

Tidak ada batasan tambahan yang didokumentasikan; ikuti kontrak parameter dan perilaku di atas.

API terkait

OverlayText.size

Method

Perbarui ukuran teks (sp).

Sintaks

overlay.size(sp)

Parameter

Nama	Deskripsi
`spNumber`	Text size in sp. Wajib · Posisi atau nama Tanpa nilai bawaan

Nilai yang dikembalikan

OverlayText — Mengembalikan pembuat teks overlay yang sama.

Perilaku / efek samping

Perbarui ukuran teks (sp).

Eksekusi

Menunggu selesai: Bersyarat
Keamanan akses bersamaan: Gunakan objek terpisah di tiap alur
Eksekusi paralel: Bersyarat

Contoh

# Atur atau periksa overlay milik alur ini
badge = OverlayText("Ready", (24, 120))
badge.size(20)
badge.show()

Kesalahan / batasan

Tidak ada batasan tambahan yang didokumentasikan; ikuti kontrak parameter dan perilaku di atas.

API terkait

OverlayText.position

Method

Perbarui posisi undian dengan Point atau tuple/list (x, y).

Sintaks

overlay.position(position)

Parameter

Nama	Deskripsi
`positionPoint \| tuple[Number, Number]`	New position. Wajib · Posisi atau nama Tanpa nilai bawaan

Nilai yang dikembalikan

OverlayText — Mengembalikan pembuat teks overlay yang sama.

Perilaku / efek samping

Perbarui posisi undian dengan Point atau tuple/list (x, y). Titik membawa metadata skala/jangkar.

Eksekusi

Menunggu selesai: Bersyarat
Keamanan akses bersamaan: Gunakan objek terpisah di tiap alur
Eksekusi paralel: Bersyarat

Contoh

# Atur atau periksa overlay milik alur ini
badge = OverlayText("Ready", (24, 120))
badge.position((80, 160))
badge.show()

Kesalahan / batasan

Tidak ada batasan tambahan yang didokumentasikan; ikuti kontrak parameter dan perilaku di atas.

API terkait

OverlayText.track

Method

Konfigurasikan pelacakan interaksi.

Sintaks

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

Parameter

Nama	Deskripsi
`pressBoolean`	Track press/release state. Opsional · Posisi atau nama Default: `False`
`moveBoolean`	Allow user drag to move text. Opsional · Posisi atau nama Default: `False`
`holdBoolean`	Track hold state. Opsional · Posisi atau nama Default: `False`
`hold_msNumber`	Hold threshold to treat interaction as holding, measured in milliseconds. Opsional · Posisi atau nama Default: `600`

Nilai yang dikembalikan

OverlayText — Mengembalikan pembuat teks overlay yang sama.

Perilaku / efek samping

Konfigurasikan pelacakan interaksi. Jika semua tandanya Salah, teks tetap pada posisi yang dinyatakan.

Eksekusi

Menunggu selesai: Bersyarat
Keamanan akses bersamaan: Gunakan objek terpisah di tiap alur
Eksekusi paralel: Bersyarat

Contoh

# Atur atau periksa overlay milik alur ini
badge = OverlayText("Ready", (24, 120))
badge.track(press=True, move=True, hold=True, hold_ms=700)
badge.show()
print(badge.state())

Kesalahan / batasan

Tidak ada batasan tambahan yang didokumentasikan; ikuti kontrak parameter dan perilaku di atas.

API terkait

OverlayText.get_point

Method

Dapatkan titik kiri atas teks overlay ini.

Sintaks

overlay.get_point()

Parameter

Tidak ada

Nilai yang dikembalikan

Point — Posisi overlay saat ini dalam piksel layar.

Perilaku / efek samping

Dapatkan titik kiri atas teks overlay ini. Posisi ini diperbarui setelah drag bergerak.

Eksekusi

Menunggu selesai: Bersyarat
Keamanan akses bersamaan: Gunakan objek terpisah di tiap alur
Eksekusi paralel: Bersyarat

Contoh

# Atur atau periksa overlay milik alur ini
badge = OverlayText("Ready", (24, 120))
badge.show()
point = badge.get_point()
print(point.x, point.y)

Kesalahan / batasan

Tidak ada batasan tambahan yang didokumentasikan; ikuti kontrak parameter dan perilaku di atas.

API terkait

OverlayText.get_region

Method

Dapatkan wilayah yang membungkus batas teks hamparan saat ini.

Sintaks

overlay.get_region()

Parameter

Tidak ada

Nilai yang dikembalikan

Region? — Wilayah pembatas untuk teks overlay, atau Tidak Ada. Selalu periksa Tidak Ada sebelum menggunakan wilayah tersebut.

Perilaku / efek samping

Dapatkan wilayah yang membungkus batas teks hamparan saat ini. Mengembalikan Tidak Ada bila overlay belum terlihat atau belum diukur.

Eksekusi

Menunggu selesai: Bersyarat
Keamanan akses bersamaan: Gunakan objek terpisah di tiap alur
Eksekusi paralel: Bersyarat

Contoh

# Atur atau periksa overlay milik alur ini
badge = OverlayText("Ready", (24, 120))
badge.show()
bounds = badge.get_region()
if bounds is not None:
    print(bounds.width, bounds.height)

Kesalahan / batasan

Tidak ada batasan tambahan yang didokumentasikan; ikuti kontrak parameter dan perilaku di atas.

API terkait

OverlayText.show

Method

Tampilkan hamparan teks (atau tampilkan lagi setelah sembunyikan()).

Sintaks

overlay.show()

Parameter

Tidak ada

Nilai yang dikembalikan

dict — Kamus status overlay saat ini.

Perilaku / efek samping

Tampilkan hamparan teks (atau tampilkan lagi setelah sembunyikan()).

Eksekusi

Menunggu selesai: Bersyarat
Keamanan akses bersamaan: Gunakan objek terpisah di tiap alur
Eksekusi paralel: Bersyarat

Contoh

# Atur atau periksa overlay milik alur ini
badge = OverlayText("Ready", (24, 120))
print(badge.show())

Kesalahan / batasan

Tidak ada batasan tambahan yang didokumentasikan; ikuti kontrak parameter dan perilaku di atas.

API terkait

OverlayText.hide

Method

Sembunyikan teks overlay tetapi pertahankan tampilan cache untuk pertunjukan yang lebih cepat().

Sintaks

overlay.hide()

Parameter

Tidak ada

Nilai yang dikembalikan

dict — Kamus status overlay saat ini.

Perilaku / efek samping

Sembunyikan teks overlay tetapi pertahankan tampilan cache untuk pertunjukan yang lebih cepat().

Eksekusi

Menunggu selesai: Bersyarat
Keamanan akses bersamaan: Gunakan objek terpisah di tiap alur
Eksekusi paralel: Bersyarat

Contoh

# Atur atau periksa overlay milik alur ini
badge = OverlayText("Ready", (24, 120))
badge.show()
badge.hide()
badge.show()

Kesalahan / batasan

Tidak ada batasan tambahan yang didokumentasikan; ikuti kontrak parameter dan perilaku di atas.

API terkait

OverlayText.off

Method

Matikan teks overlay dan lepaskan sumber daya.

Sintaks

overlay.off()

Parameter

Tidak ada

Nilai yang dikembalikan

dict — Kamus status overlay saat ini.

Perilaku / efek samping

Matikan teks overlay dan lepaskan sumber daya.

Eksekusi

Menunggu selesai: Bersyarat
Keamanan akses bersamaan: Gunakan objek terpisah di tiap alur
Eksekusi paralel: Bersyarat

Contoh

# Atur atau periksa overlay milik alur ini
badge = OverlayText("Ready", (24, 120))
badge.show()
print(badge.off())

Kesalahan / batasan

Tidak ada batasan tambahan yang didokumentasikan; ikuti kontrak parameter dan perilaku di atas.

API terkait

OverlayText.state

Method

Kembalikan status interaksi saat ini.

Sintaks

overlay.state()

Parameter

Tidak ada

Nilai yang dikembalikan

dict — Kamus nyatakan dengan status/status_label, tanda pelacakan, dan lebar/tinggi hamparan opsional dalam piksel.

Perilaku / efek samping

Kembalikan status interaksi saat ini. Peta status: 0=IDLE, 1=DITEKAN, 2=BERGERAK, 3=Tahan, 4=LEPAS, 5=TERSEMBUNYI, 6=MATI. Membaca state() auto-reset DITEKAN dan DIBEBASkan kembali ke IDLE untuk polling berikutnya; PINDAHKAN dan TAHAN tidak diatur ulang secara otomatis.

Eksekusi

Menunggu selesai: Bersyarat
Keamanan akses bersamaan: Gunakan objek terpisah di tiap alur
Eksekusi paralel: Bersyarat

Contoh

# Atur atau periksa overlay milik alur ini
badge = OverlayText("Ready", (24, 120))
badge.track(press=True, move=True)
badge.show()
state = badge.state()
print(state["status_label"])

Kesalahan / batasan

Tidak ada batasan tambahan yang didokumentasikan; ikuti kontrak parameter dan perilaku di atas.