Rect

Supported Datatype

A value that represents a two-dimensional rectangle.

Description

Rect describes a rectangle on a 2D plane. It is constructed using two corners, either two Vector2 positions or four numbers:

local rect1 = Rect.new(Vector2.new(10, 10), Vector2.new(80, 80))
local rect2 = Rect.new(10, 10, 80, 80)

This data type is used in the ImageLabel.SliceCenter property which determines the center area of a scaled image.

Constructors

new Supported Returns a new Rect with zero Vector2 positions.

Rect.new()

Returns a new Rect with zero Vector2 positions.

Constructs a new Rect with two zero Vector2 positions.

new Supported Returns a new Rect from the given Vector2 positions.

Rect.new(min: Vector2, max: Vector2)

Returns a new Rect from the given Vector2 positions.

Constructs a new Rect given two Vector2 positions: min as the top-left corner and max as the bottom-right corner.

new Supported Returns a new Rect using the first and last two arguments as coordinates for corners.

Rect.new(minX: number, minY: number, maxX: number, maxY: number)

Returns a new Rect using the first and last two arguments as coordinates for corners.

Constructs a new Rect using minX and minY as coordinates for the top-left corner, and maxX and maxY as coordinates for the bottom-right corner.

Properties

Width Supported The width of the Rect.

Rect.Width()

The width of the Rect.

The horizontal span of the rectangle, equal to Max.X - Min.X. This value is always non-negative because the constructor normalizes the input coordinates so that Min is component-wise less than or equal to Max. Defaults to 0 for a Rect created with no arguments.

Height Supported The height of the Rect.

Rect.Height()

The height of the Rect.

The vertical span of the rectangle, equal to Max.Y - Min.Y. This value is always non-negative because the constructor normalizes the input coordinates so that Min is component-wise less than or equal to Max. Defaults to 0 for a Rect created with no arguments.

Min Supported The coordinates of the top-left corner.

Rect.Min()

The coordinates of the top-left corner.

The top-left corner of the rectangle as a Vector2. When you construct a Rect with two positions, this property returns the component-wise minimum of those positions regardless of the order they were passed in. Defaults to (0, 0) for a Rect created with no arguments.

Max Supported The coordinates of the bottom-right corner.

Rect.Max()

The coordinates of the bottom-right corner.

The bottom-right corner of the rectangle as a Vector2. When you construct a Rect with two positions, this property returns the component-wise maximum of those positions regardless of the order they were passed in. Defaults to (0, 0) for a Rect created with no arguments.

Nova binding inventory

Library	Members
new	Height, Max, Min, Width

Roblox reference: Rect