Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Terrain

Summary

This class is not creatable. Instances of this class cannot be created with Instance.new.
Tags: [NotCreatable]

Member index 56

HistoryMember
553Decoration: bool
623GrassLength: float
553IsSmooth: bool
486MaterialColors: BinaryString
553MaxExtents: Region3int16
553WaterColor: Color3
553WaterReflectance: float
553WaterTransparency: float
553WaterWaveSize: float
553WaterWaveSpeed: float
462AutowedgeCell(x: int, y: int, z: int): bool
573AutowedgeCells(region: Region3int16): null
554CanShorelinesBeUpgraded(): bool
560CanSmoothVoxelsBeUpgraded(): bool
462CellCenterToWorld(x: int, y: int, z: int): Vector3
462CellCornerToWorld(x: int, y: int, z: int): Vector3
573Clear(): null
573ConvertToSmooth(): null
498CopyRegion(region: Region3int16): TerrainRegion
462CountCells(): int
573FillBall(center: Vector3, radius: float, material: Material): null
573FillBlock(cframe: CFrame, size: Vector3, material: Material): null
573FillCylinder(cframe: CFrame, height: float, radius: float, material: Material): null
573FillRegion(region: Region3, resolution: float, material: Material): null
573FillWedge(cframe: CFrame, size: Vector3, material: Material): null
462GetCell(x: int, y: int, z: int): Tuple
567GetMaterialColor(material: Material): Color3
565GetTerrainWireframe(cframe: CFrame, size: Vector3): Array
462GetWaterCell(x: int, y: int, z: int): Tuple
573PasteRegion(region: TerrainRegion, corner: Vector3int16, pasteEmptyCells: bool): null
616ReadVoxelChannels(region: Region3, resolution: float, channelIds: Array): Dictionary
486ReadVoxels(region: Region3, resolution: float): Tuple
573ReplaceMaterial(region: Region3, resolution: float, sourceMaterial: Material, targetMaterial: Material): null
573ReplaceMaterialInTransform(cframe: CFrame, size: Vector3, sourceMaterial: Material, targetMaterial: Material): null
582ReplaceMaterialInTransformSubregion(cframe: CFrame, size: Vector3, sourceMaterial: Material, targetMaterial: Material, targetRegion: Region3int16): null
573SetCell(x: int, y: int, z: int, material: CellMaterial, block: CellBlock, orientation: CellOrientation): null
573SetCells(region: Region3int16, material: CellMaterial, block: CellBlock, orientation: CellOrientation): null
573SetMaterialColor(material: Material, value: Color3): null
573SetMaterialInTransform(cframe: CFrame, size: Vector3, targetMaterial: Material): null
582SetMaterialInTransformSubregion(cframe: CFrame, size: Vector3, targetMaterial: Material, targetRegion: Region3int16): null
573SetWaterCell(x: int, y: int, z: int, force: WaterForce, direction: WaterDirection): null
569SmoothRegion(region: Region3, resolution: float, strength: float): Tuple
462WorldToCell(position: Vector3): Vector3
462WorldToCellPreferEmpty(position: Vector3): Vector3
462WorldToCellPreferSolid(position: Vector3): Vector3
616WriteVoxelChannels(region: Region3, resolution: float, channels: Dictionary): null
573WriteVoxels(region: Region3, resolution: float, materials: Array, occupancy: Array): null
inherited from BasePart
553Anchored: bool
553AssemblyAngularVelocity: Vector3
553AssemblyCenterOfMass: Vector3
553AssemblyLinearVelocity: Vector3
553AssemblyMass: float
553AssemblyRootPart: BasePart
553BackSurface: SurfaceType
553BottomSurface: SurfaceType
553BrickColor: BrickColor
553CFrame: CFrame
553CanCollide: bool
553CanQuery: bool
553CanTouch: bool
553CastShadow: bool
553CenterOfMass: Vector3
553CollisionGroup: string
574CollisionGroupId: int
553Color: Color3
553CurrentPhysicalProperties: PhysicalProperties
553CustomPhysicalProperties: PhysicalProperties
581EnableFluidForces: bool
553ExtentsCFrame: CFrame
553ExtentsSize: Vector3
553FrontSurface: SurfaceType
553LeftSurface: SurfaceType
553Locked: bool
553Mass: float
553Massless: bool
553Material: Material
553MaterialVariant: string
553PivotOffset: CFrame
553Reflectance: float
553ResizeIncrement: int
553ResizeableFaces: Faces
553RightSurface: SurfaceType
553RootPriority: int
553Rotation: Vector3
553Size: Vector3
553SpecificGravity: float
553TopSurface: SurfaceType
553Transparency: float
553brickColor: BrickColor
603AngularAccelerationToTorque(angAcceleration: Vector3, angVelocity: Vector3 = 0, 0, 0): Vector3
573ApplyAngularImpulse(impulse: Vector3): null
573ApplyImpulse(impulse: Vector3): null
573ApplyImpulseAtPosition(impulse: Vector3, position: Vector3): null
573BreakJoints(): null
557CanCollideWith(part: BasePart): bool
462CanSetNetworkOwnership(): Tuple
576GetClosestPointOnSurface(position: Vector3): Vector3
486GetConnectedParts(recursive: bool = false): Objects
486GetJoints(): Objects
486GetMass(): float
567GetNetworkOwner(): Instance
567GetNetworkOwnershipAuto(): bool
583GetNoCollisionConstraints(): Objects
462GetRenderCFrame(): CFrame
486GetRootPart(): Instance
462GetTouchingParts(): Objects
557GetVelocityAtPosition(position: Vector3): Vector3
564IntersectAsync(parts: Objects, collisionfidelity: CollisionFidelity = Default, renderFidelity: RenderFidelity = Automatic): Instance
486IsGrounded(): bool
573MakeJoints(): null
462Resize(normalId: NormalId, deltaAmount: int): bool
573SetNetworkOwner(playerInstance: Player = Player): null
573SetNetworkOwnershipAuto(): null
462SubtractAsync(parts: Objects, collisionfidelity: CollisionFidelity = Default, renderFidelity: RenderFidelity = Automatic): Instance
603TorqueToAngularAcceleration(torque: Vector3, angVelocity: Vector3 = 0, 0, 0): Vector3
462UnionAsync(parts: Objects, collisionfidelity: CollisionFidelity = Default, renderFidelity: RenderFidelity = Automatic): Instance
573breakJoints(): null
462getMass(): float
573makeJoints(): null
553resize(normalId: NormalId, deltaAmount: int): bool
483LocalSimulationTouched(part: BasePart)
462OutfitChanged()
553StoppedTouching(otherPart: BasePart)
483TouchEnded(otherPart: BasePart)
483Touched(otherPart: BasePart)
inherited from PVInstance
553Origin: CFrame
553Pivot Offset: CFrame
576GetPivot(): CFrame
573PivotTo(targetCFrame: CFrame): null
inherited from Instance
553Archivable: bool
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 35

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

History 254

Members 56

AutowedgeCell

Parameters (3)
xint
yint
zint
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 5

Tags: [Deprecated]

AutowedgeCells

Parameters (1)
regionRegion3int16
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 6

Tags: [Deprecated]

CanShorelinesBeUpgraded

Parameters (0)
No parameters.
Returns (1)
bool

History 1

CanSmoothVoxelsBeUpgraded

Parameters (0)
No parameters.
Returns (1)
bool

History 1

CellCenterToWorld

Parameters (3)
xint
yint
zint
Returns (1)
Vector3

History 2

CellCornerToWorld

Parameters (3)
xint
yint
zint
Returns (1)
Vector3

History 2

Clear

Parameters (0)
No parameters.
Returns (1)
null

History 3

ConvertToSmooth

Parameters (0)
No parameters.
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 4

Tags: [Deprecated]

CopyRegion

Parameters (1)
regionRegion3int16
Returns (1)
TerrainRegion

History 3

CountCells

Parameters (0)
No parameters.
Returns (1)
int

History 2

Decoration

TypeDefault
boolfalse
This property is not scriptable. It cannot be accessed by script code.

History 4

Tags: [NotScriptable]

FillBall

Parameters (3)
centerVector3
radiusfloat
materialMaterial
Returns (1)
null

History 3

FillBlock

Parameters (3)
cframeCFrame
sizeVector3
materialMaterial
Returns (1)
null

History 3

FillCylinder

Parameters (4)
cframeCFrame
heightfloat
radiusfloat
materialMaterial
Returns (1)
null

History 3

FillRegion

Parameters (3)
regionRegion3
resolutionfloat
materialMaterial
Returns (1)
null

History 3

FillWedge

Parameters (3)
cframeCFrame
sizeVector3
materialMaterial
Returns (1)
null

History 3

GetCell

Parameters (3)
xint
yint
zint
Returns (1)
Tuple
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 5

Tags: [Deprecated]

GetMaterialColor

Parameters (1)
materialMaterial
Returns (1)
Color3

History 3

GetTerrainWireframe

Parameters (2)
cframeCFrame
sizeVector3
Returns (1)
Array

History 1

GetWaterCell

Parameters (3)
xint
yint
zint
Returns (1)
Tuple
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 8

Tags: [Deprecated]

GrassLength

TypeDefault
float0.699999988
This property is not scriptable. It cannot be accessed by script code.

History 2

Tags: [NotScriptable]

IsSmooth

TypeDefault
booltrue
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated, Deprecated]

MaterialColors

TypeDefault
BinaryString
This property is not scriptable. It cannot be accessed by script code.

History 3

Tags: [NotScriptable]

MaxExtents

TypeDefault
Region3int16
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

PasteRegion

Parameters (3)
regionTerrainRegion
cornerVector3int16
pasteEmptyCellsbool
Returns (1)
null

History 4

ReadVoxelChannels

Parameters (3)
regionRegion3
resolutionfloat
channelIdsArray
Returns (1)
Dictionary
This function has a custom internal state. It may behave in a non-standard way.

History 4

Tags: [CustomLuaState]

ReadVoxels

Parameters (2)
regionRegion3
resolutionfloat
Returns (1)
Tuple
This function has a custom internal state. It may behave in a non-standard way.

History 4

Tags: [CustomLuaState]

ReplaceMaterial

Parameters (4)
regionRegion3
resolutionfloat
sourceMaterialMaterial
targetMaterialMaterial
Returns (1)
null

History 3

ReplaceMaterialInTransform

Parameters (4)
cframeCFrame
sizeVector3
sourceMaterialMaterial
targetMaterialMaterial
Returns (1)
null

History 2

ReplaceMaterialInTransformSubregion

Parameters (5)
cframeCFrame
sizeVector3
sourceMaterialMaterial
targetMaterialMaterial
targetRegionRegion3int16
Returns (1)
null

History 1

SetCell

Parameters (6)
xint
yint
zint
materialCellMaterial
blockCellBlock
orientationCellOrientation
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 6

Tags: [Deprecated]

SetCells

Parameters (4)
regionRegion3int16
materialCellMaterial
blockCellBlock
orientationCellOrientation
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 6

Tags: [Deprecated]

SetMaterialColor

Parameters (2)
materialMaterial
valueColor3
Returns (1)
null

History 3

SetMaterialInTransform

Parameters (3)
cframeCFrame
sizeVector3
targetMaterialMaterial
Returns (1)
null

History 2

SetMaterialInTransformSubregion

Parameters (4)
cframeCFrame
sizeVector3
targetMaterialMaterial
targetRegionRegion3int16
Returns (1)
null

History 1

SetWaterCell

Parameters (5)
xint
yint
zint
forceWaterForce
directionWaterDirection
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 9

Tags: [Deprecated]

SmoothRegion

Parameters (3)
regionRegion3
resolutionfloat
strengthfloat
Returns (1)
Tuple
This function has a custom internal state. It may behave in a non-standard way.

History 1

Tags: [CustomLuaState]

WaterColor

TypeDefault
Color30.05, 0.33, 0.36

History 6

WaterReflectance

TypeDefault
float1

History 4

WaterTransparency

TypeDefault
float0.300000012

History 6

WaterWaveSize

TypeDefault
float0.150000006

History 6

WaterWaveSpeed

TypeDefault
float10

History 6

WorldToCell

Parameters (1)
positionVector3
Returns (1)
Vector3

History 2

WorldToCellPreferEmpty

Parameters (1)
positionVector3
Returns (1)
Vector3

History 2

WorldToCellPreferSolid

Parameters (1)
positionVector3
Returns (1)
Vector3

History 2

WriteVoxelChannels

Parameters (3)
regionRegion3
resolutionfloat
channelsDictionary
Returns (1)
null
This function has a custom internal state. It may behave in a non-standard way.

History 4

Tags: [CustomLuaState]

WriteVoxels

Parameters (4)
regionRegion3
resolutionfloat
materialsArray
occupancyArray
Returns (1)
null
This function has a custom internal state. It may behave in a non-standard way.

History 4

Tags: [CustomLuaState]

Removed members 35

Anchored

TypeDefault
bool
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

Archivable

TypeDefault
bool
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

BreakJoints

Parameters (0)
No parameters.
Returns (1)
void
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

BrickColor

TypeDefault
BrickColor
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

CFrame

TypeDefault
CoordinateFrame
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

CanCollide

TypeDefault
bool
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

CancelImportHeightmap

Parameters (0)
No parameters.
Returns (1)
void

History 3

Clone

Parameters (0)
No parameters.
Returns (1)
Instance
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

Destroy

Parameters (0)
No parameters.
Returns (1)
void
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

Elasticity

TypeDefault
float
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

Friction

TypeDefault
float
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

HideTerrainRegion

Parameters (0)
No parameters.
Returns (1)
void

History 2

ImportHeightMap

Parameters (3)
heightMapBinarystring
colorMapBinarystring
regionRegion3
Returns (1)
void
This function has a custom internal state. It may behave in a non-standard way.

History 2

Tags: [CustomLuaState]

ImportHeightmap

Parameters (4)
regionRegion3
heightmapAssetIdContent
colormapAssetIdContent
defaultMaterialMaterial
Returns (1)
void
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

Locked

TypeDefault
bool
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

MakeJoints

Parameters (0)
No parameters.
Returns (1)
void
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

Material

TypeDefault
Material
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

Name

TypeDefault
string
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

Position

TypeDefault
Vector3
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

Reflectance

TypeDefault
float
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

Resize

Parameters (2)
normalIdNormalId
deltaAmountint
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

RotVelocity

TypeDefault
Vector3
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

SetImportHeightmapPaused

Parameters (1)
pausedbool
Returns (1)
void

History 3

SetTerrainRegion

Parameters (2)
cframeCFrame
sizeVector3
Returns (1)
void

History 2

SetWireframeRegion

Parameters (2)
cframeCFrame
sizeVector3
Returns (1)
void

History 2

ShowTerrainRegion

Parameters (0)
No parameters.
Returns (1)
void

History 2

TerrainProgressUpdate

Parameters (1)
progressRatiofloat

History 3

Transparency

TypeDefault
float
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

Velocity

TypeDefault
Vector3
This property is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

breakJoints

Parameters (0)
No parameters.
Returns (1)
void
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

clone

Parameters (0)
No parameters.
Returns (1)
Instance
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

destroy

Parameters (0)
No parameters.
Returns (1)
void
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

makeJoints

Parameters (0)
No parameters.
Returns (1)
void
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

resize

Parameters (2)
normalIdNormalId
deltaAmountint
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

Settings