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
`OverlapParams.FilterDescendantsInstances` property stores an array of objects
to use as either an inclusion or exclusion list based on the
`OverlapParams.FilterType` enum, and the `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.


OverlapParams

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


OverlapParams.FilterDescendantsInstances

Determines how the `OverlapParams.FilterDescendantsInstances` array is
used, depending on the `Enum.RaycastFilterType` provided.


OverlapParams.FilterType

Determines how the `OverlapParams.FilterDescendantsInstances` list is used.


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.


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.


Stores parameters used in boundary-querying functions.


Default Value: {defaultValueStart}{defaultValueEnd}

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is read only. Attempting to write to this member causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

{pageTitle} | {SiteName}

We’re making things more awesome. Thanks for your patience.

By clicking "Continue", you will be directed to {redirectLinkStart}{redirectLinkEnd}

This site is not owned or operated by Roblox. They may have different terms and privacy policies.

OverlapParams

Summary

Constructors

Properties

Constructors

new

Properties

FilterDescendantsInstances

FilterType

MaxParts

CollisionGroup

RespectCanCollide