Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

Rect.Contains

Contains(point: Vector2): bool;
bool Contains(Vector2 point);
def Contains(point as Vector2) as bool
Contains(point: Vector3): bool;
bool Contains(Vector3 point);
def Contains(point as Vector3) as bool
Contains(point: Vector3, allowInverse: bool): bool;
bool Contains(Vector3 point, bool allowInverse);
def Contains(point as Vector3, allowInverse as bool) as bool

Parameters

pointPoint to test.
allowInverseDoes the test allow the Rect's width and height to be negative?

Description

Returns true if the x and y components of point is a point inside this rectangle. If allowInverse is present and true, the width and height of the Rect are allowed to take negative values (ie, the min value is greater than the max), and the test will still work.

	// prints inside when mouse is in lower left corner

function Update () { var rect = Rect (0, 0, 150, 150); if (rect.Contains(Input.mousePosition)) print("Inside"); }

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void Update() {
        Rect rect = new Rect(0, 0, 150, 150);
        if (rect.Contains(Input.mousePosition))
            print("Inside");
        
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def Update() as void:
		rect as Rect = Rect(0, 0, 150, 150)
		if rect.Contains(Input.mousePosition):
			print('Inside')