Data type

`Region3`

Describes a rectangular volume in 3D space.

The Region3 data type describes a volume in 3D space similar to an axis-aligned rectangular prism. It is commonly used with Terrain functions and functions that detect parts within a volume, such as WorldRoot:FindPartsInRegion3().

The prism's center is accessible using the Region3.CFrame property and the prism's size is accessible through the Region3.Size property. Note that the components of this property may be negative.

The Region3:ExpandToGrid() method returns a new Region3 whose bounds comply with a provided resolution value. The resulting volume may be equal to or greater than the original volume, but never smaller.

Constructors 1#

new	Returns a new `Region3` using the provided vectors as boundaries.

`new(min: Vector3, max: Vector3)`#

Returns a new Region3 given the Vector3 bounds of the rectangular prism volume.

Note that the order of the provided bounds matters: by switching them, the polarity of the size components will switch. It is possible to create a Region3 with a negative volume.

Name	Type	Default	Description
`min`	`Vector3`		The lower corner of the rectangular volume.
`max`	`Vector3`		The upper corner of the rectangular volume.

Properties 2#

CFrame`CFrame`	The center location and rotation of the `Region3`.
Size`Vector3`	The 3D size of the `Region3`.

`CFrame`: `CFrame`#

The CFrame representing the center position and orientation of the Region3. The position component is the midpoint of the min and max vectors passed to Region3.new(), computed as (min + max) / 2. Because a Region3 is always axis-aligned, the rotation component of the returned CFrame is always the identity (no rotation). This property is read-only.

`Size`: `Vector3`#

The size of the Region3 as a Vector3, equal to max - min from the constructor arguments. Individual components may be negative if the corresponding component of min is greater than max in the call to Region3.new(). This property is read-only.

Methods 1#

ExpandToGrid Expands the Region3 to fit a grid based on the provided resolution.

`ExpandToGrid(resolution: number)`: Region3#

Expands the Region3 based on the provided resolution and returns the expanded Region3 aligned to the Terrain voxel grid.

Name	Type	Default	Description
`resolution`	`number`		The grid resolution to align the region bounds to, in studs. Must be a positive number.

Returns

Region3 — A new Region3 whose minimum bounds are floored and maximum bounds are ceiled to the nearest multiple of resolution.

Constructors 1#

function Object() { [native code] }new(min: Vector3, max: Vector3)#