Reference API Roblox

Engine API

Website

Related

Reference API Roblox

HeightmapImporterService

A Studio-only service that backs the Terrain Editor's heightmap import tool, converting heightmap and colormap images into voxel Terrain.

This class is not replicated. Its interface does not cross the network boundary.
This class is a service. It is a singleton that may be acquired with GetService.
Tags: [Service, NotReplicated]

Member index 8

HistoryMember
573CancelImportHeightmap(): null
645GetHeightmapPreviewAsync(heightmapAssetId: ContentId): Tuple
645ImportHeightmap(region: Region3, heightmapAssetId: ContentId, colormapAssetId: ContentId, defaultMaterial: Material): null
645IsValidColormap(colormapAssetId: ContentId): Tuple
645IsValidHeightmap(heightmapAssetId: ContentId): Tuple
573SetImportHeightmapPaused(paused: bool): null
464ColormapHasUnknownPixels()
464ProgressUpdate(progressRatio: float, operation: string)
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: 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
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Removed member index 1

HistoryMember
460GetGreyscale(heightmapAssetId: Content): Tuple

Description

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.

History 39

Members 8

CancelImportHeightmap

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

History 5

ColormapHasUnknownPixels

Parameters (0)
No parameters.

History 1

GetHeightmapPreviewAsync

Parameters (1)
heightmapAssetIdContentId
Returns (1)
Tuple
This function yields. It will block the calling thread until completion.

History 3

Tags: [Yields]

ImportHeightmap

Parameters (4)
regionRegion3
heightmapAssetIdContentId
colormapAssetIdContentId
defaultMaterialMaterial
Returns (1)
null
This function yields. It will block the calling thread until completion.

History 6

Tags: [Yields]

IsValidColormap

Parameters (1)
colormapAssetIdContentId
Returns (1)
Tuple

History 6

IsValidHeightmap

Parameters (1)
heightmapAssetIdContentId
Returns (1)
Tuple

History 3

ProgressUpdate

Parameters (2)
progressRatiofloat
operationstring

History 5

SetImportHeightmapPaused

Parameters (1)
pausedbool
Returns (1)
null

History 5

Removed members 1

GetGreyscale

Parameters (1)
heightmapAssetIdContent
Returns (1)
Tuple

History 4

Settings