Terrain
CreatorHub

Terrain lets you to create dynamically morphable environments.

Instances of this class cannot be created with Instance.new.

Memory category	Instances

Tags: [NotCreatable]

Member index 59

History		Member
726		Decoration: bool
726		GrassLength: float
726		IsSmooth: bool
726		LastUsedModificationMethod: TerrainAcquisitionMethod
486		MaterialColors: BinaryString
726		MaxExtents: Region3int16
726		SmoothVoxelsUpgraded: bool
726		WaterColor: Color3
726		WaterReflectance: float
726		WaterTransparency: float
726		WaterWaveSize: float
726		WaterWaveSpeed: float
462		AutowedgeCell(x: int, y: int, z: int): bool
573		AutowedgeCells(region: Region3int16): null
560		CanSmoothVoxelsBeUpgraded(): bool
462		CellCenterToWorld(x: int, y: int, z: int): Vector3
462		CellCornerToWorld(x: int, y: int, z: int): Vector3
573		Clear(): null
675		ClearVoxelsAsync_beta(region: Region3, channelIds: Array): null
573		ConvertToSmooth(): null
498		CopyRegion(region: Region3int16): TerrainRegion
462		CountCells(): int
710		CreateVoxelBuffer_beta(): VoxelBuffer
710		DrawBufferAsync(cframe: CFrame, scale: float, resolution: int, source: VoxelBuffer, mergeConfig: Dictionary): null
573		FillBall(center: Vector3, radius: float, material: Material): null
573		FillBlock(cframe: CFrame, size: Vector3, material: Material): null
573		FillCylinder(cframe: CFrame, height: float, radius: float, material: Material): null
573		FillRegion(region: Region3, resolution: float, material: Material): null
573		FillWedge(cframe: CFrame, size: Vector3, material: Material): null
462		GetCell(x: int, y: int, z: int): Tuple
567		GetMaterialColor(material: Material): Color3
719		GetMaterialSlot(slotIndex: int): Tuple
565		GetTerrainWireframe(cframe: CFrame, size: Vector3): Array
462		GetWaterCell(x: int, y: int, z: int): Tuple
675		IterateVoxelsAsync_beta(region: Region3, resolution: int, channelIds: Array): TerrainIterateOperation
675		ModifyVoxelsAsync_beta(region: Region3, resolution: int, channelIds: Array): TerrainModifyOperation
573		PasteRegion(region: TerrainRegion, corner: Vector3int16, pasteEmptyCells: bool): null
710		ReadBufferAsync(region: Region3, resolution: int): VoxelBuffer
616		ReadVoxelChannels(region: Region3, resolution: float, channelIds: Array): Dictionary
486		ReadVoxels(region: Region3, resolution: float): Tuple
675		ReadVoxelsAsync_beta(region: Region3, resolution: int, channelIds: Array): TerrainReadOperation
573		ReplaceMaterial(region: Region3, resolution: float, sourceMaterial: Material, targetMaterial: Material): null
573		ReplaceMaterialInTransform(cframe: CFrame, size: Vector3, sourceMaterial: Material, targetMaterial: Material): null
582		ReplaceMaterialInTransformSubregion(cframe: CFrame, size: Vector3, sourceMaterial: Material, targetMaterial: Material, targetRegion: Region3int16): null
719		ResetMaterialSlot(slotIndex: int): null
573		SetCell(x: int, y: int, z: int, material: CellMaterial, block: CellBlock, orientation: CellOrientation): null
573		SetCells(region: Region3int16, material: CellMaterial, block: CellBlock, orientation: CellOrientation): null
573		SetMaterialColor(material: Material, value: Color3): null
573		SetMaterialInTransform(cframe: CFrame, size: Vector3, targetMaterial: Material): null
582		SetMaterialInTransformSubregion(cframe: CFrame, size: Vector3, targetMaterial: Material, targetRegion: Region3int16): null
719		SetMaterialSlot(slotIndex: int, baseMaterial: Material, materialVariant: string, color: Color3): null
573		SetWaterCell(x: int, y: int, z: int, force: WaterForce, direction: WaterDirection): null
569		SmoothRegion(region: Region3, resolution: float, strength: float): Tuple
462		WorldToCell(position: Vector3): Vector3
462		WorldToCellPreferEmpty(position: Vector3): Vector3
462		WorldToCellPreferSolid(position: Vector3): Vector3
616		WriteVoxelChannels(region: Region3, resolution: float, channels: Dictionary): null
573		WriteVoxels(region: Region3, resolution: float, materials: Array, occupancy: Array): null
675		WriteVoxelsAsync_beta(region: Region3, resolution: int, channelIds: Array): TerrainWriteOperation
106 members inherited from BasePart
726		Anchored: bool
726		AssemblyAngularVelocity: Vector3
726		AssemblyCenterOfMass: Vector3
726		AssemblyLinearVelocity: Vector3
726		AssemblyMass: float
726		AssemblyRootPart: BasePart
726		AudioCanCollide: bool
726		BackParamA: float
726		BackParamB: float
726		BackSurface: SurfaceType
726		BackSurfaceInput: InputType
726		BottomParamA: float
726		BottomParamB: float
726		BottomSurface: SurfaceType
726		BottomSurfaceInput: InputType
726		BrickColor: BrickColor
726		CFrame: CFrame
726		CanCollide: bool
726		CanQuery: bool
726		CanTouch: bool
726		CastShadow: bool
726		CenterOfMass: Vector3
726		CollisionGroup: string
726		CollisionGroupId: int
726		Color: Color3
726		CurrentPhysicalProperties: PhysicalProperties
726		CustomPhysicalProperties: PhysicalProperties
726		Elasticity: float
726		EnableFluidForces: bool
726		ExtentsCFrame: CFrame
726		ExtentsSize: Vector3
726		Friction: float
726		FrontParamA: float
726		FrontParamB: float
726		FrontSurface: SurfaceType
726		FrontSurfaceInput: InputType
726		LeftParamA: float
726		LeftParamB: float
726		LeftSurface: SurfaceType
726		LeftSurfaceInput: InputType
726		LocalTransparencyModifier: float
726		Locked: bool
726		Mass: float
726		Massless: bool
726		Material: Material
726		MaterialVariant: string
726		Orientation: Vector3
726		PivotOffset: CFrame
726		Position: Vector3
726		ReceiveAge: float
726		Reflectance: float
726		ResizeIncrement: int
726		ResizeableFaces: Faces
726		RightParamA: float
726		RightParamB: float
726		RightSurface: SurfaceType
726		RightSurfaceInput: InputType
726		RootPriority: int
726		RotVelocity: Vector3
726		Rotation: Vector3
726		Size: Vector3
726		SpecificGravity: float
726		TopParamA: float
726		TopParamB: float
726		TopSurface: SurfaceType
726		TopSurfaceInput: InputType
726		Transparency: float
726		Velocity: Vector3
726		brickColor: BrickColor
603		AngularAccelerationToTorque(angAcceleration: Vector3, angVelocity: Vector3 = 0, 0, 0): Vector3
573		ApplyAngularImpulse(impulse: Vector3): null
573		ApplyImpulse(impulse: Vector3): null
573		ApplyImpulseAtPosition(impulse: Vector3, position: Vector3): null
573		BreakJoints(): null
557		CanCollideWith(part: BasePart): bool
462		CanSetNetworkOwnership(): Tuple
576		GetClosestPointOnSurface(position: Vector3): Vector3
648		GetConnectedParts(recursive: bool = false): Instances
648		GetJoints(): Instances
486		GetMass(): float
567		GetNetworkOwner(): Instance
567		GetNetworkOwnershipAuto(): bool
648		GetNoCollisionConstraints(): Instances
678		GetPhysicsCost(): float
462		GetRenderCFrame(): CFrame
726		GetRootPart(): Instance
648		GetTouchingParts(): Instances
557		GetVelocityAtPosition(position: Vector3): Vector3
648		IntersectAsync(parts: Instances, collisionfidelity: CollisionFidelity = Default, renderFidelity: RenderFidelity = Automatic): Instance
486		IsGrounded(): bool
573		MakeJoints(): null
462		Resize(normalId: NormalId, deltaAmount: int): bool
573		SetNetworkOwner(playerInstance: Player = Player): null
573		SetNetworkOwnershipAuto(): null
648		SubtractAsync(parts: Instances, collisionfidelity: CollisionFidelity = Default, renderFidelity: RenderFidelity = Automatic): Instance
603		TorqueToAngularAcceleration(torque: Vector3, angVelocity: Vector3 = 0, 0, 0): Vector3
648		UnionAsync(parts: Instances, collisionfidelity: CollisionFidelity = Default, renderFidelity: RenderFidelity = Automatic): Instance
726		breakJoints(): null
726		getMass(): float
573		makeJoints(): null
726		resize(normalId: NormalId, deltaAmount: int): bool
483		LocalSimulationTouched(part: BasePart)
462		OutfitChanged()
726		StoppedTouching(otherPart: BasePart)
483		TouchEnded(otherPart: BasePart)
483		Touched(otherPart: BasePart)
4 members inherited from PVInstance
726		Origin: CFrame
726		Pivot Offset: CFrame
576		GetPivot(): CFrame
573		PivotTo(targetCFrame: CFrame): null
60 members inherited from Instance
726		Archivable: bool
726		Capabilities: SecurityCapabilities
726		DataCost: int
726		IsInSandbox: bool
726		Name: string
726		Parent: Instance
726		PredictionMode: PredictionMode
726		RobloxLocked: bool
726		Sandboxed: bool
726		SourceAssetId: int64
726		UniqueId: UniqueId
726		archivable: bool
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
707		GetDescendants(): Instances
486		GetFullName(): string
706		GetStyled(name: string, selector: string?): Variant
657		GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
664		IsPropertyModified(property: string): bool
698		QueryDescendants(selector: string): Instances
573		Remove(): null
576		RemoveTag(tag: string): null
664		ResetPropertyToDefault(property: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
726		children(): Instances
726		clone(): Instance
726		destroy(): null
726		findFirstChild(name: string, recursive: bool = false): Instance
726		getChildren(): Instances
726		isDescendantOf(ancestor: Instance): bool
726		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
657		StyledPropertiesChanged()
726		childAdded(child: Instance)
6 members inherited from Object
726		ClassName: string
726		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
726		isA(className: string): bool
647		Changed(property: string)

Removed member index 48

History		Member
726		AcquisitionMethod: TerrainAcquisitionMethod
67		Anchored: bool
67		Archivable: bool
67		BrickColor: BrickColor
67		CFrame: CoordinateFrame
67		CanCollide: bool
726		ClusterGrid: string
726		ClusterGridV2: string
726		ClusterGridV3: BinaryString
53		DebugAnimation: bool
67		Elasticity: float
67		Friction: float
67		Locked: bool
67		Material: Material
726		Materials: SharedString
67		Name: string
726		PhysicsGrid: BinaryString
67		Position: Vector3
67		Reflectance: float
67		RotVelocity: Vector3
676		ShorelinesUpgraded: bool
726		SmoothGrid: BinaryString
67		Transparency: float
726		ValidationAssetContentMap: AssetContentMap
67		Velocity: Vector3
726		VoxelGridAssetContentMap: AssetContentMap
67		BreakJoints(): void
668		CanShorelinesBeUpgraded(): bool
484		CancelImportHeightmap(): void
67		Clone(): Instance
67		Destroy(): void
725		GetBaseMaterialSlotIndex(baseMaterial: Material): int?
725		GetFirstCustomMaterialSlotIndex(): int
565		HideTerrainRegion(): void
462		ImportHeightMap(heightMapBinary: string, colorMapBinary: string, region: Region3): void
484		ImportHeightmap(region: Region3, heightmapAssetId: Content, colormapAssetId: Content, defaultMaterial: Material): void
67		MakeJoints(): void
67		Resize(normalId: NormalId, deltaAmount: int): bool
484		SetImportHeightmapPaused(paused: bool): void
565		SetTerrainRegion(cframe: CFrame, size: Vector3): void
565		SetWireframeRegion(cframe: CFrame, size: Vector3): void
565		ShowTerrainRegion(): void
67		breakJoints(): void
67		clone(): Instance
67		destroy(): void
67		makeJoints(): void
67		resize(normalId: NormalId, deltaAmount: int): bool
484		TerrainProgressUpdate(progressRatio: float)

Description

The Terrain class lets you create dynamically morphable environments. It is 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 298
Hide member changes

726 Change Default of WaterWaveSpeed from 10 to
726 Change Default of WaterWaveSize from 0.150000006 to
726 Change Default of WaterTransparency from 0.300000012 to
726 Change Default of WaterReflectance from 1 to
726 Change Default of WaterColor from Color3(0.05, 0.33, 0.36) to
726 Remove VoxelGridAssetContentMap
726 Remove ValidationAssetContentMap
726 Change Default of SmoothVoxelsUpgraded from false to
726 Remove SmoothGrid
726 Remove PhysicsGrid
726 Change Default of MaxExtents from to
726 Remove Materials
726 Change Default of LastUsedModificationMethod from None to
726 Change Default of IsSmooth from true to
726 Change Default of GrassLength from 0.699999988 to
726 Change Default of Decoration from false to
726 Remove ClusterGridV3
726 Remove ClusterGridV2
726 Remove ClusterGrid
726 Remove AcquisitionMethod
725 Remove GetFirstCustomMaterialSlotIndex
725 Remove GetBaseMaterialSlotIndex
721 Add ValidationAssetContentMap
719 Add SetMaterialSlot
719 Add ResetMaterialSlot
719 Add GetMaterialSlot
719 Add GetFirstCustomMaterialSlotIndex
719 Add GetBaseMaterialSlotIndex
719 Add Materials
714 Change ReadSecurity of VoxelGridAssetContentMap from None to RobloxScriptSecurity
714 Change WriteSecurity of VoxelGridAssetContentMap from None to RobloxScriptSecurity
712 Add VoxelGridAssetContentMap
710 Add ReadBufferAsync
710 Add DrawBufferAsync
710 Add CreateVoxelBuffer_beta
676 Remove ShorelinesUpgraded
675 Change Default of ShorelinesUpgraded from true to false
675 Add WriteVoxelsAsync_beta
675 Add ReadVoxelsAsync_beta
675 Add ModifyVoxelsAsync_beta
675 Add IterateVoxelsAsync_beta
675 Add ClearVoxelsAsync_beta
671 Change Default of ShorelinesUpgraded from false to true
668 Remove CanShorelinesBeUpgraded
623 Change Tags of GrassLength from [NotScriptable, NotBrowsable] to [NotScriptable]
616 Change Tags of WriteVoxelChannels from [] to [CustomLuaState]
616 Change Tags of ReadVoxelChannels from [] to [CustomLuaState]
604 Add WriteVoxelChannels
604 Add ReadVoxelChannels
603 Remove WriteVoxelChannels
603 Remove ReadVoxelChannels
604 Add WriteVoxelChannels
604 Add ReadVoxelChannels
595 Add GrassLength
582 Add SetMaterialInTransformSubregion
582 Add ReplaceMaterialInTransformSubregion
573 Change ReturnType of WriteVoxels from void to null
573 Change ReturnType of SetWaterCell from void to null
573 Change ReturnType of SetMaterialInTransform from void to null
573 Change ReturnType of SetMaterialColor from void to null
573 Change ReturnType of SetCells from void to null
573 Change ReturnType of SetCell from void to null
573 Change ReturnType of ReplaceMaterialInTransform from void to null
573 Change ReturnType of ReplaceMaterial from void to null
573 Change ReturnType of PasteRegion from void to null
573 Change ReturnType of FillWedge from void to null
573 Change ReturnType of FillRegion from void to null
573 Change ReturnType of FillCylinder from void to null
573 Change ReturnType of FillBlock from void to null
573 Change ReturnType of FillBall from void to null
573 Change ReturnType of ConvertToSmooth from void to null
573 Change ReturnType of Clear from void to null
573 Change ReturnType of AutowedgeCells from void to null
569 Add SmoothRegion
567 Change ThreadSafety of GetMaterialColor from Unsafe to Safe
566 Add SetMaterialInTransform
566 Add ReplaceMaterialInTransform
565 Remove ShowTerrainRegion
565 Remove SetWireframeRegion
565 Remove SetTerrainRegion
565 Remove HideTerrainRegion
565 Add GetTerrainWireframe
560 Add CanSmoothVoxelsBeUpgraded
560 Add SmoothVoxelsUpgraded
554 Add CanShorelinesBeUpgraded
554 Add ShorelinesUpgraded
553 Change Default of WaterWaveSpeed from to 10
553 Change Default of WaterWaveSize from to 0.150000006
553 Change Default of WaterTransparency from to 0.300000012
553 Change Default of WaterReflectance from to 1
553 Change Default of WaterColor from to Color3(0.05, 0.33, 0.36)
553 Add SmoothGrid
553 Add PhysicsGrid
553 Change Default of MaxExtents from to
553 Change Default of LastUsedModificationMethod from to None
553 Change Default of IsSmooth from to true
553 Change Default of Decoration from to false
553 Add ClusterGridV3
553 Add ClusterGridV2
553 Add ClusterGrid
553 Add AcquisitionMethod
549 Add ShowTerrainRegion
549 Add SetWireframeRegion
549 Add SetTerrainRegion
549 Add HideTerrainRegion
498 Change Parameters of PasteRegion from (region: Instance, corner: Vector3int16, pasteEmptyCells: bool) to (region: TerrainRegion, corner: Vector3int16, pasteEmptyCells: bool)
498 Change ReturnType of CopyRegion from Instance to TerrainRegion
486 Change ThreadSafety of ReadVoxels from ReadOnly to Safe
486 Change ThreadSafety of WaterWaveSpeed from ReadOnly to ReadSafe
486 Change ThreadSafety of WaterWaveSize from ReadOnly to ReadSafe
486 Change ThreadSafety of WaterTransparency from ReadOnly to ReadSafe
486 Change ThreadSafety of WaterReflectance from ReadOnly to ReadSafe
486 Change ThreadSafety of WaterColor from ReadOnly to ReadSafe
486 Change ThreadSafety of MaxExtents from ReadOnly to ReadSafe
486 Change ThreadSafety of MaterialColors from ReadOnly to ReadSafe
486 Change ThreadSafety of LastUsedModificationMethod from ReadOnly to ReadSafe
486 Change ThreadSafety of IsSmooth from ReadOnly to ReadSafe
486 Change ThreadSafety of Decoration from ReadOnly to ReadSafe
484 Remove TerrainProgressUpdate
484 Remove SetImportHeightmapPaused
484 Remove ImportHeightmap
484 Remove CancelImportHeightmap
466 Add LastUsedModificationMethod
462 Change ThreadSafety of TerrainProgressUpdate from to Unsafe
462 Change ThreadSafety of WriteVoxels from to Unsafe
462 Change ThreadSafety of WorldToCellPreferSolid from to Unsafe
462 Change ThreadSafety of WorldToCellPreferEmpty from to Unsafe
462 Change ThreadSafety of WorldToCell from to Unsafe
462 Change ThreadSafety of SetWaterCell from to Unsafe
462 Change ThreadSafety of SetMaterialColor from to Unsafe
462 Change ThreadSafety of SetImportHeightmapPaused from to Unsafe
462 Change ThreadSafety of SetCells from to Unsafe
462 Change ThreadSafety of SetCell from to Unsafe
462 Change ThreadSafety of ReplaceMaterial from to Unsafe
462 Change ThreadSafety of ReadVoxels from to ReadOnly
462 Change ThreadSafety of PasteRegion from to Unsafe
462 Change ThreadSafety of ImportHeightmap from to Unsafe
462 Remove ImportHeightMap
462 Change ThreadSafety of GetWaterCell from to Unsafe
462 Change ThreadSafety of GetMaterialColor from to Unsafe
462 Change ThreadSafety of GetCell from to Unsafe
462 Change ThreadSafety of FillWedge from to Unsafe
462 Change ThreadSafety of FillRegion from to Unsafe
462 Change ThreadSafety of FillCylinder from to Unsafe
462 Change ThreadSafety of FillBlock from to Unsafe
462 Change ThreadSafety of FillBall from to Unsafe
462 Change ThreadSafety of CountCells from to Unsafe
462 Change ThreadSafety of CopyRegion from to Unsafe
462 Change ThreadSafety of ConvertToSmooth from to Unsafe
462 Change ThreadSafety of Clear from to Unsafe
462 Change ThreadSafety of CellCornerToWorld from to Unsafe
462 Change ThreadSafety of CellCenterToWorld from to Unsafe
462 Change ThreadSafety of CancelImportHeightmap from to Unsafe
462 Change ThreadSafety of AutowedgeCells from to Unsafe
462 Change ThreadSafety of AutowedgeCell from to Unsafe
462 Change ThreadSafety of WaterWaveSpeed from to ReadOnly
462 Change ThreadSafety of WaterWaveSize from to ReadOnly
462 Change ThreadSafety of WaterTransparency from to ReadOnly
462 Change ThreadSafety of WaterReflectance from to ReadOnly
462 Change ThreadSafety of WaterColor from to ReadOnly
462 Change ThreadSafety of MaxExtents from to ReadOnly
462 Change ThreadSafety of MaterialColors from to ReadOnly
462 Change ThreadSafety of IsSmooth from to ReadOnly
462 Change ThreadSafety of Decoration from to ReadOnly
457 Add SetImportHeightmapPaused
457 Add ImportHeightmap
457 Add CancelImportHeightmap
417 Add FillWedge
410 Add Decoration
400 Add ReplaceMaterial
392 Add FillCylinder
391 Add TerrainProgressUpdate
391 Add ImportHeightMap
349 Change Tags of WriteVoxels from [] to [CustomLuaState]
349 Change Tags of ReadVoxels from [] to [CustomLuaState]
349 Add MaterialColors
317 Add SetMaterialColor
317 Add GetMaterialColor
297 Change Tags of ConvertToSmooth from [] to [Deprecated]
297 Change Tags of IsSmooth from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
262 Add WaterReflectance
251 Change Tags of SetWaterCell from [] to [Deprecated]
251 Change Tags of SetCells from [] to [Deprecated]
251 Change Tags of SetCell from [] to [Deprecated]
251 Change Tags of GetWaterCell from [] to [Deprecated]
251 Change Tags of GetCell from [] to [Deprecated]
251 Change Tags of AutowedgeCells from [] to [Deprecated]
251 Change Tags of AutowedgeCell from [] to [Deprecated]
250 Change Tags of SetWaterCell from [Deprecated] to []
250 Change Tags of SetCells from [Deprecated] to []
250 Change Tags of SetCell from [Deprecated] to []
250 Change Tags of GetWaterCell from [Deprecated] to []
250 Change Tags of GetCell from [Deprecated] to []
250 Change Tags of AutowedgeCells from [Deprecated] to []
250 Change Tags of AutowedgeCell from [Deprecated] to []
251 Change Tags of SetWaterCell from [] to [Deprecated]
251 Change Tags of SetCells from [] to [Deprecated]
251 Change Tags of SetCell from [] to [Deprecated]
251 Change Tags of GetWaterCell from [] to [Deprecated]
251 Change Tags of GetCell from [] to [Deprecated]
251 Change Tags of AutowedgeCells from [] to [Deprecated]
251 Change Tags of AutowedgeCell from [] to [Deprecated]
223 Add WaterWaveSpeed
223 Add WaterWaveSize
223 Add WaterTransparency
223 Add WaterColor
222 Remove WaterWaveSpeed
222 Remove WaterWaveSize
222 Remove WaterTransparency
222 Remove WaterColor
223 Add WaterWaveSpeed
223 Add WaterWaveSize
223 Add WaterTransparency
223 Add WaterColor
193 Add WriteVoxels
193 Add ReadVoxels
193 Add FillRegion
193 Add FillBlock
193 Add FillBall
193 Add ConvertToSmooth
193 Add IsSmooth
130 Add PasteRegion
130 Add CopyRegion
79 Change Tags of SetWaterCell from [preliminary] to []
79 Change Tags of GetWaterCell from [preliminary] to []
78 Change Tags of SetWaterCell from [] to [preliminary]
78 Change Tags of GetWaterCell from [] to [preliminary]
79 Change Tags of SetWaterCell from [preliminary] to []
79 Change Tags of GetWaterCell from [preliminary] to []
67 Remove resize
67 Remove makeJoints
67 Remove destroy
67 Remove clone
67 Remove breakJoints
67 Remove Resize
67 Remove MakeJoints
67 Remove Destroy
67 Remove Clone
67 Remove BreakJoints
67 Remove Velocity
67 Remove Transparency
67 Remove RotVelocity
67 Remove Reflectance
67 Remove Position
67 Remove Name
67 Remove Material
67 Remove Locked
67 Remove Friction
67 Remove Elasticity
67 Remove CanCollide
67 Remove CFrame
67 Remove BrickColor
67 Remove Archivable
67 Remove Anchored
61 Add SetWaterCell
61 Add GetWaterCell
55 Add resize
55 Add makeJoints
55 Add destroy
55 Add clone
55 Add breakJoints
55 Add Resize
55 Add MakeJoints
55 Add Destroy
55 Add Clone
55 Add BreakJoints
55 Add Velocity
55 Add Transparency
55 Add RotVelocity
55 Add Reflectance
55 Add Position
55 Add Name
55 Add Material
55 Add Locked
55 Add Friction
55 Add Elasticity
55 Add CanCollide
55 Add CFrame
55 Add BrickColor
55 Add Archivable
55 Add Anchored
55 Change Tags of Terrain from [preliminary, NotCreatable] to [NotCreatable]
53 Remove DebugAnimation
49 Add AutowedgeCells
49 Add AutowedgeCell
47 Add WorldToCellPreferSolid
47 Add WorldToCellPreferEmpty
47 Add WorldToCell
47 Add SetCells
47 Add SetCell
47 Add GetCell
47 Add CountCells
47 Add Clear
47 Add CellCornerToWorld
47 Add CellCenterToWorld
47 Add MaxExtents
47 Add DebugAnimation
47 Add Terrain

Members 59

AutowedgeCell
CreatorHub

Parameters (3)
x	int
y	int
z	int
Returns (1)
bool

Obsolete function which no longer does anything.

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 5

462 Change ThreadSafety of AutowedgeCell from to Unsafe
251 Change Tags of AutowedgeCell from [] to [Deprecated]
250 Change Tags of AutowedgeCell from [Deprecated] to []
251 Change Tags of AutowedgeCell from [] to [Deprecated]
49 Add AutowedgeCell

Tags: [Deprecated]

AutowedgeCells
CreatorHub

Parameters (1)
region	Region3int16
Returns (1)
null

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 6

573 Change ReturnType of AutowedgeCells from void to null
462 Change ThreadSafety of AutowedgeCells from to Unsafe
251 Change Tags of AutowedgeCells from [] to [Deprecated]
250 Change Tags of AutowedgeCells from [Deprecated] to []
251 Change Tags of AutowedgeCells from [] to [Deprecated]
49 Add AutowedgeCells

Tags: [Deprecated]

CanSmoothVoxelsBeUpgraded
CreatorHub

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

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

560 Add CanSmoothVoxelsBeUpgraded

CellCenterToWorld
CreatorHub

Parameters (3)
x	int
y	int
z	int
Returns (1)
Vector3

Returns the world position of the center of the terrain cell.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of CellCenterToWorld from to Unsafe
47 Add CellCenterToWorld

CellCornerToWorld
CreatorHub

Parameters (3)
x	int
y	int
z	int
Returns (1)
Vector3

Returns the position of the lower-left-forward corner of the grid cell.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of CellCornerToWorld from to Unsafe
47 Add CellCornerToWorld

Clear
CreatorHub

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

Clears all terrain.

Thread safety	Unsafe

History 3

573 Change ReturnType of Clear from void to null
462 Change ThreadSafety of Clear from to Unsafe
47 Add Clear

ClearVoxelsAsync_beta
CreatorHub

Parameters (2)
region	Region3
channelIds	Array
Returns (1)
null

It may behave in a non-standard way.

Thread safety	Unsafe

History 1

675 Add ClearVoxelsAsync_beta

Tags: [CustomLuaState]

ConvertToSmooth
CreatorHub

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.

It exists only for backward compatibility, and should not be used for new work.

Security	PluginSecurity
Thread safety	Unsafe

History 4

573 Change ReturnType of ConvertToSmooth from void to null
462 Change ThreadSafety of ConvertToSmooth from to Unsafe
297 Change Tags of ConvertToSmooth from [] to [Deprecated]
193 Add ConvertToSmooth

Tags: [Deprecated]

CopyRegion
CreatorHub

Parameters (1)
region	Region3int16
Returns (1)
TerrainRegion

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

Thread safety	Unsafe

History 3

498 Change ReturnType of CopyRegion from Instance to TerrainRegion
462 Change ThreadSafety of CopyRegion from to Unsafe
130 Add CopyRegion

CountCells
CreatorHub

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

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

Thread safety	Unsafe

History 2

462 Change ThreadSafety of CountCells from to Unsafe
47 Add CountCells

CreateVoxelBuffer_beta
CreatorHub

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

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

710 Add CreateVoxelBuffer_beta

Decoration
CreatorHub

Type		Default
bool

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

It cannot be accessed by script code.

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 5

726 Change Default of Decoration from false to
553 Change Default of Decoration from to false
486 Change ThreadSafety of Decoration from ReadOnly to ReadSafe
462 Change ThreadSafety of Decoration from to ReadOnly
410 Add Decoration

Tags: [NotScriptable]

DrawBufferAsync
CreatorHub

Parameters (5)
cframe	CFrame
scale	float
resolution	int
source	VoxelBuffer
mergeConfig	Dictionary
Returns (1)
null

It will block the calling thread until completion.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

710 Add DrawBufferAsync

Tags: [Yields]

FillBall
CreatorHub

Parameters (3)
center	Vector3
radius	float
material	Material
Returns (1)
null

Fills a ball of smooth terrain in a given space.

Thread safety	Unsafe

History 3

573 Change ReturnType of FillBall from void to null
462 Change ThreadSafety of FillBall from to Unsafe
193 Add FillBall

FillBlock
CreatorHub

Parameters (3)
cframe	CFrame
size	Vector3
material	Material
Returns (1)
null

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

Thread safety	Unsafe

History 3

573 Change ReturnType of FillBlock from void to null
462 Change ThreadSafety of FillBlock from to Unsafe
193 Add FillBlock

FillCylinder
CreatorHub

Parameters (4)
cframe	CFrame
height	float
radius	float
material	Material
Returns (1)
null

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

Thread safety	Unsafe

History 3

573 Change ReturnType of FillCylinder from void to null
462 Change ThreadSafety of FillCylinder from to Unsafe
392 Add FillCylinder

FillRegion
CreatorHub

Parameters (3)
region	Region3
resolution	float
material	Material
Returns (1)
null

Fills a Region3 space with smooth terrain.

Thread safety	Unsafe

History 3

573 Change ReturnType of FillRegion from void to null
462 Change ThreadSafety of FillRegion from to Unsafe
193 Add FillRegion

FillWedge
CreatorHub

Parameters (3)
cframe	CFrame
size	Vector3
material	Material
Returns (1)
null

This method 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 safety	Unsafe

History 3

573 Change ReturnType of FillWedge from void to null
462 Change ThreadSafety of FillWedge from to Unsafe
417 Add FillWedge

GetCell
CreatorHub

Parameters (3)
x	int
y	int
z	int
Returns (1)
Tuple

Returns the closest cell material from the legacy terrain engine that matches the smooth terrain voxel specified.

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 5

462 Change ThreadSafety of GetCell from to Unsafe
251 Change Tags of GetCell from [] to [Deprecated]
250 Change Tags of GetCell from [Deprecated] to []
251 Change Tags of GetCell from [] to [Deprecated]
47 Add GetCell

Tags: [Deprecated]

GetMaterialColor
CreatorHub

Parameters (1)
material	Material
Returns (1)
Color3

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

Thread safety	Safe

History 3

567 Change ThreadSafety of GetMaterialColor from Unsafe to Safe
462 Change ThreadSafety of GetMaterialColor from to Unsafe
317 Add GetMaterialColor

GetMaterialSlot
CreatorHub

Parameters (1)
slotIndex	int
Returns (1)
Tuple

Thread safety	Unsafe

History 1

719 Add GetMaterialSlot

GetTerrainWireframe
CreatorHub

Parameters (2)
cframe	CFrame
size	Vector3
Returns (1)
Array

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

565 Add GetTerrainWireframe

GetWaterCell
CreatorHub

Parameters (3)
x	int
y	int
z	int
Returns (1)
Tuple

Returns true if the cell is a water cell.

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 8

462 Change ThreadSafety of GetWaterCell from to Unsafe
251 Change Tags of GetWaterCell from [] to [Deprecated]
250 Change Tags of GetWaterCell from [Deprecated] to []
251 Change Tags of GetWaterCell from [] to [Deprecated]
79 Change Tags of GetWaterCell from [preliminary] to []
78 Change Tags of GetWaterCell from [] to [preliminary]
79 Change Tags of GetWaterCell from [preliminary] to []
61 Add GetWaterCell

Tags: [Deprecated]

GrassLength
CreatorHub

Type		Default
float

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

It cannot be accessed by script code.

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 3

726 Change Default of GrassLength from 0.699999988 to
623 Change Tags of GrassLength from [NotScriptable, NotBrowsable] to [NotScriptable]
595 Add GrassLength

Tags: [NotScriptable]

IsSmooth
CreatorHub

Type		Default
bool

Returns true if the game is using the smooth terrain system.

It exists only for backward compatibility, and should not be used for new work.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 6

726 Change Default of IsSmooth from true to
553 Change Default of IsSmooth from to true
486 Change ThreadSafety of IsSmooth from ReadOnly to ReadSafe
462 Change ThreadSafety of IsSmooth from to ReadOnly
297 Change Tags of IsSmooth from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
193 Add IsSmooth

Tags: [ReadOnly, NotReplicated, Deprecated]

IterateVoxelsAsync_beta
CreatorHub

Parameters (3)
region	Region3
resolution	int
channelIds	Array
Returns (1)
TerrainIterateOperation

It may behave in a non-standard way.

Thread safety	Unsafe

History 1

675 Add IterateVoxelsAsync_beta

Tags: [CustomLuaState]

LastUsedModificationMethod
CreatorHub

Type		Default
TerrainAcquisitionMethod

Its interface does not cross the network boundary.

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

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 4

726 Change Default of LastUsedModificationMethod from None to
553 Change Default of LastUsedModificationMethod from to None
486 Change ThreadSafety of LastUsedModificationMethod from ReadOnly to ReadSafe
466 Add LastUsedModificationMethod

Tags: [Hidden, NotReplicated]

MaterialColors
CreatorHub

Type		Default
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().

It cannot be accessed by script code.

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 3

486 Change ThreadSafety of MaterialColors from ReadOnly to ReadSafe
462 Change ThreadSafety of MaterialColors from to ReadOnly
349 Add MaterialColors

Tags: [NotScriptable]

MaxExtents
CreatorHub

Type		Default
Region3int16

Displays the boundaries of the largest possible editable region.

Its interface does not cross the network boundary.

Its value can be read, but it cannot be modified.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	false

History 5

726 Change Default of MaxExtents from to
553 Change Default of MaxExtents from to
486 Change ThreadSafety of MaxExtents from ReadOnly to ReadSafe
462 Change ThreadSafety of MaxExtents from to ReadOnly
47 Add MaxExtents

Tags: [ReadOnly, NotReplicated]

ModifyVoxelsAsync_beta
CreatorHub

Parameters (3)
region	Region3
resolution	int
channelIds	Array
Returns (1)
TerrainModifyOperation

It may behave in a non-standard way.

Thread safety	Unsafe

History 1

675 Add ModifyVoxelsAsync_beta

Tags: [CustomLuaState]

PasteRegion
CreatorHub

Parameters (3)
region	TerrainRegion
corner	Vector3int16
pasteEmptyCells	bool
Returns (1)
null

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

Thread safety	Unsafe

History 4

573 Change ReturnType of PasteRegion from void to null
498 Change Parameters of PasteRegion from (region: Instance, corner: Vector3int16, pasteEmptyCells: bool) to (region: TerrainRegion, corner: Vector3int16, pasteEmptyCells: bool)
462 Change ThreadSafety of PasteRegion from to Unsafe
130 Add PasteRegion

ReadBufferAsync
CreatorHub

Parameters (2)
region	Region3
resolution	int
Returns (1)
VoxelBuffer

It will block the calling thread until completion.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

710 Add ReadBufferAsync

Tags: [Yields]

ReadVoxelChannels
CreatorHub

Parameters (3)
region	Region3
resolution	float
channelIds	Array
Returns (1)
Dictionary

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

It may behave in a non-standard way.

Thread safety	Safe

History 4

616 Change Tags of ReadVoxelChannels from [] to [CustomLuaState]
604 Add ReadVoxelChannels
603 Remove ReadVoxelChannels
604 Add ReadVoxelChannels

Tags: [CustomLuaState]

ReadVoxels
CreatorHub

Parameters (2)
region	Region3
resolution	float
Returns (1)
Tuple

Returns a certain region of smooth terrain in table format.

It may behave in a non-standard way.

Thread safety	Safe

History 4

486 Change ThreadSafety of ReadVoxels from ReadOnly to Safe
462 Change ThreadSafety of ReadVoxels from to ReadOnly
349 Change Tags of ReadVoxels from [] to [CustomLuaState]
193 Add ReadVoxels

Tags: [CustomLuaState]

ReadVoxelsAsync_beta
CreatorHub

Parameters (3)
region	Region3
resolution	int
channelIds	Array
Returns (1)
TerrainReadOperation

It may behave in a non-standard way.

Thread safety	Unsafe

History 1

675 Add ReadVoxelsAsync_beta

Tags: [CustomLuaState]

ReplaceMaterial
CreatorHub

Parameters (4)
region	Region3
resolution	float
sourceMaterial	Material
targetMaterial	Material
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.

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

Thread safety	Unsafe

History 3

573 Change ReturnType of ReplaceMaterial from void to null
462 Change ThreadSafety of ReplaceMaterial from to Unsafe
400 Add ReplaceMaterial

ReplaceMaterialInTransform
CreatorHub

Parameters (4)
cframe	CFrame
size	Vector3
sourceMaterial	Material
targetMaterial	Material
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

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

ReplaceMaterialInTransformSubregion
CreatorHub

Parameters (5)
cframe	CFrame
size	Vector3
sourceMaterial	Material
targetMaterial	Material
targetRegion	Region3int16
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

582 Add ReplaceMaterialInTransformSubregion

ResetMaterialSlot
CreatorHub

Parameters (1)
slotIndex	int
Returns (1)
null

Thread safety	Unsafe

History 1

719 Add ResetMaterialSlot

SetCell
CreatorHub

Parameters (6)
x	int
y	int
z	int
material	CellMaterial
block	CellBlock
orientation	CellOrientation
Returns (1)
null

Sets the occupancy of the specified terrain voxel to 1 and sets its material to the closest smooth terrain material that matches the cell material.

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 6

573 Change ReturnType of SetCell from void to null
462 Change ThreadSafety of SetCell from to Unsafe
251 Change Tags of SetCell from [] to [Deprecated]
250 Change Tags of SetCell from [Deprecated] to []
251 Change Tags of SetCell from [] to [Deprecated]
47 Add SetCell

Tags: [Deprecated]

SetCells
CreatorHub

Parameters (4)
region	Region3int16
material	CellMaterial
block	CellBlock
orientation	CellOrientation
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 cell material.

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 6

573 Change ReturnType of SetCells from void to null
462 Change ThreadSafety of SetCells from to Unsafe
251 Change Tags of SetCells from [] to [Deprecated]
250 Change Tags of SetCells from [Deprecated] to []
251 Change Tags of SetCells from [] to [Deprecated]
47 Add SetCells

Tags: [Deprecated]

SetMaterialColor
CreatorHub

Parameters (2)
material	Material
value	Color3
Returns (1)
null

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

Thread safety	Unsafe

History 3

573 Change ReturnType of SetMaterialColor from void to null
462 Change ThreadSafety of SetMaterialColor from to Unsafe
317 Add SetMaterialColor

SetMaterialInTransform
CreatorHub

Parameters (3)
cframe	CFrame
size	Vector3
targetMaterial	Material
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

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

SetMaterialInTransformSubregion
CreatorHub

Parameters (4)
cframe	CFrame
size	Vector3
targetMaterial	Material
targetRegion	Region3int16
Returns (1)
null

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 1

582 Add SetMaterialInTransformSubregion

SetMaterialSlot
CreatorHub

Parameters (4)
slotIndex	int
baseMaterial	Material
materialVariant	string
color	Color3
Returns (1)
null

Thread safety	Unsafe

History 1

719 Add SetMaterialSlot

SetWaterCell
CreatorHub

Parameters (5)
x	int
y	int
z	int
force	WaterForce
direction	WaterDirection
Returns (1)
null

Sets the specified terrain voxel's material to water and sets its occupancy to 1.

It exists only for backward compatibility, and should not be used for new work.

Thread safety	Unsafe

History 9

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

Tags: [Deprecated]

SmoothRegion
CreatorHub

Parameters (3)
region	Region3
resolution	float
strength	float
Returns (1)
Tuple

It may behave in a non-standard way.

Security	RobloxScriptSecurity
Thread safety	Safe

History 1

569 Add SmoothRegion

Tags: [CustomLuaState]

SmoothVoxelsUpgraded
CreatorHub

Type		Default
bool

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

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 2

726 Change Default of SmoothVoxelsUpgraded from false to
560 Add SmoothVoxelsUpgraded

Tags: [Hidden]

WaterColor
CreatorHub

Type		Default
Color3

The tint of Terrain water.

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 7

726 Change Default of WaterColor from Color3(0.05, 0.33, 0.36) to
553 Change Default of WaterColor from to Color3(0.05, 0.33, 0.36)
486 Change ThreadSafety of WaterColor from ReadOnly to ReadSafe
462 Change ThreadSafety of WaterColor from to ReadOnly
223 Add WaterColor
222 Remove WaterColor
223 Add WaterColor

WaterReflectance
CreatorHub

Type		Default
float

Controls how opaque Terrain water reflections are.

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 5

726 Change Default of WaterReflectance from 1 to
553 Change Default of WaterReflectance from to 1
486 Change ThreadSafety of WaterReflectance from ReadOnly to ReadSafe
462 Change ThreadSafety of WaterReflectance from to ReadOnly
262 Add WaterReflectance

WaterTransparency
CreatorHub

Type		Default
float

The transparency of Terrain water.

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 7

726 Change Default of WaterTransparency from 0.300000012 to
553 Change Default of WaterTransparency from to 0.300000012
486 Change ThreadSafety of WaterTransparency from ReadOnly to ReadSafe
462 Change ThreadSafety of WaterTransparency from to ReadOnly
223 Add WaterTransparency
222 Remove WaterTransparency
223 Add WaterTransparency

WaterWaveSize
CreatorHub

Type		Default
float

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

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 7

726 Change Default of WaterWaveSize from 0.150000006 to
553 Change Default of WaterWaveSize from to 0.150000006
486 Change ThreadSafety of WaterWaveSize from ReadOnly to ReadSafe
462 Change ThreadSafety of WaterWaveSize from to ReadOnly
223 Add WaterWaveSize
222 Remove WaterWaveSize
223 Add WaterWaveSize

WaterWaveSpeed
CreatorHub

Type		Default
float

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

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 7

726 Change Default of WaterWaveSpeed from 10 to
553 Change Default of WaterWaveSpeed from to 10
486 Change ThreadSafety of WaterWaveSpeed from ReadOnly to ReadSafe
462 Change ThreadSafety of WaterWaveSpeed from to ReadOnly
223 Add WaterWaveSpeed
222 Remove WaterWaveSpeed
223 Add WaterWaveSpeed

WorldToCell
CreatorHub

Parameters (1)
position	Vector3
Returns (1)
Vector3

Returns the grid cell location that contains the point position.

Thread safety	Unsafe

History 2

462 Change ThreadSafety of WorldToCell from to Unsafe
47 Add WorldToCell

WorldToCellPreferEmpty
CreatorHub

Parameters (1)
position	Vector3
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 safety	Unsafe

History 2

462 Change ThreadSafety of WorldToCellPreferEmpty from to Unsafe
47 Add WorldToCellPreferEmpty

WorldToCellPreferSolid
CreatorHub

Parameters (1)
position	Vector3
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 safety	Unsafe

History 2

462 Change ThreadSafety of WorldToCellPreferSolid from to Unsafe
47 Add WorldToCellPreferSolid

WriteVoxelChannels
CreatorHub

Parameters (3)
region	Region3
resolution	float
channels	Dictionary
Returns (1)
null

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

It may behave in a non-standard way.

Thread safety	Unsafe

History 4

616 Change Tags of WriteVoxelChannels from [] to [CustomLuaState]
604 Add WriteVoxelChannels
603 Remove WriteVoxelChannels
604 Add WriteVoxelChannels

Tags: [CustomLuaState]

WriteVoxels
CreatorHub

Parameters (4)
region	Region3
resolution	float
materials	Array
occupancy	Array
Returns (1)
null

Sets a certain region of smooth terrain using table format.

It may behave in a non-standard way.

Thread safety	Unsafe

History 4

573 Change ReturnType of WriteVoxels from void to null
462 Change ThreadSafety of WriteVoxels from to Unsafe
349 Change Tags of WriteVoxels from [] to [CustomLuaState]
193 Add WriteVoxels

Tags: [CustomLuaState]

WriteVoxelsAsync_beta
CreatorHub

Parameters (3)
region	Region3
resolution	int
channelIds	Array
Returns (1)
TerrainWriteOperation

It may behave in a non-standard way.

Thread safety	Unsafe

History 1

675 Add WriteVoxelsAsync_beta

Tags: [CustomLuaState]

Removed members 48

AcquisitionMethod
CreatorHub

Type		Default
TerrainAcquisitionMethod		None

It cannot be accessed by script code.

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

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

726 Remove AcquisitionMethod
553 Add AcquisitionMethod

Tags: [Hidden, NotScriptable]

Anchored
CreatorHub

Type		Default
bool

It exists only for backward compatibility, and should not be used for new work.

Category
Loaded/Saved	false

History 2

67 Remove Anchored
55 Add Anchored

Tags: [Deprecated]

Archivable
CreatorHub

Type		Default
bool

It exists only for backward compatibility, and should not be used for new work.

Category
Loaded/Saved	false

History 2

67 Remove Archivable
55 Add Archivable

Tags: [Deprecated]

BreakJoints
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work.

History 2

67 Remove BreakJoints
55 Add BreakJoints

Tags: [Deprecated]

BrickColor
CreatorHub

Type		Default
BrickColor

It exists only for backward compatibility, and should not be used for new work.

Category
Loaded/Saved	false

History 2

67 Remove BrickColor
55 Add BrickColor

Tags: [Deprecated]

CFrame
CreatorHub

Type		Default
CoordinateFrame

It exists only for backward compatibility, and should not be used for new work.

Category
Loaded/Saved	false

History 2

67 Remove CFrame
55 Add CFrame

Tags: [Deprecated]

CanCollide
CreatorHub

Type		Default
bool

It exists only for backward compatibility, and should not be used for new work.

Category
Loaded/Saved	false

History 2

67 Remove CanCollide
55 Add CanCollide

Tags: [Deprecated]

CanShorelinesBeUpgraded
CreatorHub

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

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

668 Remove CanShorelinesBeUpgraded
554 Add CanShorelinesBeUpgraded

CancelImportHeightmap
CreatorHub

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

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

484 Remove CancelImportHeightmap
462 Change ThreadSafety of CancelImportHeightmap from to Unsafe
457 Add CancelImportHeightmap

Clone
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work.

History 2

67 Remove Clone
55 Add Clone

Tags: [Deprecated]

ClusterGrid
CreatorHub

Type		Default
string

It cannot be accessed by script code.

Its interface does not cross the network boundary.

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

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true/false

History 2

726 Remove ClusterGrid
553 Add ClusterGrid

Tags: [Hidden, WriteOnly, NotReplicated, NotScriptable]

ClusterGridV2
CreatorHub

Type		Default
string

It cannot be accessed by script code.

Its interface does not cross the network boundary.

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

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true/false

History 2

726 Remove ClusterGridV2
553 Add ClusterGridV2

Tags: [Hidden, WriteOnly, NotReplicated, NotScriptable]

ClusterGridV3
CreatorHub

Type		Default
BinaryString

It cannot be accessed by script code.

Its interface does not cross the network boundary.

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

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true/false

History 2

726 Remove ClusterGridV3
553 Add ClusterGridV3

Tags: [Hidden, WriteOnly, NotReplicated, NotScriptable]

DebugAnimation
CreatorHub

Type		Default
bool

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

Category
Loaded/Saved	false

History 2

53 Remove DebugAnimation
47 Add DebugAnimation

Tags: [Hidden]

Destroy
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work.

History 2

67 Remove Destroy
55 Add Destroy

Tags: [Deprecated]

Elasticity
CreatorHub

Type		Default
float

It exists only for backward compatibility, and should not be used for new work.

Category
Loaded/Saved	false

History 2

67 Remove Elasticity
55 Add Elasticity

Tags: [Deprecated]

Friction
CreatorHub

Type		Default
float

It exists only for backward compatibility, and should not be used for new work.

Category
Loaded/Saved	false

History 2

67 Remove Friction
55 Add Friction

Tags: [Deprecated]

GetBaseMaterialSlotIndex
CreatorHub

Parameters (1)
baseMaterial	Material
Returns (1)
int?

Thread safety	Unsafe

History 2

725 Remove GetBaseMaterialSlotIndex
719 Add GetBaseMaterialSlotIndex

GetFirstCustomMaterialSlotIndex
CreatorHub

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

Thread safety	Unsafe

History 2

725 Remove GetFirstCustomMaterialSlotIndex
719 Add GetFirstCustomMaterialSlotIndex

HideTerrainRegion
CreatorHub

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

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

565 Remove HideTerrainRegion
549 Add HideTerrainRegion

ImportHeightMap
CreatorHub

Parameters (3)
heightMapBinary	string
colorMapBinary	string
region	Region3
Returns (1)
void

It may behave in a non-standard way.

Security	RobloxScriptSecurity

History 2

462 Remove ImportHeightMap
391 Add ImportHeightMap

Tags: [CustomLuaState]

ImportHeightmap
CreatorHub

Parameters (4)
region	Region3
heightmapAssetId	Content
colormapAssetId	Content
defaultMaterial	Material
Returns (1)
void

It will block the calling thread until completion.

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

484 Remove ImportHeightmap
462 Change ThreadSafety of ImportHeightmap from to Unsafe
457 Add ImportHeightmap

Tags: [Yields]

Locked
CreatorHub

Type		Default
bool

It exists only for backward compatibility, and should not be used for new work.

Category
Loaded/Saved	false

History 2

67 Remove Locked
55 Add Locked

Tags: [Deprecated]

MakeJoints
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work.

History 2

67 Remove MakeJoints
55 Add MakeJoints

Tags: [Deprecated]

Material
CreatorHub

Type		Default
Material

It exists only for backward compatibility, and should not be used for new work.

Category
Loaded/Saved	false

History 2

67 Remove Material
55 Add Material

Tags: [Deprecated]

Materials
CreatorHub

Type		Default
SharedString

It cannot be accessed by script code.

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

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 2

726 Remove Materials
719 Add Materials

Tags: [Hidden, NotScriptable]

Name
CreatorHub

Type		Default
string

It exists only for backward compatibility, and should not be used for new work.

Category
Loaded/Saved	false

History 2

67 Remove Name
55 Add Name

Tags: [Deprecated]

PhysicsGrid
CreatorHub

Type		Default
BinaryString

It cannot be accessed by script code.

Its interface does not cross the network boundary.

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

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

726 Remove PhysicsGrid
553 Add PhysicsGrid

Tags: [Hidden, NotReplicated, NotScriptable]

Position
CreatorHub

Type		Default
Vector3

It exists only for backward compatibility, and should not be used for new work.

Category
Loaded/Saved	false

History 2

67 Remove Position
55 Add Position

Tags: [Deprecated]

Reflectance
CreatorHub

Type		Default
float

It exists only for backward compatibility, and should not be used for new work.

Category
Loaded/Saved	false

History 2

67 Remove Reflectance
55 Add Reflectance

Tags: [Deprecated]

Resize
CreatorHub

Parameters (2)
normalId	NormalId
deltaAmount	int
Returns (1)
bool

It exists only for backward compatibility, and should not be used for new work.

History 2

67 Remove Resize
55 Add Resize

Tags: [Deprecated]

RotVelocity
CreatorHub

Type		Default
Vector3

It exists only for backward compatibility, and should not be used for new work.

Category
Loaded/Saved	false

History 2

67 Remove RotVelocity
55 Add RotVelocity

Tags: [Deprecated]

SetImportHeightmapPaused
CreatorHub

Parameters (1)
paused	bool
Returns (1)
void

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

484 Remove SetImportHeightmapPaused
462 Change ThreadSafety of SetImportHeightmapPaused from to Unsafe
457 Add SetImportHeightmapPaused

SetTerrainRegion
CreatorHub

Parameters (2)
cframe	CFrame
size	Vector3
Returns (1)
void

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

565 Remove SetTerrainRegion
549 Add SetTerrainRegion

SetWireframeRegion
CreatorHub

Parameters (2)
cframe	CFrame
size	Vector3
Returns (1)
void

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

565 Remove SetWireframeRegion
549 Add SetWireframeRegion

ShorelinesUpgraded
CreatorHub

Type		Default
bool		false

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

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 4

676 Remove ShorelinesUpgraded
675 Change Default of ShorelinesUpgraded from true to false
671 Change Default of ShorelinesUpgraded from false to true
554 Add ShorelinesUpgraded

Tags: [Hidden]

ShowTerrainRegion
CreatorHub

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

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 2

565 Remove ShowTerrainRegion
549 Add ShowTerrainRegion

SmoothGrid
CreatorHub

Type		Default
BinaryString

It cannot be accessed by script code.

Its interface does not cross the network boundary.

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

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

726 Remove SmoothGrid
553 Add SmoothGrid

Tags: [Hidden, NotReplicated, NotScriptable]

TerrainProgressUpdate
CreatorHub

Parameters (1)
progressRatio	float

Security	RobloxScriptSecurity
Thread safety	Unsafe

History 3

484 Remove TerrainProgressUpdate
462 Change ThreadSafety of TerrainProgressUpdate from to Unsafe
391 Add TerrainProgressUpdate

Transparency
CreatorHub

Type		Default
float

It exists only for backward compatibility, and should not be used for new work.

Category
Loaded/Saved	false

History 2

67 Remove Transparency
55 Add Transparency

Tags: [Deprecated]

ValidationAssetContentMap
CreatorHub

Type		Default
AssetContentMap

It cannot be accessed by script code.

Its interface does not cross the network boundary.

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

Security	RobloxSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

726 Remove ValidationAssetContentMap
721 Add ValidationAssetContentMap

Tags: [Hidden, NotReplicated, NotScriptable]

Velocity
CreatorHub

Type		Default
Vector3

It exists only for backward compatibility, and should not be used for new work.

Category
Loaded/Saved	false

History 2

67 Remove Velocity
55 Add Velocity

Tags: [Deprecated]

VoxelGridAssetContentMap
CreatorHub

Type		Default
AssetContentMap

It cannot be accessed by script code.

Its interface does not cross the network boundary.

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

Security	RobloxScriptSecurity
Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 4

726 Remove VoxelGridAssetContentMap
714 Change ReadSecurity of VoxelGridAssetContentMap from None to RobloxScriptSecurity
714 Change WriteSecurity of VoxelGridAssetContentMap from None to RobloxScriptSecurity
712 Add VoxelGridAssetContentMap

Tags: [Hidden, NotReplicated, NotScriptable]

breakJoints
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work.

History 2

67 Remove breakJoints
55 Add breakJoints

Tags: [Deprecated]

clone
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work.

History 2

67 Remove clone
55 Add clone

Tags: [Deprecated]

destroy
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work.

History 2

67 Remove destroy
55 Add destroy

Tags: [Deprecated]

makeJoints
CreatorHub

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

It exists only for backward compatibility, and should not be used for new work.

History 2

67 Remove makeJoints
55 Add makeJoints

Tags: [Deprecated]

resize
CreatorHub

Parameters (2)
normalId	NormalId
deltaAmount	int
Returns (1)
bool

It exists only for backward compatibility, and should not be used for new work.

History 2

67 Remove resize
55 Add resize

Tags: [Deprecated]

Engine API

Website

Related

History 5

History 6

History 1

History 2

History 2

History 3

History 1

History 4

History 3

History 2

History 1

History 5

History 1

History 3

History 3

History 3

History 3

History 3

History 5

History 3

History 1

History 1

History 8

History 3

History 6

History 1

History 4

History 3

History 5

History 1

History 4

History 1

History 4

History 4

History 1

History 3

History 2

History 1

History 1

History 6

History 6

History 3

History 2

History 1

History 1

History 9

History 1

History 2

History 7

History 5

History 7

History 7

History 7

History 2

History 2

History 2

History 4

History 4

History 1

History 2

History 2

History 2

History 2

History 2

History 2

History 2

History 2