OverlapParams¶
Stores parameters used in boundary-querying functions.
Not implemented in Nova
This datatype is not registered in Nova's Lua VM. Constructing or receiving it from an API call will not work.
Description¶
The OverlapParams data type stores parameters for use with WorldRoot boundary-querying functions, in particular WorldRoot.GetPartBoundsInBox(), WorldRoot.GetPartBoundsInRadius() and WorldRoot.GetPartsInPart(). The ExcludeInstances and IncludeInstances properties store a set of objects and their descendants that will be excluded and included from the query. 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 OverlapParams without creating a new object, allowing you to reuse the same object repeatedly.
Constructors¶
new Not yet Returns a blank OverlapParams object.
Returns a blank OverlapParams object. Unlike other data type constructors, this constructor does not have any parameters, so you should set its properties appropriately.
Properties¶
ExcludeInstances Not yet An optional array of instances whose descendants will be excluded from the query.
An optional array of instances whose descendants will be excluded from the query. This property can be used simultaneously with 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.
IncludeInstances Not yet An optional array of instances whose descendants will be included in the query.
An optional array of instances whose descendants will be included in the query. This property can be used simultaneously with 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).
MaxParts Not yet The maximum amount of parts to be returned by the query.
CollisionGroup Not yet The collision group used for the operation.
Tolerance Not yet Slightly increases the volume of the boundary-querying operation.
RespectCanCollide Not yet Determines whether the boundary-querying operation considers a part's BasePart.CanCollide property value over its BaseP…
Determines whether the boundary-querying operation considers a part's BasePart.CanCollide property value over its BasePart.CanQuery value.
This property, if true, makes the boundary-querying operation use an
intersected part's BasePart.CanCollide value in favor of its
BasePart.CanQuery value when determining whether that part is
included in the array of spatial query results.
BruteForceAllSlow Not yet When enabled, the query will ignore all part collision properties and perform a brute-force check on every part.
FilterDescendantsInstances Not yet An array of objects whose descendants are used in filtering candidates.
An array of objects whose descendants are used in filtering candidates. Note that this property has been superseded by ExcludeInstances and IncludeInstances which should be used for new work.
FilterType Not yet Determines whether the FilterDescendantsInstances array is used as an exclude or include list.
Determines whether the FilterDescendantsInstances array is used as an exclude or include list. Note that this property has been superseded by ExcludeInstances and IncludeInstances which should be used for new work.
Methods¶
AddToFilter Not yet Adds the instances provided to FilterDescendantsInstances.
Adds the instances provided to FilterDescendantsInstances. Note that this property has been superseded by ExcludeInstances and IncludeInstances which should be used for new work.
Roblox reference: OverlapParams