A Studio-only service that backs the Terrain Editor's heightmap import tool,
converting heightmap and colormap images into voxel Terrain .
Its interface does not cross the network boundary.
It is a singleton that may be acquired with GetService.
Tags: [Service, NotReplicated]
History Member 573 CancelImportHeightmap ( ) : null 645 GetHeightmapPreviewAsync ( heightmapAssetId: ContentId ) : Tuple 645 ImportHeightmap ( region: Region3 , heightmapAssetId: ContentId , colormapAssetId: ContentId , defaultMaterial: Material ) : null 645 IsValidColormap ( colormapAssetId: ContentId ) : Tuple 645 IsValidHeightmap ( heightmapAssetId: ContentId ) : Tuple 573 SetImportHeightmapPaused ( paused: bool ) : null 464 ColormapHasUnknownPixels ( ) 464 ProgressUpdate ( progressRatio: float , operation: string ) 69 members inherited from Instance731 Archivable : bool 731 Attributes : string 731 AttributesReplicate : string 731 AttributesSerialize : BinaryString 731 Capabilities : SecurityCapabilities 731 DataCost : int 731 DefinesCapabilities : bool 731 HistoryId : UniqueId 731 IsInSandbox : bool 731 Name : string 731 Parent : Instance 731 PredictionMode : PredictionMode 731 PropertyStatusStudio : PropertyStatus 731 RobloxLocked : bool 731 Sandboxed : bool 734 SerializedOverrides : BinaryString 731 SourceAssetId : int64 731 Tags : SharedString 731 UniqueId : UniqueId 731 archivable : bool 731 numExpectedDirectChildren : int 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 731 children ( ) : Instances 731 clone ( ) : Instance 731 destroy ( ) : null 731 findFirstChild ( name: string , recursive: bool = false ) : Instance 731 getChildren ( ) : Instances 731 isDescendantOf ( ancestor: Instance ) : bool 731 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 ( ) 731 childAdded ( child: Instance ) 6 members inherited from Object731 ClassName : string 731 className : string 647 GetPropertyChangedSignal ( property: string ) : RBXScriptSignal 647 IsA ( className: string ) : bool 731 isA ( className: string ) : bool 647 Changed ( property: string )
Studio-only Terrain Editor service; members require elevated security and are
not callable from experience scripts. Powers Import Heightmap : given a
Region3 and the asset IDs of a grayscale heightmap plus an optional
colormap, samples the images and generates smooth-voxel Terrain in
that region — heightmap luminance drives height; colormap colors map to the
nearest terrain Material , falling back to a supplied default and
warning when too many pixels are unmatched.
Parameters (0 ) No parameters. Returns (1 ) null
History 5 Parameters (0 ) No parameters.
History 1
It will block the calling thread until completion.
History 3 Tags: [Yields]
It will block the calling thread until completion.
History 6 Tags: [Yields]