Clarification on :ArePartsTouchingOthers()

Help and Feedback Scripting Support
1

So I’ve been digging through the devhub and I found this API reference page for :ArePartsTouchingOthers().

Screen Shot 2021-06-29 at 2.35.29 PM
Screen Shot 2021-06-29 at 2.35.29 PM2878×1652 447 KB

It’s self-explanatory… except that I’m confused on one of the parameters: overlapIgnored. How do I exactly use it?

The definition for it is wordy and I was hoping if somebody experienced can help clarify what it means. Is it saying that I can set a limit for the overlap? If so, how does that get translated from Vector values to a single integer? Like if I did two 5x5 Parts overlapping each other by 4 studs, how would that be translated or how would I translate it?

Screen Shot 2021-06-29 at 2.45.15 PM
Screen Shot 2021-06-29 at 2.45.15 PM1224×1116 677 KB

Sorry if I’m making this more complicated than it needs to be.

2

except that I’m confused on one of the parameters: overlapIgnored

This, from what I understand, is if the parts CanCollide is off and the parts are overlapping each other. You can ignore this by using the parameter overlapIgnored.

If CanCollide is on, this just detects if the parts are touching each other.