Terrain On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.

Memory Category	Instances
ExplorerImageIndex	65 ()
ExplorerOrder	5
Insertable	false

Tags: [NotCreatable]

Inherits (3)

Member index (50)

Type	Member	History
bool	Decoration	410
float	GrassLength	595
bool	IsSmooth	193 297
TerrainAcquisitionMethod	LastUsedModificationMethod	466
BinaryString	MaterialColors	349
Region3int16	MaxExtents
bool	ShorelinesUpgraded	554
bool	SmoothVoxelsUpgraded	560
Color3	WaterColor	223 222 223
float	WaterReflectance	262
float	WaterTransparency	223 222 223
float	WaterWaveSize	223 222 223
float	WaterWaveSpeed	223 222 223
bool	AutowedgeCell (int x, int y, int z)	49 251 250 251
null	AutowedgeCells (Region3int16 region)	49 251 250 251 573
bool	CanShorelinesBeUpgraded ()	554
bool	CanSmoothVoxelsBeUpgraded ()	560
Vector3	CellCenterToWorld (int x, int y, int z)
Vector3	CellCornerToWorld (int x, int y, int z)
null	Clear ()	573
null	ConvertToSmooth ()	193 297 573
TerrainRegion	CopyRegion (Region3int16 region)	130 498
int	CountCells ()
null	FillBall (Vector3 center, float radius, Material material)	193 573
null	FillBlock (CFrame cframe, Vector3 size, Material material)	193 573
null	FillCylinder (CFrame cframe, float height, float radius, Material material)	392 573
null	FillRegion (Region3 region, float resolution, Material material)	193 573
null	FillWedge (CFrame cframe, Vector3 size, Material material)	417 573
Tuple	GetCell (int x, int y, int z)	251 250 251
Color3	GetMaterialColor (Material material)	317
Array	GetTerrainWireframe (CFrame cframe, Vector3 size)	565
Tuple	GetWaterCell (int x, int y, int z)	61 79 78 79 251 250 251
null	PasteRegion (TerrainRegion region, Vector3int16 corner, bool pasteEmptyCells)	130 498 573
Dictionary	ReadVoxelChannels (Region3 region, float resolution, Array channelIds)	604 603 604
Tuple	ReadVoxels (Region3 region, float resolution)	193 349
null	ReplaceMaterial (Region3 region, float resolution, Material sourceMaterial, Material targetMaterial)	400 573
null	ReplaceMaterialInTransform (CFrame cframe, Vector3 size, Material sourceMaterial, Material targetMaterial)	566 573
null	ReplaceMaterialInTransformSubregion (CFrame cframe, Vector3 size, Material sourceMaterial, Material targetMaterial, Region3int16 targetRegion)	582
null	SetCell (int x, int y, int z, CellMaterial material, CellBlock block, CellOrientation orientation)	251 250 251 573
null	SetCells (Region3int16 region, CellMaterial material, CellBlock block, CellOrientation orientation)	251 250 251 573
null	SetMaterialColor (Material material, Color3 value)	317 573
null	SetMaterialInTransform (CFrame cframe, Vector3 size, Material targetMaterial)	566 573
null	SetMaterialInTransformSubregion (CFrame cframe, Vector3 size, Material targetMaterial, Region3int16 targetRegion)	582
null	SetWaterCell (int x, int y, int z, WaterForce force, WaterDirection direction)	61 79 78 79 251 250 251 573
Tuple	SmoothRegion (Region3 region, float resolution, float strength)	569
Vector3	WorldToCell (Vector3 position)
Vector3	WorldToCellPreferEmpty (Vector3 position)
Vector3	WorldToCellPreferSolid (Vector3 position)
null	WriteVoxelChannels (Region3 region, float resolution, Dictionary channels)	604 603 604
null	WriteVoxels (Region3 region, float resolution, Array materials, Array occupancy)	193 349 573
104 members inherited from BasePart
4 members inherited from PVInstance
57 members inherited from Instance

Removed member index (35)

Type	Member	History
bool	Anchored	55 67 66 67
bool	Archivable	55 67 66 67
BrickColor	BrickColor	55 67 66 67
CoordinateFrame	CFrame	55 67 66 67
bool	CanCollide	55 67 66 67
bool	DebugAnimation	53
float	Elasticity	55 67 66 67
float	Friction	55 67 66 67
bool	Locked	55 67 66 67
Material	Material	55 67 66 67
string	Name	55 67 66 67
Vector3	Position	55 67 66 67
float	Reflectance	55 67 66 67
Vector3	RotVelocity	55 67 66 67
float	Transparency	55 67 66 67
Vector3	Velocity	55 67 66 67
void	BreakJoints ()	55 67 66 67
void	CancelImportHeightmap ()	457 484
Instance	Clone ()	55 67 66 67
void	Destroy ()	55 67 66 67
void	HideTerrainRegion ()	549 565
void	ImportHeightMap (string heightMapBinary, string colorMapBinary, Region3 region)	391 462
void	ImportHeightmap (Region3 region, Content heightmapAssetId, Content colormapAssetId, Material defaultMaterial)	457 484
void	MakeJoints ()	55 67 66 67
bool	Resize (NormalId normalId, int deltaAmount)	55 67 66 67
void	SetImportHeightmapPaused (bool paused)	457 484
void	SetTerrainRegion (CFrame cframe, Vector3 size)	549 565
void	SetWireframeRegion (CFrame cframe, Vector3 size)	549 565
void	ShowTerrainRegion ()	549 565
void	breakJoints ()	55 67 66 67
Instance	clone ()	55 67 66 67
void	destroy ()	55 67 66 67
void	makeJoints ()	55 67 66 67
bool	resize (NormalId normalId, int deltaAmount)	55 67 66 67
	TerrainProgressUpdate (float progressRatio)	391 484

604 Add Terrain.ReadVoxelChannels
604 Add Terrain.WriteVoxelChannels
603 Remove Terrain.ReadVoxelChannels
603 Remove Terrain.WriteVoxelChannels
604 Add Terrain.ReadVoxelChannels
604 Add Terrain.WriteVoxelChannels
595 Add Terrain.GrassLength
582 Add Terrain.ReplaceMaterialInTransformSubregion
582 Add Terrain.SetMaterialInTransformSubregion
573 Change ReturnType of Terrain.AutowedgeCells from void to null
573 Change ReturnType of Terrain.Clear from void to null
573 Change ReturnType of Terrain.ConvertToSmooth from void to null
573 Change ReturnType of Terrain.FillBall from void to null
573 Change ReturnType of Terrain.FillBlock from void to null
573 Change ReturnType of Terrain.FillCylinder from void to null
573 Change ReturnType of Terrain.FillRegion from void to null
573 Change ReturnType of Terrain.FillWedge from void to null
573 Change ReturnType of Terrain.PasteRegion from void to null
573 Change ReturnType of Terrain.ReplaceMaterial from void to null
573 Change ReturnType of Terrain.ReplaceMaterialInTransform from void to null
573 Change ReturnType of Terrain.SetCell from void to null
573 Change ReturnType of Terrain.SetCells from void to null
573 Change ReturnType of Terrain.SetMaterialColor from void to null
573 Change ReturnType of Terrain.SetMaterialInTransform from void to null
573 Change ReturnType of Terrain.SetWaterCell from void to null
573 Change ReturnType of Terrain.WriteVoxels from void to null
569 Add Terrain.SmoothRegion
566 Add Terrain.ReplaceMaterialInTransform
566 Add Terrain.SetMaterialInTransform
565 Add Terrain.GetTerrainWireframe
565 Remove Terrain.HideTerrainRegion
565 Remove Terrain.SetTerrainRegion
565 Remove Terrain.SetWireframeRegion
565 Remove Terrain.ShowTerrainRegion
560 Add Terrain.SmoothVoxelsUpgraded
560 Add Terrain.CanSmoothVoxelsBeUpgraded
554 Add Terrain.ShorelinesUpgraded
554 Add Terrain.CanShorelinesBeUpgraded
549 Add Terrain.HideTerrainRegion
549 Add Terrain.SetTerrainRegion
549 Add Terrain.SetWireframeRegion
549 Add Terrain.ShowTerrainRegion
498 Change ReturnType of Terrain.CopyRegion from Instance to TerrainRegion
498 Change Parameters of Terrain.PasteRegion from (Instance region, Vector3int16 corner, bool pasteEmptyCells) to (TerrainRegion region, Vector3int16 corner, bool pasteEmptyCells)
484 Remove Terrain.CancelImportHeightmap
484 Remove Terrain.ImportHeightmap
484 Remove Terrain.SetImportHeightmapPaused
484 Remove Terrain.TerrainProgressUpdate
466 Add Terrain.LastUsedModificationMethod
462 Remove Terrain.ImportHeightMap
457 Add Terrain.CancelImportHeightmap
457 Add Terrain.ImportHeightmap
457 Add Terrain.SetImportHeightmapPaused
417 Add Terrain.FillWedge
410 Add Terrain.Decoration
400 Add Terrain.ReplaceMaterial
392 Add Terrain.FillCylinder
391 Add Terrain.ImportHeightMap
391 Add Terrain.TerrainProgressUpdate
349 Add Terrain.MaterialColors
349 Change Tags of Terrain.ReadVoxels from [] to [CustomLuaState]
349 Change Tags of Terrain.WriteVoxels from [] to [CustomLuaState]
317 Add Terrain.GetMaterialColor
317 Add Terrain.SetMaterialColor
297 Change Tags of Terrain.IsSmooth from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
297 Change Tags of Terrain.ConvertToSmooth from [] to [Deprecated]
262 Add Terrain.WaterReflectance
251 Change Tags of Terrain.AutowedgeCell from [] to [Deprecated]
251 Change Tags of Terrain.AutowedgeCells from [] to [Deprecated]
251 Change Tags of Terrain.GetCell from [] to [Deprecated]
251 Change Tags of Terrain.GetWaterCell from [] to [Deprecated]
251 Change Tags of Terrain.SetCell from [] to [Deprecated]
251 Change Tags of Terrain.SetCells from [] to [Deprecated]
251 Change Tags of Terrain.SetWaterCell from [] to [Deprecated]
250 Change Tags of Terrain.AutowedgeCell from [Deprecated] to []
250 Change Tags of Terrain.AutowedgeCells from [Deprecated] to []
250 Change Tags of Terrain.GetCell from [Deprecated] to []
250 Change Tags of Terrain.GetWaterCell from [Deprecated] to []
250 Change Tags of Terrain.SetCell from [Deprecated] to []
250 Change Tags of Terrain.SetCells from [Deprecated] to []
250 Change Tags of Terrain.SetWaterCell from [Deprecated] to []
251 Change Tags of Terrain.AutowedgeCell from [] to [Deprecated]
251 Change Tags of Terrain.AutowedgeCells from [] to [Deprecated]
251 Change Tags of Terrain.GetCell from [] to [Deprecated]
251 Change Tags of Terrain.GetWaterCell from [] to [Deprecated]
251 Change Tags of Terrain.SetCell from [] to [Deprecated]
251 Change Tags of Terrain.SetCells from [] to [Deprecated]
251 Change Tags of Terrain.SetWaterCell from [] to [Deprecated]
223 Add Terrain.WaterColor
223 Add Terrain.WaterTransparency
223 Add Terrain.WaterWaveSize
223 Add Terrain.WaterWaveSpeed
222 Remove Terrain.WaterColor
222 Remove Terrain.WaterTransparency
222 Remove Terrain.WaterWaveSize
222 Remove Terrain.WaterWaveSpeed
223 Add Terrain.WaterColor
223 Add Terrain.WaterTransparency
223 Add Terrain.WaterWaveSize
223 Add Terrain.WaterWaveSpeed
193 Add Terrain.IsSmooth
193 Add Terrain.ConvertToSmooth
193 Add Terrain.FillBall
193 Add Terrain.FillBlock
193 Add Terrain.FillRegion
193 Add Terrain.ReadVoxels
193 Add Terrain.WriteVoxels
130 Add Terrain.CopyRegion
130 Add Terrain.PasteRegion
79 Change Tags of Terrain.GetWaterCell from [preliminary] to []
79 Change Tags of Terrain.SetWaterCell from [preliminary] to []
78 Change Tags of Terrain.GetWaterCell from [] to [preliminary]
78 Change Tags of Terrain.SetWaterCell from [] to [preliminary]
79 Change Tags of Terrain.GetWaterCell from [preliminary] to []
79 Change Tags of Terrain.SetWaterCell from [preliminary] to []
67 Remove Terrain.Anchored
67 Remove Terrain.Archivable
67 Remove Terrain.BrickColor
67 Remove Terrain.CFrame
67 Remove Terrain.CanCollide
67 Remove Terrain.Elasticity
67 Remove Terrain.Friction
67 Remove Terrain.Locked
67 Remove Terrain.Material
67 Remove Terrain.Name
67 Remove Terrain.Position
67 Remove Terrain.Reflectance
67 Remove Terrain.RotVelocity
67 Remove Terrain.Transparency
67 Remove Terrain.Velocity
67 Remove Terrain.BreakJoints
67 Remove Terrain.Clone
67 Remove Terrain.Destroy
67 Remove Terrain.MakeJoints
67 Remove Terrain.Resize
67 Remove Terrain.breakJoints
67 Remove Terrain.clone
67 Remove Terrain.destroy
67 Remove Terrain.makeJoints
67 Remove Terrain.resize
66 Add Terrain.Anchored
66 Add Terrain.Archivable
66 Add Terrain.BrickColor
66 Add Terrain.CFrame
66 Add Terrain.CanCollide
66 Add Terrain.Elasticity
66 Add Terrain.Friction
66 Add Terrain.Locked
66 Add Terrain.Material
66 Add Terrain.Name
66 Add Terrain.Position
66 Add Terrain.Reflectance
66 Add Terrain.RotVelocity
66 Add Terrain.Transparency
66 Add Terrain.Velocity
66 Add Terrain.BreakJoints
66 Add Terrain.Clone
66 Add Terrain.Destroy
66 Add Terrain.MakeJoints
66 Add Terrain.Resize
66 Add Terrain.breakJoints
66 Add Terrain.clone
66 Add Terrain.destroy
66 Add Terrain.makeJoints
66 Add Terrain.resize
67 Remove Terrain.Anchored
67 Remove Terrain.Archivable
67 Remove Terrain.BrickColor
67 Remove Terrain.CFrame
67 Remove Terrain.CanCollide
67 Remove Terrain.Elasticity
67 Remove Terrain.Friction
67 Remove Terrain.Locked
67 Remove Terrain.Material
67 Remove Terrain.Name
67 Remove Terrain.Position
67 Remove Terrain.Reflectance
67 Remove Terrain.RotVelocity
67 Remove Terrain.Transparency
67 Remove Terrain.Velocity
67 Remove Terrain.BreakJoints
67 Remove Terrain.Clone
67 Remove Terrain.Destroy
67 Remove Terrain.MakeJoints
67 Remove Terrain.Resize
67 Remove Terrain.breakJoints
67 Remove Terrain.clone
67 Remove Terrain.destroy
67 Remove Terrain.makeJoints
67 Remove Terrain.resize
61 Add Terrain.GetWaterCell
61 Add Terrain.SetWaterCell
55 Change Tags of Terrain from [preliminary, NotCreatable] to [NotCreatable]
55 Add Terrain.Anchored
55 Add Terrain.Archivable
55 Add Terrain.BrickColor
55 Add Terrain.CFrame
55 Add Terrain.CanCollide
55 Add Terrain.Elasticity
55 Add Terrain.Friction
55 Add Terrain.Locked
55 Add Terrain.Material
55 Add Terrain.Name
55 Add Terrain.Position
55 Add Terrain.Reflectance
55 Add Terrain.RotVelocity
55 Add Terrain.Transparency
55 Add Terrain.Velocity
55 Add Terrain.BreakJoints
55 Add Terrain.Clone
55 Add Terrain.Destroy
55 Add Terrain.MakeJoints
55 Add Terrain.Resize
55 Add Terrain.breakJoints
55 Add Terrain.clone
55 Add Terrain.destroy
55 Add Terrain.makeJoints
55 Add Terrain.resize
53 Remove Terrain.DebugAnimation
49 Add Terrain.AutowedgeCell
49 Add Terrain.AutowedgeCells

Members

AutowedgeCell On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	3

Name	Type	Default
x	int	none
y	int	none
z	int	none

Return Type	bool

History

251 Change Tags of Terrain.AutowedgeCell from [] to [Deprecated]
250 Change Tags of Terrain.AutowedgeCell from [Deprecated] to []
251 Change Tags of Terrain.AutowedgeCell from [] to [Deprecated]
49 Add Terrain.AutowedgeCell

Tags: [Deprecated]

AutowedgeCells On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	1

Name	Type	Default
region	Region3int16	none

Return Type	null

History

573 Change ReturnType of Terrain.AutowedgeCells from void to null
251 Change Tags of Terrain.AutowedgeCells from [] to [Deprecated]
250 Change Tags of Terrain.AutowedgeCells from [Deprecated] to []
251 Change Tags of Terrain.AutowedgeCells from [] to [Deprecated]
49 Add Terrain.AutowedgeCells

Tags: [Deprecated]

CanShorelinesBeUpgraded On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool
Security	RobloxScriptSecurity

History

554 Add Terrain.CanShorelinesBeUpgraded

CanSmoothVoxelsBeUpgraded On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool
Security	RobloxScriptSecurity

History

560 Add Terrain.CanSmoothVoxelsBeUpgraded

CellCenterToWorld On DevHub

Parameters	3

Name	Type	Default
x	int	none
y	int	none
z	int	none

Return Type	Vector3

CellCornerToWorld On DevHub

Parameters	3

Name	Type	Default
x	int	none
y	int	none
z	int	none

Return Type	Vector3

Clear On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null

History

573 Change ReturnType of Terrain.Clear from void to null

ConvertToSmooth On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	null
Security	PluginSecurity

History

573 Change ReturnType of Terrain.ConvertToSmooth from void to null
297 Change Tags of Terrain.ConvertToSmooth from [] to [Deprecated]
193 Add Terrain.ConvertToSmooth

Tags: [Deprecated]

CopyRegion On DevHub

Parameters	1

Name	Type	Default
region	Region3int16	none

Return Type	TerrainRegion

History

498 Change ReturnType of Terrain.CopyRegion from Instance to TerrainRegion
130 Add Terrain.CopyRegion

CountCells On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	int

Decoration On DevHub

This member is not scriptable. It cannot be accessed by Lua code.

Value Type	bool
Category	Appearance
Can Load	true
Can Save	true

History

410 Add Terrain.Decoration

Tags: [NotScriptable]

FillBall On DevHub

Parameters	3

Name	Type	Default
center	Vector3	none
radius	float	none
material	Material	none

Return Type	null

History

573 Change ReturnType of Terrain.FillBall from void to null
193 Add Terrain.FillBall

FillBlock On DevHub

Parameters	3

Name	Type	Default
cframe	CFrame	none
size	Vector3	none
material	Material	none

Return Type	null

History

573 Change ReturnType of Terrain.FillBlock from void to null
193 Add Terrain.FillBlock

FillCylinder On DevHub

Parameters	4

Name	Type	Default
cframe	CFrame	none
height	float	none
radius	float	none
material	Material	none

Return Type	null

History

573 Change ReturnType of Terrain.FillCylinder from void to null
392 Add Terrain.FillCylinder

FillRegion On DevHub

Parameters	3

Name	Type	Default
region	Region3	none
resolution	float	none
material	Material	none

Return Type	null

History

573 Change ReturnType of Terrain.FillRegion from void to null
193 Add Terrain.FillRegion

FillWedge On DevHub

Parameters	3

Name	Type	Default
cframe	CFrame	none
size	Vector3	none
material	Material	none

Return Type	null

History

573 Change ReturnType of Terrain.FillWedge from void to null
417 Add Terrain.FillWedge

GetCell On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	3

Name	Type	Default
x	int	none
y	int	none
z	int	none

Return Type	Tuple

History

251 Change Tags of Terrain.GetCell from [] to [Deprecated]
250 Change Tags of Terrain.GetCell from [Deprecated] to []
251 Change Tags of Terrain.GetCell from [] to [Deprecated]

Tags: [Deprecated]

GetMaterialColor On DevHub

Parameters	1

Name	Type	Default
material	Material	none

Return Type	Color3

History

317 Add Terrain.GetMaterialColor

GetTerrainWireframe On DevHub

Parameters	2

Name	Type	Default
cframe	CFrame	none
size	Vector3	none

Return Type	Array
Security	RobloxScriptSecurity

History

565 Add Terrain.GetTerrainWireframe

GetWaterCell On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	3

Name	Type	Default
x	int	none
y	int	none
z	int	none

Return Type	Tuple

History

251 Change Tags of Terrain.GetWaterCell from [] to [Deprecated]
250 Change Tags of Terrain.GetWaterCell from [Deprecated] to []
251 Change Tags of Terrain.GetWaterCell from [] to [Deprecated]
79 Change Tags of Terrain.GetWaterCell from [preliminary] to []
78 Change Tags of Terrain.GetWaterCell from [] to [preliminary]
79 Change Tags of Terrain.GetWaterCell from [preliminary] to []
61 Add Terrain.GetWaterCell

Tags: [Deprecated]

GrassLength On DevHub

This member is not scriptable. It cannot be accessed by Lua code.

This item is not browsable. It is not visible in Studio's object browser.

Value Type	float
Category	Appearance
Can Load	true
Can Save	true
FFlag	GrassLengthCustomization
UIMaximum	1
UIMinimum	0.1

History

595 Add Terrain.GrassLength

Tags: [NotScriptable, NotBrowsable]

IsSmooth On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	bool
Category	Data
Can Load	false
Can Save	false

History

297 Change Tags of Terrain.IsSmooth from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
193 Add Terrain.IsSmooth

Tags: [ReadOnly, NotReplicated, Deprecated]

LastUsedModificationMethod On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	TerrainAcquisitionMethod
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

466 Add Terrain.LastUsedModificationMethod

Tags: [Hidden, NotReplicated]

MaterialColors On DevHub

This member is not scriptable. It cannot be accessed by Lua code.

Value Type	BinaryString
Category	Appearance
Can Load	true
Can Save	true

History

349 Add Terrain.MaterialColors

Tags: [NotScriptable]

MaxExtents On DevHub

This property is read-only. Its value can be read, but it cannot be modified.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	Region3int16
Category	Data
Can Load	false
Can Save	false

Tags: [ReadOnly, NotReplicated]

PasteRegion On DevHub

Parameters	3

Name	Type	Default
region	TerrainRegion	none
corner	Vector3int16	none
pasteEmptyCells	bool	none

Return Type	null

History

573 Change ReturnType of Terrain.PasteRegion from void to null
498 Change Parameters of Terrain.PasteRegion from (Instance region, Vector3int16 corner, bool pasteEmptyCells) to (TerrainRegion region, Vector3int16 corner, bool pasteEmptyCells)
130 Add Terrain.PasteRegion

ReadVoxelChannels On DevHub

Parameters	3

Name	Type	Default
region	Region3	none
resolution	float	none
channelIds	Array	none

Return Type	Dictionary

History

ReadVoxels On DevHub

Parameters	2

Name	Type	Default
region	Region3	none
resolution	float	none

Return Type	Tuple

History

349 Change Tags of Terrain.ReadVoxels from [] to [CustomLuaState]
193 Add Terrain.ReadVoxels

Tags: [CustomLuaState]

ReplaceMaterial On DevHub

Parameters	4

Name	Type	Default
region	Region3	none
resolution	float	none
sourceMaterial	Material	none
targetMaterial	Material	none

Return Type	null

History

573 Change ReturnType of Terrain.ReplaceMaterial from void to null
400 Add Terrain.ReplaceMaterial

ReplaceMaterialInTransform On DevHub

Parameters	4

Name	Type	Default
cframe	CFrame	none
size	Vector3	none
sourceMaterial	Material	none
targetMaterial	Material	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Terrain.ReplaceMaterialInTransform from void to null
566 Add Terrain.ReplaceMaterialInTransform

ReplaceMaterialInTransformSubregion On DevHub

Parameters	5

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

Return Type	null
Security	RobloxScriptSecurity

History

582 Add Terrain.ReplaceMaterialInTransformSubregion

SetCell On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	6

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

Return Type	null

History

573 Change ReturnType of Terrain.SetCell from void to null
251 Change Tags of Terrain.SetCell from [] to [Deprecated]
250 Change Tags of Terrain.SetCell from [Deprecated] to []
251 Change Tags of Terrain.SetCell from [] to [Deprecated]

Tags: [Deprecated]

SetCells On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	4

Name	Type	Default
region	Region3int16	none
material	CellMaterial	none
block	CellBlock	none
orientation	CellOrientation	none

Return Type	null

History

573 Change ReturnType of Terrain.SetCells from void to null
251 Change Tags of Terrain.SetCells from [] to [Deprecated]
250 Change Tags of Terrain.SetCells from [Deprecated] to []
251 Change Tags of Terrain.SetCells from [] to [Deprecated]

Tags: [Deprecated]

SetMaterialColor On DevHub

Parameters	2

Name	Type	Default
material	Material	none
value	Color3	none

Return Type	null

History

573 Change ReturnType of Terrain.SetMaterialColor from void to null
317 Add Terrain.SetMaterialColor

SetMaterialInTransform On DevHub

Parameters	3

Name	Type	Default
cframe	CFrame	none
size	Vector3	none
targetMaterial	Material	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of Terrain.SetMaterialInTransform from void to null
566 Add Terrain.SetMaterialInTransform

SetMaterialInTransformSubregion On DevHub

Parameters	4

Name	Type	Default
cframe	CFrame	none
size	Vector3	none
targetMaterial	Material	none
targetRegion	Region3int16	none

Return Type	null
Security	RobloxScriptSecurity

History

582 Add Terrain.SetMaterialInTransformSubregion

SetWaterCell On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	5

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

Return Type	null

History

573 Change ReturnType of Terrain.SetWaterCell from void to null
251 Change Tags of Terrain.SetWaterCell from [] to [Deprecated]
250 Change Tags of Terrain.SetWaterCell from [Deprecated] to []
251 Change Tags of Terrain.SetWaterCell from [] to [Deprecated]
79 Change Tags of Terrain.SetWaterCell from [preliminary] to []
78 Change Tags of Terrain.SetWaterCell from [] to [preliminary]
79 Change Tags of Terrain.SetWaterCell from [preliminary] to []
61 Add Terrain.SetWaterCell

Tags: [Deprecated]

ShorelinesUpgraded On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

Value Type	bool
Security	RobloxScriptSecurity
Category	Appearance
Can Load	true
Can Save	true

History

554 Add Terrain.ShorelinesUpgraded

Tags: [Hidden]

SmoothRegion On DevHub

Parameters	3

Name	Type	Default
region	Region3	none
resolution	float	none
strength	float	none

Return Type	Tuple
Security	RobloxScriptSecurity

History

569 Add Terrain.SmoothRegion

Tags: [CustomLuaState]

SmoothVoxelsUpgraded On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

Value Type	bool
Security	RobloxScriptSecurity
Category	Appearance
Can Load	true
Can Save	true

History

560 Add Terrain.SmoothVoxelsUpgraded

Tags: [Hidden]

WaterColor On DevHub

Value Type	Color3
Category	Appearance
Can Load	true
Can Save	true

History

WaterReflectance On DevHub

Value Type	float
Category	Appearance
Can Load	true
Can Save	true
UIMaximum	1
UIMinimum	0

History

262 Add Terrain.WaterReflectance

WaterTransparency On DevHub

Value Type	float
Category	Appearance
Can Load	true
Can Save	true
UIMaximum	1
UIMinimum	0

History

WaterWaveSize On DevHub

Value Type	float
Category	Appearance
Can Load	true
Can Save	true
UIMaximum	1
UIMinimum	0

History

WaterWaveSpeed On DevHub

Value Type	float
Category	Appearance
Can Load	true
Can Save	true
UIMaximum	100
UIMinimum	0

History

WorldToCell On DevHub

Parameters	1

Name	Type	Default
position	Vector3	none

Return Type	Vector3

WorldToCellPreferEmpty On DevHub

Parameters	1

Name	Type	Default
position	Vector3	none

Return Type	Vector3

WorldToCellPreferSolid On DevHub

Parameters	1

Name	Type	Default
position	Vector3	none

Return Type	Vector3

WriteVoxelChannels On DevHub

Parameters	3

Name	Type	Default
region	Region3	none
resolution	float	none
channels	Dictionary	none

Return Type	null

History

WriteVoxels On DevHub

Parameters	4

Name	Type	Default
region	Region3	none
resolution	float	none
materials	Array	none
occupancy	Array	none

Return Type	null

History

573 Change ReturnType of Terrain.WriteVoxels from void to null
349 Change Tags of Terrain.WriteVoxels from [] to [CustomLuaState]
193 Add Terrain.WriteVoxels

Tags: [CustomLuaState]

Removed members

Anchored

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	bool
Category
Can Load	false
Can Save	false

History

Tags: [Deprecated]

Archivable

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	bool
Category
Can Load	false
Can Save	false

History

Tags: [Deprecated]

BreakJoints

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	void

History

Tags: [Deprecated]

BrickColor

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	BrickColor
Category
Can Load	false
Can Save	false

History

Tags: [Deprecated]

CFrame

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	CoordinateFrame
Category
Can Load	false
Can Save	false

History

Tags: [Deprecated]

CanCollide

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	bool
Category
Can Load	false
Can Save	false

History

Tags: [Deprecated]

CancelImportHeightmap

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

484 Remove Terrain.CancelImportHeightmap
457 Add Terrain.CancelImportHeightmap

Clone

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	Instance

History

Tags: [Deprecated]

DebugAnimation

This member is hidden. It is not meant to be used, and may have unresolved issues.

Value Type	bool
Category
Can Load	false
Can Save	false

History

53 Remove Terrain.DebugAnimation

Tags: [Hidden]

Destroy

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	void

History

Tags: [Deprecated]

Elasticity

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	float
Category
Can Load	false
Can Save	false

History

Tags: [Deprecated]

Friction

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	float
Category
Can Load	false
Can Save	false

History

Tags: [Deprecated]

HideTerrainRegion

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

565 Remove Terrain.HideTerrainRegion
549 Add Terrain.HideTerrainRegion

ImportHeightMap

Parameters	3

Name	Type	Default
heightMapBinary	string	none
colorMapBinary	string	none
region	Region3	none

Return Type	void
Security	RobloxScriptSecurity

History

462 Remove Terrain.ImportHeightMap
391 Add Terrain.ImportHeightMap

Tags: [CustomLuaState]

ImportHeightmap

This function yields. It will block the calling thread until completion.

Parameters	4

Name	Type	Default
region	Region3	none
heightmapAssetId	Content	none
colormapAssetId	Content	none
defaultMaterial	Material	none

Return Type	void
Security	RobloxScriptSecurity

History

484 Remove Terrain.ImportHeightmap
457 Add Terrain.ImportHeightmap

Tags: [Yields]

Locked

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	bool
Category
Can Load	false
Can Save	false

History

Tags: [Deprecated]

MakeJoints

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	void

History

Tags: [Deprecated]

Material

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	Material
Category
Can Load	false
Can Save	false

History

Tags: [Deprecated]

Name

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	string
Category
Can Load	false
Can Save	false

History

Tags: [Deprecated]

Position

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	Vector3
Category
Can Load	false
Can Save	false

History

Tags: [Deprecated]

Reflectance

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	float
Category
Can Load	false
Can Save	false

History

Tags: [Deprecated]

Resize

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	2

Name	Type	Default
normalId	NormalId	none
deltaAmount	int	none

Return Type	bool

History

Tags: [Deprecated]

RotVelocity

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	Vector3
Category
Can Load	false
Can Save	false

History

Tags: [Deprecated]

SetImportHeightmapPaused

Parameters	1

Name	Type	Default
paused	bool	none

Return Type	void
Security	RobloxScriptSecurity

History

484 Remove Terrain.SetImportHeightmapPaused
457 Add Terrain.SetImportHeightmapPaused

SetTerrainRegion

Parameters	2

Name	Type	Default
cframe	CFrame	none
size	Vector3	none

Return Type	void
Security	RobloxScriptSecurity

History

565 Remove Terrain.SetTerrainRegion
549 Add Terrain.SetTerrainRegion

SetWireframeRegion

Parameters	2

Name	Type	Default
cframe	CFrame	none
size	Vector3	none

Return Type	void
Security	RobloxScriptSecurity

History

565 Remove Terrain.SetWireframeRegion
549 Add Terrain.SetWireframeRegion

ShowTerrainRegion

Parameters	0

Name	Type	Default
No parameters.

Return Type	void
Security	RobloxScriptSecurity

History

565 Remove Terrain.ShowTerrainRegion
549 Add Terrain.ShowTerrainRegion

TerrainProgressUpdate

Parameters	1

Name	Type	Default
progressRatio	float	none

Security	RobloxScriptSecurity

History

484 Remove Terrain.TerrainProgressUpdate
391 Add Terrain.TerrainProgressUpdate

Transparency

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	float
Category
Can Load	false
Can Save	false

History

Tags: [Deprecated]

Velocity

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Value Type	Vector3
Category
Can Load	false
Can Save	false

History

Tags: [Deprecated]

breakJoints

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	void

History

Tags: [Deprecated]

clone

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	Instance

History

Tags: [Deprecated]

destroy

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	void

History

Tags: [Deprecated]

makeJoints

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	void

History

Tags: [Deprecated]

resize

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	2

Name	Type	Default
normalId	NormalId	none
deltaAmount	int	none

Return Type	bool

History

Tags: [Deprecated]

Relevant classes (1)

TerrainRegion

Relevant enums (7)

Relevant members (1)

Workspace.Terrain