Mengembalikan objek `Datatype.OverlapParams` kosong. Tidak seperti konstruktor tipe data
lainnya, konstruktor ini tidak memiliki parameter, jadi Anda harus
mengatur propertinya dengan benar.

OverlapParams.new

Mengembalikan objek `Datatype.OverlapParams` kosong.

Tipe data `Datatype.OverlapParams` menyimpan parameter untuk digunakan dengan
fungsi kueri batas `Class.WorldRoot`, khususnya
`Class.WorldRoot:GetPartBoundsInBox()`,
`Class.WorldRoot:GetPartBoundsInRadius()`, dan
`Class.WorldRoot:GetPartsInPart()`. Properti
`Datatype.OverlapParams.ExcludeInstances|ExcludeInstances` dan
`Datatype.OverlapParams.IncludeInstances|IncludeInstances` menyimpan
sekumpulan objek dan keturunannya yang akan dikecualikan dan disertakan dari
kueri. Properti `Datatype.OverlapParams.CollisionGroup` dapat menentukan
sekelompok tabrakan untuk operasi kueri batas.

Berbeda dengan sebagian besar tipe data di Luau, Anda dapat mengubah semua anggota
`Datatype.OverlapParams` tanpa membuat objek baru, memungkinkan Anda untuk menggunakan
objek yang sama berulang kali.

Menambahkan instansi yang diberikan ke
`Datatype.OverlapParams.FilterDescendantsInstances|FilterDescendantsInstances`.
Perlu dicatat bahwa properti ini telah digantikan oleh
`Datatype.OverlapParams.ExcludeInstances|ExcludeInstances` dan
`Datatype.OverlapParams.IncludeInstances|IncludeInstances` yang harus
 digunakan untuk pekerjaan baru.


OverlapParams:AddToFilter

instances

Sebuah instance atau array yang berisi instance untuk ditambahkan.

Menambahkan instance yang disediakan ke
`Datatype.OverlapParams.FilterDescendantsInstances|FilterDescendantsInstances`.

OverlapParams

Array opsional dari instansi yang keturunannya akan dikecualikan dari
query. Properti ini dapat digunakan secara bersamaan dengan
`Datatype.OverlapParams.IncludeInstances|IncludeInstances` untuk memungkinkan
pemfilteran campuran, misalnya termasuk folder besar tetapi mengecualikan
instansi anak tertentu. Jika sebuah instansi cocok dengan filter
kecualikan dan sertakan, pengecualian memiliki prioritas atas inklusi.


OverlapParams.ExcludeInstances

Array opsional dari instance yang keturunannya akan dikecualikan dari kueri.

Array opsional dari instansi yang keturunannya akan disertakan dalam
query. Properti ini dapat digunakan secara bersamaan dengan
`Datatype.OverlapParams.ExcludeInstances|ExcludeInstances` untuk memungkinkan
pemfilteran campuran. Jika sebuah instansi cocok dengan filter
kecualikan dan sertakan, pengecualian memiliki prioritas atas inklusi.

Mengatur `IncludeInstances` ke `nil` versus array kosong (`{}`) memiliki
efek yang berlawanan. `IncludeInstances = nil` adalah filter yang paling
permissif (memasukkan segalanya), sedangkan `IncludeInstances = {}` adalah
filter yang paling restriktif (tidak memasukkan apa pun).


OverlapParams.IncludeInstances

Array opsional dari instance yang keturunannya akan disertakan dalam kueri.

Jumlah maksimum bagian yang akan dikembalikan oleh kueri. Nilai default
nol (`0`) berarti tidak ada batas.

OverlapParams.MaxParts

Jumlah maksimum bagian yang akan dikembalikan oleh kueri.

Menentukan grup tabrakan untuk operasi. Bagian dalam grup tabrakan
yang disetel untuk **tidak** bertabrakan dengan grup ini diabaikan. Jika
properti ini dihilangkan, operasi mengasumsikan grup tabrakan **Default**.

OverlapParams.CollisionGroup

Grup tabrakan yang digunakan untuk operasi.

Sedikit meningkatkan volume dari operasi kueri batas, dibatasi
antara `0` dan `0.05` stud.

OverlapParams.Tolerance

Sedikit meningkatkan volume dari operasi kueri batas.

Properti ini, jika `true`, membuat operasi kueri batas menggunakan
nilai `Class.BasePart.CanCollide` bagian yang dipotong demi nilai
`Class.BasePart.CanQuery`-nya saat menentukan apakah bagian tersebut disertakan dalam
array hasil kueri spasial.

OverlapParams.RespectCanCollide

Menentukan apakah operasi kueri batas mempertimbangkan nilai properti
`Class.BasePart.CanCollide` bagian dibandingkan dengan nilai
`Class.BasePart.CanQuery`-nya.

Ketika diaktifkan, kueri akan mengabaikan semua properti tabrakan bagian dan
melakukan pemeriksaan paksa pada setiap bagian. Ini akan berdampak negatif pada
kinerja dan tidak boleh digunakan dalam pengalaman langsung.

OverlapParams.BruteForceAllSlow

Ketika diaktifkan, kueri akan mengabaikan semua properti tabrakan bagian dan
melakukan pemeriksaan paksa pada setiap bagian.

Array objek yang keturunannya digunakan dalam memfilter kandidat.
Perlu dicatat bahwa properti ini telah digantikan oleh
`Datatype.OverlapParams.ExcludeInstances|ExcludeInstances` dan
`Datatype.OverlapParams.IncludeInstances|IncludeInstances` yang harus
 digunakan untuk pekerjaan baru.


OverlapParams.FilterDescendantsInstances

Array objek yang keturunannya digunakan dalam penyaringan kandidat.

Menentukan apakah
`Datatype.OverlapParams.FilterDescendantsInstances|FilterDescendantsInstances`
array digunakan sebagai daftar pengecualian atau inklusi. Perlu dicatat
bahwa properti ini telah digantikan oleh
`Datatype.OverlapParams.ExcludeInstances|ExcludeInstances` dan
`Datatype.OverlapParams.IncludeInstances|IncludeInstances` yang harus
 digunakan untuk pekerjaan baru.


OverlapParams.FilterType

Menentukan apakah array
`Datatype.OverlapParams.FilterDescendantsInstances|FilterDescendantsInstances`
digunakan sebagai daftar pengecualian atau penyertaan.

Menyimpan parameter yang digunakan dalam fungsi kueri batas.

/reference/engine/datatypes/OverlapParams.yaml

Luau

{any}

Data Type

Instance

Sebuah objek yang menjalankan fungsi terkait saat terjadinya suatu kejadian.

RBXScriptSignal

Digunakan dalam objek `Datatype.RaycastParams` untuk menentukan bagaimana  daftar `Datatype.RaycastParams.FilterDescendantsInstances|FilterDescendantsInstances`  akan digunakan.

Enum

Enum.RaycastFilterType

Tipe data yang memiliki nilai benar atau salah.

boolean

number

Sekuens karakter, seperti huruf, angka, dan simbol.

string

Pengalaman Virtual

Avatar

Aset

Sampel dan proyek

Engine API

Open Cloud API

Studio

Analitik

Platform

Tutorial

Program kreator

Edukasi

Kursus

Pelajari

Metode ini tidak sinkron dan menghasilkan sebuah `Operasi`, yang mewakili keadaan operasi saat ini. Operasi tersebut berisi jalur endpoint yang dapat Anda pantau untuk memperoleh respons aktual dan metadata yang relevan. Lihat [dokumentasi]({longRunningOperationsLink}) tentang operasi jangka panjang untuk mengetahui informasi selengkapnya.
            
Bagian berikut menjelaskan objek respons dan metadata yang disediakan saat operasi selesai.

Endpoint beta siap digunakan publik. Perubahan yang menyebabkan kerusakan mungkin terjadi tetapi jarang.

Halaman dokumentasi Open Cloud ini akan dihapus pada 31 Maret 2026. Kamu akan otomatis dialihkan ke dokumentasi Open Cloud yang baru pada saat itu. {linkStart}Pelajari selengkapnya{linkEnd}

Halaman Open Cloud lama ini akan dihapus dan dialihkan pada 31 Maret 2026. {linkStart}Pelajari selengkapnya{linkEnd}

Endpoint eksperimental siap digunakan publik, tetapi mungkin terkadang mengalami perubahan yang menyebabkan kerusakan saat kontrak API diselesaikan.

Endpoint ini dapat dipanggil dalam pengalaman virtual melalui {httpServiceLinkStart}HttpService{httpServiceLinkEnd} dengan kunci API.

Kolom ini mungkin akan muncul saat resource dibuat, tetapi mungkin tidak akan diubah oleh permintaan berikutnya.

Kolom ini boleh diisi saat pembuataan resource, tetapi tidak boleh diubah melalui permintaan berikutnya.

Kolom ini mungkin akan disediakan di permintaan, tetapi tidak akan pernah disertakan di respons.

Metode autentikasi versi lama. Sebaiknya selalu gunakan Kunci API atau OAuth 2.0 jika tersedia.

Per Kunci API: {maxInPeriod} permintaan setiap {periodInSeconds} detik per Alamat IP

Tidak memerlukan autentikasi untuk memanggil. Biasanya memiliki batas rate yang jauh lebih rendah. Sebaiknya selalu gunakan Kunci API atau OAuth 2.0 jika tersedia.

Untuk setiap pengelompokan, hanya satu dari bidang berikut dalam skema yang harus disediakan. Sisanya dapat dikecualikan.

Kamu bisa memilih bergabung kembali kapan saja. {linkStart}Berikan masukan.{linkEnd}

Kamu sedang melihat dokumen lama. {linkStart}Berikan masukan.{linkEnd}

Kamu bisa memilih untuk keluar kapan saja dan akan diarahkan kembali ke halaman referensi sebelumnya. {linkStart}Berikan masukan.{linkEnd}

Kamu sedang melihat dokumen yang baru. {linkStart}Berikan masukan.{linkEnd}

Kolom ini mungkin akan muncul di respons, tetapi akan diabaikan di permintaan.

Catatan: Batas permintaan dapat lebih rendah selama periode traffic yang tinggi. Beberapa endpoint memiliki batas permintaan tambahan. [Pelajari selengkapnya tentang batas permintaan]({link}).

{limit} permintaan per hari di semua kunci API untuk pengguna atau grup

{limit} permintaan per jam di semua kunci API untuk pengguna atau grup

{limit} permintaan per menit di semua kunci API untuk pengguna atau grup

{limit} permintaan per detik di semua kunci API untuk pengguna atau grup

{limit} permintaan per menit per pemilik kunci API

{limit} permintaan per hari per pengguna aplikasi

{limit} permintaan per jam per pengguna aplikasi

{limit} permintaan per menit per pengguna aplikasi

{limit} permintaan per detik per pengguna aplikasi

{limit} permintaan per detik per pemilik kunci API

Beberapa cakupan mengontrol izin yang dimiliki kredensialmu. Kredensialmu hanya dapat mengakses endpoint yang sesuai dengan cakupan yang kamu pilih.

Endpoint yang stabil siap digunakan dalam produksi dan hampir tidak akan mengalami perubahan yang menyebabkan kerusakan selama masa pakainya.

Target ini memungkinkanmu membatasi akses pentingmu ke {requiredParts} yang dipilih

Target ini memungkinkanmu membatasi akses pentingmu ke {requiredParts} dan {optionalParts} yang dipilih

Tipe target digunakan untuk membatasi sumber daya yang bisa diakses oleh kredensialmu. Sekalipun izin akunmu lebih luas, hanya sumber daya yang dipilih yang dapat dipakai. Beberapa cakupan tidak memiliki bagian target. Dalam kasus ini, semua sumber dayamu yang relevan bisa langsung dipakai.

Bagian Tingkat Atas universe tidak perlu dipilih untuk Kunci API milik pengguna. Dalam hal ini, Kunci API-mu akan memiliki akses ke semua pengalaman virtual milikmu sendiri dan pengalaman virtual milik grup yang izin aksesnya kamu kantongi.

Coba Saja belum didukung untuk endpoint yang mewajibkan kunci API atau autentikasi OAuth 2.0

Autentikasi cookie dinonaktifkan untuk operasi berisiko tinggi demi keamanan.

Endpoint berisiko kritis sangat sensitif dan fungsi Coba Saja dinonaktifkan demi keamanan

Catatan: Header autentikasi tidak termasuk dalam sampel kode ini. Kamu mungkin perlu menambahkan header autentikasi agar perintah ini berfungsi.

Ini adalah endpoint berisiko tinggi yang dapat mengubah atau menghapus data penting. Gunakan dengan sangat hati-hati selama pengujian.

Endpoint API ini telah diklasifikasikan sebagai BERISIKO TINGGI dan dapat memengaruhi data aktif atau akun pengguna.

Permintaan yang diautentikasi ke API berisiko tinggi dapat membuat perubahan yang tidak dapat dibatalkan. Review parameter permintaanmu sebelum melanjutkan.

Login untuk menggunakan autentikasi cookie

Ini adalah endpoint berisiko rendah yang mengambil data. Ini umumnya aman untuk diuji.

Ini adalah endpoint berisiko sedang yang memodifikasi data. Uji dengan hati-hati menggunakan akun non-penting, karena perubahan mungkin bersifat permanen.

Untuk menjaga keamanan akun kamu, jangan pernah menempelkan teks dari sumber lain di sini atau mengirimkan informasi dari halaman ini kepada orang lain.

Kamu akan menguji endpoint API live menggunakan kredensial akunmu yang sebenarnya.

Hanya lanjutkan jika kamu memahami implikasi dari panggilan API yang akan kamu lakukan. Review dokumentasi API dengan cermat sebelum pengujian.

Panggilan API akan dilakukan menggunakan sesi kamu yang sudah diautentikasi

Ini adalah panggilan API aktual yang dapat memengaruhi akun atau data kamu

Batas rating dan pembatasan API lainnya berlaku

Beberapa operasi dapat mengubah atau menghapus data

Endpoint ini telah digantikan oleh endpoint alternatif yang direkomendasikan berikut:

Cakupan berikut diperlukan untuk memanggil endpoint ini. Untuk mengetahui
informasi selengkapnya tentang cara membuat kunci yang tepat, lihat [Cara Mengelola Kunci API]({apiKeyReferenceDocLink}).

Untuk mengetahui informasi selengkapnya tentang cara membuat kunci, lihat [Cara Mengelola Kunci API]({apiKeyReferenceDocLink}).

Endpoint berikut tersedia di jalur relatif terhadap base URL.

String ini diformat sebagai [FieldMask](/cloud/reference/types#fieldmask).

Nilai JSON dapat berupa `null`, `boolean`, `string`, `number`, `array`, atau `object`.

Cakupan berikut diperlukan agar aplikasi OAuth 2.0 dapat menggunakan endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara mendaftarkan aplikasi OAuth 2.0, lihat [Pendaftaran dan review aplikasi]({oauth2ReferenceDocLink}).

Untuk mengetahui informasi selengkapnya tentang cara mendaftarkan aplikasi OAuth 2.0, lihat [Pendaftaran dan review aplikasi]({oauth2ReferenceDocLink}).

Objek berikut mendeskripsikan muatan yang diterima atau diberikan. Lihat masing-masing endpoint untuk mengetahui informasi selengkapnya tentang waktu penggunaan objek ini.

Cakupan berikut diperlukan untuk memanggil endpoint ini.

Jalur Resource

String ini diformat sebagai [Timestamp](/cloud/reference/types#timestamp).

Cakupan berikut diperlukan agar aplikasi OAuth 2.0 dapat menggunakan endpoint ini. Untuk mengetahui informasi selengkapnya tentang cara mendaftarkan aplikasi OAuth 2.0, lihat [Pendaftaran dan Review Aplikasi]({oauth2ReferenceDocLink}).

Tidak Direkomendasikan

Kamu sedang melihat referensi Open Cloud yang baru.

Kamu sudah memilih keluar dari referensi Open Cloud yang baru.

Buat, update, dan kelola kampanye iklanmu.

Ini memungkinkan untuk melihat informasi tentang asetmu.

Ini memungkinkan upload dan update aset ke Roblox.

Ini memungkinkanmu melihat izin aset untuk subjek (termasuk grup dan pengalaman virtual) dan aset yang dapat diakses oleh akunmu.

Ini memungkinkan pemberian izin aset kepada subjek mana pun (termasuk grup dan pengalaman) dan aset yang dapat diakses oleh akunmu.

Ini memungkinkanmu melihat status dan hasil tugas penyiapan otomatis avatar atas namamu.

Ini memungkinkanmu membuat dan mengelola tugas penyiapan otomatis avatar atas namamu.

Memberi kemampuan untuk meng-update lencana yang dimiliki oleh pengguna.

Ini memungkinkan untuk melihat informasi tentang item komersialmu.

Ini memungkinkan untuk membuat perubahan pada item komersialmu yang telah disinkronkan.

Ini memungkinkan kamu melihat informasi tentang koneksi merchant komersialmu.

Ini memungkinkan pengeditan koneksi merchant komersialmu.

Ini memungkinkan kamu melihat informasi tentang produk di Toko Kreatormu.

Ini memungkinkan kamu mengubah informasi tentang produk di Toko Kreatormu.

Ini memungkinkan kamu melihat informasi tentang penyimpanan produk di Toko Kreatormu.

Ini memungkinkan kamu mengubah informasi tentang penyimpanan produk di Toko Kreatormu.

Memberi akses untuk membuat penyimpanan data atas namamu.

Memberi akses untuk menghapus penyimpanan data atas namamu.

Memberi akses untuk membaca daftar penyimpanan data.

Memberi akses untuk mengambil snapshot penyimpanan datamu.

Memberi akses untuk membuat entri dalam penyimpanan datamu.

Memberi akses untuk menandai entri tertentu agar dihapus.

Memberi akses untuk membuat daftar entri penyimpanan datamu.

Memberi akses untuk membaca entri tertentu dalam penyimpanan datamu.

Memberi akses untuk meng-update nilai, atribut, dan pengguna suatu entri.

Memberi akses untuk menghapus revisi entri penyimpanan datamu.

Memberi akses untuk membuat daftar revisi entri penyimpanan datamu.

Memberi akses untuk melihat detail konfigurasi untuk produk developer pengguna yang diotorisasi.

Memberi akses untuk mengedit produk developer pengguna yang diotorisasi.

Ini memungkinkan untuk melihat informasi tentang lingkungan universe-mu.

Ini memungkinkan pengeditan lingkungan universe-mu.

Memberi akses untuk melihat detail konfigurasi untuk pas game pengguna yang diotorisasi.

Memberi akses untuk mengedit pas game pengguna yang diotorisasi.

Memberi akses untuk melihat informasi forum komunitas untuk akunmu.

Memberi akses untuk mengelola informasi forum komunitas untuk akunmu.

Ini memungkinkan untuk melihat informasi tentang komunitas kamu.

Dengan cara ini, kamu dapat mengelola permintaan bergabung ke komunitas dan perubahan peran anggota komunitas berperingkat rendah untuk akunmu.

Memungkinkan kamu untuk melihat data properti suatu kejadian.

Memungkinkan kamu mengubah data properti kejadian (saat ini hanya mendukung Script).

Ini memungkinkan untuk melihat informasi tentang inventarismu.

Memberi akses untuk mengelola aset penggunamu.

Memberi akses untuk mengelola lencanamu dan membelanjakan Robux.

Memberi akses untuk meng-update lencana pengguna yang diotorisasi.

Memberi akses untuk mengelola produk developermu.

Memberi akses untuk membaca informasi tentang notifikasi pengalaman virtualmu.

Memberi akses untuk mengaktifkan atau menonaktifkan notifikasi pengalaman virtual atas namamu.

Memberi akses untuk mengelola komunitasmu.

Memberi izin untuk membaca informasi komunitas.

Memberi akses untuk membaca dan menulis tabel pelokalanmu

Memberi akses untuk mengelola kolaborasi tim untuk semua pengalaman virtualmu.

Memberi akses untuk mengelola pengalaman virtualmu dan informasi tertentu terkait dengan pengalaman virtualmu (misal, informasi pelokalan).

Memberi akses untuk membaca informasi pelokalan pengalamanmu.

Memberi akses untuk mengubah preferensi pelokalan pengalamanmu.

Memberi akses untuk mengelola akun penggunamu.

Memberi akses untuk mengubah preferensi pelokalan pengguna.

Memungkinkan kamu untuk melihat status, log, dan hasil tugas eksekusi Luau untuk tempat terkait.

Memungkinkan kamu untuk membuat tugas eksekusi Luau baru untuk tempat terkait.

Memberi akses untuk melakukan flush secara asinkron pada semua struktur data di universe.

Memberi akses untuk membuat item antrean baru.

Memberi akses untuk membuang item baca dari bagian depan antrean.

Memberi akses untuk membaca item di bagian depan antrean.

Memberi akses untuk membaca item penyimpanan memori kamu.

Memberi akses untuk membuat, meng-update dan menghapus item peta.

Ini memberi kemampuan untuk memublikasikan pesan atas nama pengguna.

Ini memungkinkan pengiriman notifikasi dari pengalaman virtualmu ke pengguna.

(Tidak digunakan lagi) Memberi akses untuk membaca daftar entri dalam penyimpanan data terurut.

(Tidak digunakan lagi) Memberi akses untuk membuat entri baru dalam penyimpanan data terurut.

Memberi akses untuk membuat daftar entri dari penyimpanan data terurut.

Memberi akses untuk membuat entri dalam penyimpanan data terurut.

Ini memungkinkan pembuatan daftar rahasia yang terkait dengan pengalaman virtualmu.

Ini memungkinkan pembuatan dan update rahasia yang terkait dengan pengalaman virtualmu.

Izin ini memungkinkan kamu dapat mengirimkan tugas evaluasi dan melihat hasil tugas tersebut.

Memberi akses untuk membaca tentang produk langgananmu.

Ini memungkinkanmu membaca informasi thumbnail atas namamu.

Memberi kemampuan untuk membaca analitik game.

Memberi kemampuan untuk membaca informasi tempat.

Memberi kemampuan untuk mengedit informasi tempat.

Memberi akses untuk memublikasikan versi baru pengalaman virtual ke Roblox.

Memberi kemampuan untuk membaca informasi pengalaman virtual.

Memberi akses untuk mengedit pengalaman virtual pengguna yang diotorisasi.

Memungkinkanmu melihat batasan pengguna di pengalaman virtual.

Memungkinkan kamu mengedit batasan pengguna di pengalaman virtual.

Ini memungkinkanmu melihat notifikasi yang dikirim ke akunmu.

Memberi kemampuan untuk membaca status premium dan terverifikasi pengguna yang diotorisasi.

Ini memungkinkan kamu melihat akun sosial pengguna yang diotorisasi.

Ini mengaktifkan fungsionalitas Single Sign-On.

Ini memberi akses untuk membaca informasi profil kamu.