Open Asterune
TerrainRegion

TerrainRegion

Stores a copied block of terrain cells.

Behavior

Terrain:CopyRegion(region) returns a TerrainRegion. The copied cell data can be transformed and pasted with Terrain:PasteRegion. Transform methods return another TerrainRegion.

Summary

Members6
Properties4
Methods2
  • Rotated(turns: number): TerrainRegion

    Returns a copy rotated by the supplied number of quarter turns.

  • Mirrored(axis: string): TerrainRegion

    Returns a copy mirrored across the selected axis.

Properties

SizeInCells

TerrainRegion.SizeInCells: Vector3

The dimensions of the copied region in cells.

Size

TerrainRegion.Size: Vector3

The dimensions of the copied region in studs.

IsEmpty

TerrainRegion.IsEmpty: boolean

Whether the copied region contains no occupied cells.

ClassName

TerrainRegion.ClassName: string

The string "TerrainRegion".

Methods

Rotated

TerrainRegion:Rotated(turns: number): TerrainRegion

Returns a copy rotated by the supplied number of quarter turns.

Mirrored

TerrainRegion:Mirrored(axis: string): TerrainRegion

Returns a copy mirrored across the selected axis. Accepts "X", "Y", or "Z", in either case. Other values cause an error.

Used by

Terrain

Terrain