Skip to content

Api > Rect > Contains()


Rect.Contains(Vector3 point, boolean allowInverse)⚓︎

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.

Parameters:⚓︎

Name Type Description
point Vector3 Point to test.
allowInverse boolean Does the test allow the Rect's width and height to be negative?

Returns:⚓︎

type Description
boolean True if the point lies within the specified rectangle.

Usage⚓︎

---@type Rect
local rect;

---@type Vector3
local point;

---@type boolean
local allowInverse;


local val0 = rect.Contains(point, allowInverse)