Terrain

Missing API Documentation

This API Class does not have any or complete API documentation. Please add API documentation if possible.

Terrain
Not creatableThis class cannot be instantiated.
Icon
Legacy IconsThese icon(s) are only a part of legacy Roblox Studio versions, or are unused as of the studio icons update.
Memory category	Instances
Inheritance
Instance PVInstance BasePart Terrain

Object representing a high performance bounded grid of static 4x4 parts. This class cannot be instantiated.

Properties

Decoration: bool

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Terrain/Decoration.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

GrassLength: float

• Not scriptableThis member cannot be accessed by Lua code.
• Not browsableThis member is not visible in documentation for end-users.

This class member is missing documentation. Create or add to its subpage at Class:Terrain/GrassLength.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

IsSmooth: bool

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This class member is missing documentation. Create or add to its subpage at Class:Terrain/IsSmooth.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

LastUsedModificationMethod: TerrainAcquisitionMethod

• HiddenThis property is not shown in the object browser and properties window.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Terrain/LastUsedModificationMethod.

• Category: Data.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: cannot load or save.
• Thread safety: read safe

MaterialColors: BinaryString

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Terrain/MaterialColors.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

MaxExtents: Region3int16

• Read-onlyThis property is capable of being read but not written.
• Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:Terrain/MaxExtents.

• Category: Data.
• Serialization: cannot load or save.
• Thread safety: read safe

ShorelinesUpgraded: bool

• HiddenThis property is not shown in the object browser and properties window.

This class member is missing documentation. Create or add to its subpage at Class:Terrain/ShorelinesUpgraded.

• Category: Appearance.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

SmoothVoxelsUpgraded: bool

• HiddenThis property is not shown in the object browser and properties window.

This class member is missing documentation. Create or add to its subpage at Class:Terrain/SmoothVoxelsUpgraded.

• Category: Appearance.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

WaterColor: Color3

This class member is missing documentation. Create or add to its subpage at Class:Terrain/WaterColor.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

WaterReflectance: float

This class member is missing documentation. Create or add to its subpage at Class:Terrain/WaterReflectance.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

WaterTransparency: float

This class member is missing documentation. Create or add to its subpage at Class:Terrain/WaterTransparency.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

WaterWaveSize: float

This class member is missing documentation. Create or add to its subpage at Class:Terrain/WaterWaveSize.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

WaterWaveSpeed: float

This class member is missing documentation. Create or add to its subpage at Class:Terrain/WaterWaveSpeed.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

Methods

AutowedgeCell(x: int, y: int, z: int): bool

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
x	int
y	int
z	int

• Thread safety: unsafe

AutowedgeCells(region: Region3int16): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
region	Region3int16

• Thread safety: unsafe

CanShorelinesBeUpgraded(): bool

This class member is missing documentation. Create or add to its subpage at Class:Terrain/CanShorelinesBeUpgraded.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

CanSmoothVoxelsBeUpgraded(): bool

This class member is missing documentation. Create or add to its subpage at Class:Terrain/CanSmoothVoxelsBeUpgraded.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

CellCenterToWorld(x: int, y: int, z: int): Vector3

Parameters

Name	Type
x	int
y	int
z	int

• Thread safety: unsafe

CellCornerToWorld(x: int, y: int, z: int): Vector3

Parameters

Name	Type
x	int
y	int
z	int

• Thread safety: unsafe

Clear(): null

Clears all existing terrain voxels.

• Thread safety: unsafe

ConvertToSmooth(): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Was previously used to convert legacy terrain to smooth terrain technology. This method no longer does anything when called because legacy terrain has been removed.

• Security: PluginSecurity.
• Thread safety: unsafe

CopyRegion(region: Region3int16): TerrainRegion

Parameters

Name	Type
region	Region3int16

• Thread safety: unsafe

CountCells(): int

This class member is missing documentation. Create or add to its subpage at Class:Terrain/CountCells.

• Thread safety: unsafe

FillBall(center: Vector3, radius: float, material: Material): null

Parameters

Name	Type
center	Vector3
radius	float
material	Material

• Thread safety: unsafe

FillBlock(cframe: CFrame, size: Vector3, material: Material): null

Parameters

Name	Type
cframe	CFrame
size	Vector3
material	Material

• Thread safety: unsafe

FillCylinder(cframe: CFrame, height: float, radius: float, material: Material): null

Parameters

Name	Type
cframe	CFrame
height	float
radius	float
material	Material

• Thread safety: unsafe

FillRegion(region: Region3, resolution: float, material: Material): null

Parameters

Name	Type
region	Region3
resolution	float
material	Material

• Thread safety: unsafe

FillWedge(cframe: CFrame, size: Vector3, material: Material): null

Parameters

Name	Type
cframe	CFrame
size	Vector3
material	Material

• Thread safety: unsafe

GetCell(x: int, y: int, z: int): Tuple

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
x	int
y	int
z	int

• Thread safety: unsafe

GetMaterialColor(material: Material): Color3

Parameters

Name	Type
material	Material

• Thread safety: safe

GetTerrainWireframe(cframe: CFrame, size: Vector3): Array

Parameters

Name	Type
cframe	CFrame
size	Vector3

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

GetWaterCell(x: int, y: int, z: int): Tuple

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
x	int
y	int
z	int

• Thread safety: unsafe

PasteRegion(region: TerrainRegion, corner: Vector3int16, pasteEmptyCells: bool): null

Parameters

Name	Type
region	TerrainRegion
corner	Vector3int16
pasteEmptyCells	bool

• Thread safety: unsafe

ReadVoxels(region: Region3, resolution: float): Tuple

• Custom Lua stateThis member uses the Lua C API directly.

Parameters

Name	Type
region	Region3
resolution	float

• Thread safety: safe

ReplaceMaterial(region: Region3, resolution: float, sourceMaterial: Material, targetMaterial: Material): null

Parameters

Name	Type
region	Region3
resolution	float
sourceMaterial	Material
targetMaterial	Material

• Thread safety: unsafe

ReplaceMaterialInTransform(cframe: CFrame, size: Vector3, sourceMaterial: Material, targetMaterial: Material): null

Parameters

Name	Type
cframe	CFrame
size	Vector3
sourceMaterial	Material
targetMaterial	Material

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

ReplaceMaterialInTransformSubregion(cframe: CFrame, size: Vector3, sourceMaterial: Material, targetMaterial: Material, targetRegion: Region3int16): null

Parameters

Name	Type
cframe	CFrame
size	Vector3
sourceMaterial	Material
targetMaterial	Material
targetRegion	Region3int16

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetCell(x: int, y: int, z: int, material: CellMaterial, block: CellBlock, orientation: CellOrientation): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
x	int
y	int
z	int
material	CellMaterial
block	CellBlock
orientation	CellOrientation

• Thread safety: unsafe

SetCells(region: Region3int16, material: CellMaterial, block: CellBlock, orientation: CellOrientation): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
region	Region3int16
material	CellMaterial
block	CellBlock
orientation	CellOrientation

• Thread safety: unsafe

SetMaterialColor(material: Material, value: Color3): null

Parameters

Name	Type
material	Material
value	Color3

• Thread safety: unsafe

SetMaterialInTransform(cframe: CFrame, size: Vector3, targetMaterial: Material): null

Parameters

Name	Type
cframe	CFrame
size	Vector3
targetMaterial	Material

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetMaterialInTransformSubregion(cframe: CFrame, size: Vector3, targetMaterial: Material, targetRegion: Region3int16): null

Parameters

Name	Type
cframe	CFrame
size	Vector3
targetMaterial	Material
targetRegion	Region3int16

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetWaterCell(x: int, y: int, z: int, force: WaterForce, direction: WaterDirection): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
x	int
y	int
z	int
force	WaterForce
direction	WaterDirection

• Thread safety: unsafe

SmoothRegion(region: Region3, resolution: float, strength: float): Tuple

• Custom Lua stateThis member uses the Lua C API directly.

Parameters

Name	Type
region	Region3
resolution	float
strength	float

• Security: RobloxScriptSecurity.
• Thread safety: safe

WorldToCell(position: Vector3): Vector3

Parameters

Name	Type
position	Vector3

• Thread safety: unsafe

WorldToCellPreferEmpty(position: Vector3): Vector3

Parameters

Name	Type
position	Vector3

• Thread safety: unsafe

WorldToCellPreferSolid(position: Vector3): Vector3

Parameters

Name	Type
position	Vector3

• Thread safety: unsafe

WriteVoxels(region: Region3, resolution: float, materials: Array, occupancy: Array): null

• Custom Lua stateThis member uses the Lua C API directly.

Parameters

Name	Type
region	Region3
resolution	float
materials	Array
occupancy	Array

• Thread safety: unsafe

Removed members

Methods

• breakJoints
• BreakJoints
• CancelImportHeightmap
• clone
• Clone
• destroy
• Destroy
• HideTerrainRegion
• ImportHeightmap
• ImportHeightMap
• makeJoints
• MakeJoints
• resize
• Resize
• SetImportHeightmapPaused
• SetTerrainRegion
• SetWireframeRegion
• ShowTerrainRegion

Properties

• Anchored
• Archivable
• BrickColor
• CanCollide
• CFrame
• DebugAnimation
• Elasticity
• Friction
• Locked
• Material
• Name
• Position
• Reflectance
• RotVelocity
• Transparency
• Velocity

Events

• TerrainProgressUpdate

External links

• Terrain in the Roblox Creator Documentation
• Terrain in the Roblox API Reference