Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Terrain

Terrain lets you to create dynamically morphable environments.

This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryInstances
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
652AudioCanCollide: bool
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
648GetConnectedParts(recursive: bool = false): Instances
648GetJoints(): Instances
486GetMass(): float
567GetNetworkOwner(): Instance
567GetNetworkOwnershipAuto(): bool
648GetNoCollisionConstraints(): Instances
462GetRenderCFrame(): CFrame
486GetRootPart(): Instance
648GetTouchingParts(): Instances
557GetVelocityAtPosition(position: Vector3): Vector3
648IntersectAsync(parts: Instances, collisionfidelity: CollisionFidelity = Default, renderFidelity: RenderFidelity = Automatic): Instance
486IsGrounded(): bool
573MakeJoints(): null
462Resize(normalId: NormalId, deltaAmount: int): bool
573SetNetworkOwner(playerInstance: Player = Player): null
573SetNetworkOwnershipAuto(): null
648SubtractAsync(parts: Instances, collisionfidelity: CollisionFidelity = Default, renderFidelity: RenderFidelity = Automatic): Instance
603TorqueToAngularAcceleration(torque: Vector3, angVelocity: Vector3 = 0, 0, 0): Vector3
648UnionAsync(parts: Instances, collisionfidelity: CollisionFidelity = Default, renderFidelity: RenderFidelity = Automatic): Instance
573breakJoints(): null
641getMass(): 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
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
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
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: 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
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

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)

Description

Terrain lets you create dynamically morphable environments with little to no lag. It is currently based on a 4×4×4 grid of cells, where each cell has a number between 0 and 1 representing how much the geometry should occupy the cell, and the material of the cell. The occupancy determines how the cell will morph together with surrounding cells, and the result is the illusion of having no grid constraint.

For more information, see Terrain.

History 254

Members 56

AutowedgeCell

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

(OBSOLETE) No longer does anything.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 5

Tags: [Deprecated]

AutowedgeCells

Parameters (1)
regionRegion3int16
Returns (1)
null

(OBSOLETE) No longer does anything.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 6

Tags: [Deprecated]

CanShorelinesBeUpgraded

Parameters (0)
No parameters.
Returns (1)
bool
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

CanSmoothVoxelsBeUpgraded

Parameters (0)
No parameters.
Returns (1)
bool
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

CellCenterToWorld

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

Returns the world position of the center of the terrain cell (x, y, z).

Thread safetyUnsafe

History 2

CellCornerToWorld

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

Returns the position of the lower-left-forward corner of the grid cell (x, y, z).

Thread safetyUnsafe

History 2

Clear

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

Clears the terrain.

Thread safetyUnsafe

History 3

ConvertToSmooth

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

Transforms the legacy terrain engine into the new terrain engine.

All places now automatically use the new terrain engine, so this method is obsolete.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
SecurityPluginSecurity
Thread safetyUnsafe

History 4

Tags: [Deprecated]

CopyRegion

Parameters (1)
regionRegion3int16
Returns (1)
TerrainRegion

Stores a chunk of terrain into a TerrainRegion object so it can be loaded back later. Note: TerrainRegion data does not replicate between server and client.

Thread safetyUnsafe

History 3

CountCells

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

Returns the number of non-empty cells in the Terrain.

Thread safetyUnsafe

History 2

Decoration

TypeDefault
boolfalse

Currently enables or disables animated grass on the Grass terrain material, although future modifications of this property may control additional decorative features.

This property is not scriptable. It cannot be accessed by script code.
Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 4

Tags: [NotScriptable]

FillBall

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

Fills a ball of smooth terrain in a given space.

Thread safetyUnsafe

History 3

FillBlock

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

Fills a block of smooth terrain with a given location, rotation, size, and material.

Thread safetyUnsafe

History 3

FillCylinder

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

Fills a cylinder of smooth terrain in a given space. The space is defined using a CFrame, height, and radius.

Usage

1

workspace.Terrain:FillCylinder(CFrame.new(0, 50, 0), 5, 30, Enum.Material.Asphalt)
Thread safetyUnsafe

History 3

FillRegion

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

Fills a Region3 space with smooth terrain.

Thread safetyUnsafe

History 3

FillWedge

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

FillWedge() fills a wedge-shaped volume of Terrain with the given Material and the area's CFrame and size. The orientation of the wedge is the same as an equivalent WedgePart.

Thread safetyUnsafe

History 3

GetCell

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

Returns the closest CellMaterial from the legacy terrain engine that matches the smooth terrain voxel specified. CellBlock will always be ''Solid'' and CellOrientation will always be ''NegZ''.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 5

Tags: [Deprecated]

GetMaterialColor

Parameters (1)
materialMaterial
Returns (1)
Color3

Returns the current terrain material color for the specified terrain material.

Thread safetySafe

History 3

GetTerrainWireframe

Parameters (2)
cframeCFrame
sizeVector3
Returns (1)
Array
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

GetWaterCell

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

Returns if the cell is a water cell. The WaterForce parameter will always be None and the WaterDirection will always be NegX.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 8

Tags: [Deprecated]

GrassLength

TypeDefault
float0.699999988

Specifies the length of animated grass on the Grass terrain material, assuming Decoration is enabled. Valid values are between 0.1 and 1.

This property is not scriptable. It cannot be accessed by script code.
Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 2

Tags: [NotScriptable]

IsSmooth

TypeDefault
booltrue

Returns true if the current game is using the smooth terrain system. The legacy terrain engine has been removed, so this property will always be true.

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.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 5

Tags: [ReadOnly, NotReplicated, Deprecated]

MaterialColors

TypeDefault
BinaryString

MaterialColors represents the editor for the Material Color feature, and cannot be edited by scripts.

To get the color of a material, use: Terrain:GetMaterialColor()

To set the color of a material, use: Terrain:SetMaterialColor()

This property is not scriptable. It cannot be accessed by script code.
Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 3

Tags: [NotScriptable]

MaxExtents

TypeDefault
Region3int16

Displays the boundaries of the largest possible editable region.

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.
Thread safetyReadSafe
CategoryData
Loaded/Savedfalse

History 4

Tags: [ReadOnly, NotReplicated]

PasteRegion

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

Applies a chunk of terrain to the Terrain object. Note: TerrainRegion data does not replicate between server and client.

Thread safetyUnsafe

History 4

ReadVoxelChannels

Parameters (3)
regionRegion3
resolutionfloat
channelIdsArray
Returns (1)
Dictionary

Returns a region of terrain voxel data in table format based on the channel names.

This function has a custom internal state. It may behave in a non-standard way.
Thread safetySafe

History 4

Tags: [CustomLuaState]

ReadVoxels

Parameters (2)
regionRegion3
resolutionfloat
Returns (1)
Tuple

Returns a certain region of smooth terrain in table format.

This function has a custom internal state. It may behave in a non-standard way.
Thread safetySafe

History 4

Tags: [CustomLuaState]

ReplaceMaterial

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

ReplaceMaterial replaces terrain of a certain Material within a Region3 with another material. Essentially, it is a find-and-replace operation on Terrain materials.

Constraints

When calling this method, the resolution parameter must be exactly 4. Additionally, the Region3 must be aligned to the terrain materials grid, i.e. the components of the Region3's minimum and maximum points must be divisible by 4. Use Region3:ExpandToGrid() to make a region compatible with this function.

Thread safetyUnsafe

History 3

ReplaceMaterialInTransform

Parameters (4)
cframeCFrame
sizeVector3
sourceMaterialMaterial
targetMaterialMaterial
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

ReplaceMaterialInTransformSubregion

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

History 1

SetCell

Parameters (6)
xint
yint
zint
materialCellMaterial
blockCellBlock
orientationCellOrientation
Returns (1)
null

Sets the occupancy of the specified terrain voxel to 1, and sets it's material to the closest smooth terrain material that matches the CellMaterial.

CellBlock and CellOrientation have no effect.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 6

Tags: [Deprecated]

SetCells

Parameters (4)
regionRegion3int16
materialCellMaterial
blockCellBlock
orientationCellOrientation
Returns (1)
null

Sets the occupancy of all terrain voxels in the specified region to 1, and sets their materials to the closest smooth terrain material that matches the CellMaterial.

CellBlock and CellOrientation have no effect.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 6

Tags: [Deprecated]

SetMaterialColor

Parameters (2)
materialMaterial
valueColor3
Returns (1)
null

Sets current terrain material color for specified terrain material. Terrain material will shift its base color toward specified color.

Thread safetyUnsafe

History 3

SetMaterialInTransform

Parameters (3)
cframeCFrame
sizeVector3
targetMaterialMaterial
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

SetMaterialInTransformSubregion

Parameters (4)
cframeCFrame
sizeVector3
targetMaterialMaterial
targetRegionRegion3int16
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

SetWaterCell

Parameters (5)
xint
yint
zint
forceWaterForce
directionWaterDirection
Returns (1)
null

Sets the specified terrain voxel's material to ''Water'' and sets its occupancy to 1. WaterDirection and WaterForce no longer have any effect.

Note: This API was intended for Roblox's old terrain system, which has since been removed from the engine.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

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.
SecurityRobloxScriptSecurity
Thread safetySafe

History 1

Tags: [CustomLuaState]

WaterColor

TypeDefault
Color30.05, 0.33, 0.36

The tint of the Terrain water.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 6

WaterReflectance

TypeDefault
float1

Controls how opaque the Terrain's water reflections are.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 4

WaterTransparency

TypeDefault
float0.300000012

The transparency of the Terrain water.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 6

WaterWaveSize

TypeDefault
float0.150000006

Sets the maximum height of the Terrain water waves in studs. This is currently constrained to between 0 and 1.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 6

WaterWaveSpeed

TypeDefault
float10

Sets how many times the Terrain water waves will move up and down per minute. This is currently constrained to between 0 and 100.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 6

WorldToCell

Parameters (1)
positionVector3
Returns (1)
Vector3

Returns the grid cell location that contains the point position.

Thread safetyUnsafe

History 2

WorldToCellPreferEmpty

Parameters (1)
positionVector3
Returns (1)
Vector3

Returns the grid cell location that contains the point position, preferring empty grid cells when position is on a grid edge.

Thread safetyUnsafe

History 2

WorldToCellPreferSolid

Parameters (1)
positionVector3
Returns (1)
Vector3

Returns the grid cell location that contains the point position, preferring non-empty grid cells when position is on a grid edge.

Thread safetyUnsafe

History 2

WriteVoxelChannels

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

Sets a region of terrain using a dictionary of voxel channel data.

This function has a custom internal state. It may behave in a non-standard way.
Thread safetyUnsafe

History 4

Tags: [CustomLuaState]

WriteVoxels

Parameters (4)
regionRegion3
resolutionfloat
materialsArray
occupancyArray
Returns (1)
null

Sets a certain region of smooth terrain using table format.

This function has a custom internal state. It may behave in a non-standard way.
Thread safetyUnsafe

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.
Category
Loaded/Savedfalse

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.
Category
Loaded/Savedfalse

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.
Category
Loaded/Savedfalse

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.
Category
Loaded/Savedfalse

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.
Category
Loaded/Savedfalse

History 2

Tags: [Deprecated]

CancelImportHeightmap

Parameters (0)
No parameters.
Returns (1)
void
SecurityRobloxScriptSecurity
Thread safetyUnsafe

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.
Category
Loaded/Savedfalse

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.
Category
Loaded/Savedfalse

History 2

Tags: [Deprecated]

HideTerrainRegion

Parameters (0)
No parameters.
Returns (1)
void
SecurityRobloxScriptSecurity
Thread safetyUnsafe

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

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.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

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.
Category
Loaded/Savedfalse

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.
Category
Loaded/Savedfalse

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.
Category
Loaded/Savedfalse

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.
Category
Loaded/Savedfalse

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.
Category
Loaded/Savedfalse

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.
Category
Loaded/Savedfalse

History 2

Tags: [Deprecated]

SetImportHeightmapPaused

Parameters (1)
pausedbool
Returns (1)
void
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 3

SetTerrainRegion

Parameters (2)
cframeCFrame
sizeVector3
Returns (1)
void
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

SetWireframeRegion

Parameters (2)
cframeCFrame
sizeVector3
Returns (1)
void
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

ShowTerrainRegion

Parameters (0)
No parameters.
Returns (1)
void
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

TerrainProgressUpdate

Parameters (1)
progressRatiofloat
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 3

Transparency

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

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.
Category
Loaded/Savedfalse

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