OverlapParams
Configures filtering and result limits for spatial overlap queries.
Behavior
OverlapParams configures filtering and result limits for spatial overlap queries.
Summary
BruteForceAllSlow: booleanWhether to use the slower exhaustive query path instead of the normal spatial acceleration structure.
CollisionGroup: stringThe collision group used to filter query candidates.
FilterDescendantsInstances: tableThe Instances whose descendants are included or excluded by FilterType.
Whether the descendant filter includes or excludes the specified hierarchies.
MaxParts: numberThe maximum number of overlap results.
RespectCanCollide: booleanWhether the query uses collision eligibility rather than query eligibility.
AddToFilter(instances: Instance | { Instance }): ()Appends an Instance or array of Instances to the descendant filter.
Constructors
new
OverlapParams.new(): OverlapParamsCreates a mutable set of spatial-query options.
Properties
BruteForceAllSlow
OverlapParams.BruteForceAllSlow: booleanWhether to use the slower exhaustive query path instead of the normal spatial acceleration structure.
CollisionGroup
OverlapParams.CollisionGroup: stringThe collision group used to filter query candidates.
FilterDescendantsInstances
OverlapParams.FilterDescendantsInstances: tableThe Instances whose descendants are included or excluded by FilterType.
FilterType
OverlapParams.FilterType: EnumItemWhether the descendant filter includes or excludes the specified hierarchies.
MaxParts
OverlapParams.MaxParts: numberThe maximum number of overlap results. Zero permits an unlimited result count.
RespectCanCollide
OverlapParams.RespectCanCollide: booleanWhether the query uses collision eligibility rather than query eligibility.
Methods
AddToFilter
Appends an Instance or array of Instances to the descendant filter.
Operators
__tostring · __type