# HeightmapImporterService

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Tags: Not replicated, Service
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/HeightmapImporterService/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/HeightmapImporterService

A Studio-only service that backs the Terrain Editor's heightmap import tool, converting heightmap and colormap images into voxel [`Terrain`](https://rapi.sleaze.dev/classes/Terrain.md).

## Methods

### CancelImportHeightmap

```luau
HeightmapImporterService:CancelImportHeightmap()
```

- Tags: Roblox script security

### GetHeightmapPreviewAsync

```luau
HeightmapImporterService:GetHeightmapPreviewAsync(heightmapAssetId: string): ...any
```

- Tags: Yields, Roblox script security

### ImportHeightmap

```luau
HeightmapImporterService:ImportHeightmap(region: Region3, heightmapAssetId: string, colormapAssetId: string, defaultMaterial: Enum.Material)
```

- Tags: Yields, Roblox script security

### ImportHeightmapWithMaterialSlotsAsync

```luau
HeightmapImporterService:ImportHeightmapWithMaterialSlotsAsync(region: Region3, heightmapAssetId: string, colormapAssetId: string, defaultMaterialIndex: number)
```

- Tags: Yields, Roblox script security

### IsValidColormap

```luau
HeightmapImporterService:IsValidColormap(colormapAssetId: string): ...any
```

- Tags: Roblox script security

### IsValidHeightmap

```luau
HeightmapImporterService:IsValidHeightmap(heightmapAssetId: string): ...any
```

- Tags: Roblox script security

### SetImportHeightmapPaused

```luau
HeightmapImporterService:SetImportHeightmapPaused(paused: boolean)
```

- Tags: Roblox script security

## Events

### ColormapHasUnknownPixels

```luau
HeightmapImporterService.ColormapHasUnknownPixels: RBXScriptSignal<()>
```

- Tags: Roblox script security

### ProgressUpdate

```luau
HeightmapImporterService.ProgressUpdate: RBXScriptSignal<(progressRatio: number, operation: string)>
```

- Tags: Roblox script security

## Inherited members

- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`