Roblox API Reference

Terrain On DevHub

Summary

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

Tags: [NotCreatable]

Inherits (3)

Member index (38)

Type Member History
bool Decoration 410
bool IsSmooth 193 297
BinaryString MaterialColors 349
Region3int16 MaxExtents
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
void AutowedgeCells (Region3int16 region) 49 251 250 251
Vector3 CellCenterToWorld (int x, int y, int z)
Vector3 CellCornerToWorld (int x, int y, int z)
void Clear ()
void ConvertToSmooth () 193 297
Instance CopyRegion (Region3int16 region) 130
int CountCells ()
void FillBall (Vector3 center, float radius, Material material) 193
void FillBlock (CFrame cframe, Vector3 size, Material material) 193
void FillCylinder (CFrame cframe, float height, float radius, Material material) 392
void FillRegion (Region3 region, float resolution, Material material) 193
void FillWedge (CFrame cframe, Vector3 size, Material material) 417
Tuple GetCell (int x, int y, int z) 251 250 251
Color3 GetMaterialColor (Material material) 317
Tuple GetWaterCell (int x, int y, int z) 61 79 78 79 251 250 251
void ImportHeightMap (string heightMapBinary, string colorMapBinary, Region3 region) 391
void PasteRegion (Instance region, Vector3int16 corner, bool pasteEmptyCells) 130
Tuple ReadVoxels (Region3 region, float resolution) 193 349
void ReplaceMaterial (Region3 region, float resolution, Material sourceMaterial, Material targetMaterial) 400
void SetCell (int x, int y, int z, CellMaterial material, CellBlock block, CellOrientation orientation) 251 250 251
void SetCells (Region3int16 region, CellMaterial material, CellBlock block, CellOrientation orientation) 251 250 251
void SetMaterialColor (Material material, Color3 value) 317
void SetWaterCell (int x, int y, int z, WaterForce force, WaterDirection direction) 61 79 78 79 251 250 251
Vector3 WorldToCell (Vector3 position)
Vector3 WorldToCellPreferEmpty (Vector3 position)
Vector3 WorldToCellPreferSolid (Vector3 position)
void WriteVoxels (Region3 region, float resolution, Array materials, Array occupancy) 193 349
TerrainProgressUpdate (float progressRatio) 391
82 members inherited from BasePart
47 members inherited from Instance

Removed member index (26)

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
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
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

History

Members

AutowedgeCell On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
x int none
y int none
z int none

History

Tags: [Deprecated]

AutowedgeCells On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
region Region3int16 none

History

Tags: [Deprecated]

CellCenterToWorld On DevHub

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

CellCornerToWorld On DevHub

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

Clear On DevHub

Name Type Default
No parameters.

ConvertToSmooth On DevHub

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

History

Tags: [Deprecated]

CopyRegion On DevHub

Name Type Default
region Region3int16 none

History

CountCells On DevHub

Name Type Default
No parameters.

Decoration On DevHub

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

History

Tags: [NotScriptable]

FillBall On DevHub

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

History

FillBlock On DevHub

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

History

FillCylinder On DevHub

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

History

FillRegion On DevHub

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

History

FillWedge On DevHub

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

History

GetCell On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
x int none
y int none
z int none

History

Tags: [Deprecated]

GetMaterialColor On DevHub

Name Type Default
material Material none

History

GetWaterCell On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
x int none
y int none
z int none

History

Tags: [Deprecated]

ImportHeightMap On DevHub

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

History

Tags: [CustomLuaState]

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.

History

Tags: [ReadOnly, NotReplicated, Deprecated]

MaterialColors On DevHub

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

History

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.

Tags: [ReadOnly, NotReplicated]

PasteRegion On DevHub

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

History

ReadVoxels On DevHub

Name Type Default
region Region3 none
resolution float none

History

Tags: [CustomLuaState]

ReplaceMaterial On DevHub

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

History

SetCell On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
x int none
y int none
z int none
material CellMaterial none
block CellBlock none
orientation CellOrientation none

History

Tags: [Deprecated]

SetCells On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
region Region3int16 none
material CellMaterial none
block CellBlock none
orientation CellOrientation none

History

Tags: [Deprecated]

SetMaterialColor On DevHub

Name Type Default
material Material none
value Color3 none

History

SetWaterCell On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
x int none
y int none
z int none
force WaterForce none
direction WaterDirection none

History

Tags: [Deprecated]

TerrainProgressUpdate On DevHub

Name Type Default
progressRatio float none

History

WaterColor On DevHub

History

WaterReflectance On DevHub

History

WaterTransparency On DevHub

History

WaterWaveSize On DevHub

History

WaterWaveSpeed On DevHub

History

WorldToCell On DevHub

Name Type Default
position Vector3 none

WorldToCellPreferEmpty On DevHub

Name Type Default
position Vector3 none

WorldToCellPreferSolid On DevHub

Name Type Default
position Vector3 none

WriteVoxels On DevHub

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

History

Tags: [CustomLuaState]

Removed members

Anchored

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

History

Tags: [Deprecated]

Archivable

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

History

Tags: [Deprecated]

BreakJoints

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

History

Tags: [Deprecated]

BrickColor

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

History

Tags: [Deprecated]

CFrame

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

History

Tags: [Deprecated]

CanCollide

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

History

Tags: [Deprecated]

Clone

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

History

Tags: [Deprecated]

DebugAnimation

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

History

Tags: [Hidden]

Destroy

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

History

Tags: [Deprecated]

Elasticity

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

History

Tags: [Deprecated]

Friction

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

History

Tags: [Deprecated]

Locked

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

History

Tags: [Deprecated]

MakeJoints

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

History

Tags: [Deprecated]

Material

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

History

Tags: [Deprecated]

Name

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

History

Tags: [Deprecated]

Position

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

History

Tags: [Deprecated]

Reflectance

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

History

Tags: [Deprecated]

Resize

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
normalId NormalId none
deltaAmount int none

History

Tags: [Deprecated]

RotVelocity

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

History

Tags: [Deprecated]

Transparency

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

History

Tags: [Deprecated]

Velocity

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

History

Tags: [Deprecated]

breakJoints

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

History

Tags: [Deprecated]

clone

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

History

Tags: [Deprecated]

destroy

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

History

Tags: [Deprecated]

makeJoints

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

History

Tags: [Deprecated]

resize

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
normalId NormalId none
deltaAmount int none

History

Tags: [Deprecated]

Relevant classes (1)

Relevant enums (6)