Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Rect.Overlaps

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public function Overlaps(other: Rect): bool;
public bool Overlaps(Rect other);
public def Overlaps(other as Rect) as bool
public function Overlaps(other: Rect, allowInverse: bool): bool;
public bool Overlaps(Rect other, bool allowInverse);
public def Overlaps(other as Rect, allowInverse as bool) as bool

Parameters

other Other rectangle to test overlapping with.
allowInverse Does the test allow the Rects' widths and heights to be negative?

Description

Returns true if the other rectangle overlaps this one. If allowInverse is present and true, the widths and heights of the Rects are allowed to take negative values (ie, the min value is greater than the max), and the test will still work.