Returns a blank `Datatype.OverlapParams` object. Unlike other data type
constructors, this constructor does not have any parameters, so you should
set its properties appropriately.

OverlapParams.new

Returns a blank `Datatype.OverlapParams` object.

The `Datatype.OverlapParams` data type stores parameters for use with
`Class.WorldRoot` boundary-querying functions, in particular
`Class.WorldRoot:GetPartBoundsInBox()`,
`Class.WorldRoot:GetPartBoundsInRadius()` and
`Class.WorldRoot:GetPartsInPart()`. The
`Datatype.OverlapParams.ExcludeInstances|ExcludeInstances` and
`Datatype.OverlapParams.IncludeInstances|IncludeInstances` properties store a
set of objects and their descendants that will be excluded and included from
the query. The `Datatype.OverlapParams.CollisionGroup` property can specify a
collision group for the boundary query operation.

Unlike most data types in Luau, you can change all of the members of
`Datatype.OverlapParams` without creating a new object, allowing you to reuse
the same object repeatedly.


Adds the instances provided to
`Datatype.OverlapParams.FilterDescendantsInstances|FilterDescendantsInstances`.
Note that this property has been superseded by
`Datatype.OverlapParams.ExcludeInstances|ExcludeInstances` and
`Datatype.OverlapParams.IncludeInstances|IncludeInstances` which should be
used for new work.


OverlapParams:AddToFilter

instances

An instance or an array containing instances to add.


Adds the instances provided to
`Datatype.OverlapParams.FilterDescendantsInstances|FilterDescendantsInstances`.


OverlapParams

An optional array of instances whose descendants will be excluded from the
query. This property can be used simultaneously with
`Datatype.OverlapParams.IncludeInstances|IncludeInstances` to allow for
mixed filtering, for example including a large folder but excluding
specific child instances. If an instance matches both an exclude and
include filter, exclusions take priority over inclusions.


OverlapParams.ExcludeInstances

An optional array of instances whose descendants will be excluded from the
query.


An optional array of instances whose descendants will be included in the
query. This property can be used simultaneously with
`Datatype.OverlapParams.ExcludeInstances|ExcludeInstances` to allow for
mixed filtering. If an instance matches both an exclude and include
filter, exclusions take priority over inclusions.

Setting `IncludeInstances` to `nil` versus an empty array (`{}`) has
opposite effects. `IncludeInstances = nil` is the most permissive filter
(includes everything), whereas `IncludeInstances = {}` is the most
restrictive filter (includes nothing).


OverlapParams.IncludeInstances

An optional array of instances whose descendants will be included in the
query.


The maximum amount of parts to be returned by the query. The default value
of zero (`0`) represents no limit.


OverlapParams.MaxParts

The maximum amount of parts to be returned by the query.


Specifies a collision group for the operation. Parts in collision groups
that are set to **not** collide with this group are ignored. If this
property is omitted, the operation assumes the **Default** collision
group.


OverlapParams.CollisionGroup

The collision group used for the operation.


Slightly increases the volume of the boundary-querying operation, clamped
between `0` and `0.05` studs.


OverlapParams.Tolerance

Slightly increases the volume of the boundary-querying operation.


This property, if `true`, makes the boundary-querying operation use an
intersected part's `Class.BasePart.CanCollide` value in favor of its
`Class.BasePart.CanQuery` value when determining whether that part is
included in the array of spatial query results.


OverlapParams.RespectCanCollide

Determines whether the boundary-querying operation considers a part's
`Class.BasePart.CanCollide` property value over its
`Class.BasePart.CanQuery` value.


When enabled, the query will ignore all part collision properties and
perform a brute-force check on every part. This will negatively impact
performance and should not be used in live experiences.


OverlapParams.BruteForceAllSlow

When enabled, the query will ignore all part collision properties and
perform a brute-force check on every part.


An array of objects whose descendants are used in filtering candidates.
Note that this property has been superseded by
`Datatype.OverlapParams.ExcludeInstances|ExcludeInstances` and
`Datatype.OverlapParams.IncludeInstances|IncludeInstances` which should be
used for new work.


OverlapParams.FilterDescendantsInstances

An array of objects whose descendants are used in filtering candidates.


Determines whether the
`Datatype.OverlapParams.FilterDescendantsInstances|FilterDescendantsInstances`
array is used as an exclude or include list. Note that this property has
been superseded by
`Datatype.OverlapParams.ExcludeInstances|ExcludeInstances` and
`Datatype.OverlapParams.IncludeInstances|IncludeInstances` which should be
used for new work.


OverlapParams.FilterType

Determines whether the
`Datatype.OverlapParams.FilterDescendantsInstances|FilterDescendantsInstances`
array is used as an exclude or include list.


Stores parameters used in boundary-querying functions.


/reference/engine/datatypes/OverlapParams.yaml

Luau

{any}

Data Type

Instance

An object that runs connected functions upon a specific occurrence.

RBXScriptSignal

Used in a `Datatype.RaycastParams` object to determine how its `Datatype.RaycastParams.FilterDescendantsInstances|FilterDescendantsInstances` list will be used.

Enum

Enum.RaycastFilterType

Data type having a value of either true or false.

boolean

A double-precision floating-point number.

number

A sequence of characters, such as letters, numbers, and symbols.

string

Experiences

Avatar

Assets

Samples and projects

Engine API

Open Cloud API

Studio

Analytics

Platform

Tutorials

Creator programs

Education

Courses

Learn

This method is asynchronous and returns an `Operation`, which represents the current state of the operation. It contains an endpoint path that you can poll to obtain the real response and applicable metadata. See the [documentation]({longRunningOperationsLink}) on long-running operations for more information.
            
The following sections describe the response and metadata objects that are provided when an operation completes.

Beta endpoints are ready for public use. Breaking changes are possible but rare.

These Open Cloud documentation pages will be removed on March 31, 2026. You will be automatically redirected to the new Open Cloud documentation at that time. {linkStart}Learn more{linkEnd}

These old Open Cloud pages will be removed and redirected on March 31, 2026. {linkStart}Learn more{linkEnd}

Experimental endpoints are ready for public use, but may experience breaking changes occasionally as the API contract is finalized.

This endpoint can be called in-experience through {httpServiceLinkStart}HttpService{httpServiceLinkEnd} with an API key.

This field may be set when creating a resource, but may not be modified by subsequent requests.

These fields may be set when creating a resource, but may not be modified by subsequent requests.

This field may be provided in requests, but will never be included in responses.

Legacy authentication method. Always prefer using API Key or OAuth 2.0 when available.

Per API Key: {maxInPeriod} requests every {periodInSeconds} seconds per IP Address

Requires no authentication to call. Typically has significantly lowered rate limits. Always prefer using API Key or OAuth 2.0 when available.

For each grouping, only one of the following fields in the schema has to be provided, the remaining can be excluded.

You can opt back in at any time. {linkStart}Provide feedback.{linkEnd}

You are viewing the old docs. {linkStart}Provide feedback.{linkEnd}

You can opt out at any time and be redirected back to the old reference pages. {linkStart}Provide feedback.{linkEnd}

You are viewing the revamped docs. {linkStart}Provide feedback.{linkEnd}

This field may be set on responses, but will be ignored in requests.

Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. [Learn more about rate limits]({link}).

{limit} requests per day across all API keys for a user or group

{limit} requests per hour across all API keys for a user or group

{limit} requests per minute across all API keys for a user or group

{limit} requests per second across all API keys for a user or group

{limit} requests per minute per API key owner

{limit} request(s) per second per API key owner

Scopes control what permissions your credentials have. Your credentials can only access the endpoints supported by the scopes you selected.

Stable endpoints are production-ready and will almost never experience breaking changes during their lifetime.

This target enables you to limit your key's access to selected {requiredParts}

This target enables you to limit your key's access to selected {requiredParts} and {optionalParts}

Target types are used to restrict the resources that your credentials have permissions on. Only the selected resources can be acted on even if your account has permissions on additional resources. Some scopes do not have target parts. In these cases, all of your relevant resources can be acted on.

The universe Top Level Part does not need to be selected for user-owned API Keys. In this case, your API Key will have access to all of your user-owned experiences and group-owned experiences that you have the right group permissions on.

Try It Out is not yet supported for endpoints requiring API key or OAuth 2.0 authentication

Cookie authentication is disabled for high risk operations for safety.

Critical risk endpoints are extremely sensitive and Try It Out is disabled for safety

Note: Authentication headers are not included in this code sample. You may need to add an authentication header for this command to work.

This is a high risk endpoint that can modify or delete critical data. Use extreme caution when testing.

This API endpoint has been classified as HIGH RISK and may affect live data or user accounts.

Authenticated requests to high-risk APIs can make changes that cannot be undone. Please review your request parameters carefully before proceeding.

Please login to use cookie authentication

This is a low risk endpoint that retrieves data. This is generally safe to test.

This is a medium risk endpoint that modifies data. Test carefully with non-critical accounts, as changes may be permanent.

To keep your account safe, never paste text here from other sources or send information from this page to others.

You are about to test live API endpoints using your actual account credentials.

Only proceed if you understand the implications of the API calls you're about to make. Review the API documentation carefully before testing.

API calls will be made using your authenticated session

These are real API calls that may affect your account or data

Rate limits and other API restrictions apply

Some operations may modify or delete data

This endpoint has been superseded by these recommended alternative endpoints:

The following scopes are required to call this endpoint. For more
information on generating proper keys, see [Manage API keys]({apiKeyReferenceDocLink}).

For more information on generating keys, see [Manage API keys]({apiKeyReferenceDocLink}).

The following endpoints are available at paths relative to the base URL.

This string is formatted as a [FieldMask](/cloud/reference/types#fieldmask).

A JSON value can be `null`, `boolean`, `string`, `number`, `array`, or `object`.

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App registration and review]({oauth2ReferenceDocLink}).

For more information on how to register an OAuth 2.0 application, see [App registration and review]({oauth2ReferenceDocLink}).

The following objects describe payloads that are accepted or returned. See each individual endpoint for more information on when these objects are used.

The following scopes are required to call this endpoint.

Resource Paths

This string is formatted as a [Timestamp](/cloud/reference/types#timestamp).

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App Registration and Review]({oauth2ReferenceDocLink}).

Not Recommended

You are viewing the revamped Open Cloud reference.

You've opted out of the new Open Cloud reference.

View your ad campaigns and their performance.

Create, update, and manage your ad campaigns.

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

This allows viewing asset permissions for subjects (including groups and experiences) and assets your account has access to.

This allows granting asset permissions to any subjects (including groups and experiences) and assets your account has access to.

This allows you to view the status and results of avatar auto-setup jobs on your behalf.

This allows you to create and manage avatar auto-setup jobs on your behalf.

Grants the ability to update badges owned by the user.

This allows viewing information about your commerce items.

This allows making changes to your synced commerce items.

This allows viewing information about your commerce merchant connections.

This allows editing of your commerce merchant connections.

This allows you to view information about your Creator Store products.

This allows you to modify information about your Creator Store products.

This allows you to view information about your Creator Store saves.

This allows you to modify information about your Creator Store saves.

Grants access to create data stores on your behalf.

Grants access to delete data stores on your behalf.

Grants access to read a list of data stores.

Grants access to take a snapshot of your data stores.

Grants access to create entries in your data stores.

Grants access to mark specified entries for deletion.

Grants access to list your data store's entries.

Grants access to read specified entries in your data stores.

Grants access to update the value, attributes, and users of an entry.

Grants access to delete revisions of your data store's entries.

Grants access to list revisions for your data store's entries.

Grants access to read revisions of your data store's entries.

Grants access to view configuration details for the authorized user's developer products.

Grants access to edit the authorized user's developer products.

This allows viewing information about your universe's environments.

This allows editing of your universe's environments.

Grants access to view configuration details for the authorized user's game passes.

Grants access to edit the authorized user's game passes.

Grants access to view community forums information for your account.

Grants access to manage community forums information for your account.

This allows viewing information about your communities.

This allows you to manage community join requests and role updates of lower-ranked community members for your account.

Allows you to view an instance's property data.

Allows you to modify the property data of instances (currently only supports Scripts).

This allows viewing information about your inventory.

Grants access to manage your badges and spend Robux.

Grants access to update the authorized user's badges.

Grants access to manage your developer products.

Grants access to read information about the experiences you have notifications on for.

Grants access to turn on or off notifications for experiences on your behalf.

Grants access to manage your communities.

Grants permission to read community information.

Grants access to read and write your localization tables

Grants access to manage team collaboration for all experiences you own.

Grants access to manage your experiences and certain information associated with your experiences (e.g. localization information).

Grants access to read your experiences' localization information.

Grants access to modify your experiences' localization preferences.

Grants access to manage your user account.

Grants access to modify user localization preferences.

Allows you to view the status, logs, and results of Luau execution tasks for the associated place.

Allows you to create new Luau execution tasks for the associated place.

Grants access to asynchronously flush all data structures in the universe.

Grants access to discard read items from the front of the queue.

Grants access to read items at the front of the queue.

Grants access to read your memory store items.

Grants access to create, update, and delete map items.

This grants the ability to publish messages on behalf of users.

This allows sending notifications from your experience to users.

(Deprecated) Grants access to read a list of entries in an ordered data store.

(Deprecated) Grants access to create a new entry in an ordered data store.

Grants access to list entries from an ordered data store.

Grants access to create entries in an ordered data store.

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

This permission allows you to submit an evaluation job and view the job result.

Grants access to read about your subscription products.

This allows you to read thumbnail information on your behalf.

Grants the ability to read game analytics.

Grants the ability to read place information.

Grants the ability to edit place information.

Grants access to publish new versions of experiences to Roblox.

Grants the ability to read experience information.

Grants access to edit the authorized user's experiences.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

This allows viewing notifications sent to your account.

Grants the ability to read the authorized user's premium and verified status.

This allows you to view the authorized user's social accounts.

This enables Single Sign-On functionality.

This grants access to read your profile information.