HeightmapImporterService On DevHub

Summary

This class is a service. It is a singleton that may be acquired with GetService.

This item is not replicated. Its interface does not cross the network boundary.

Memory Category	Instances

Tags: [Service, NotReplicated]

Inherits (1)

Instance

Member index (8)

Type	Member	History
null	CancelImportHeightmap ()	459 458 459 573
Tuple	GetHeightmapPreviewAsync (Content heightmapAssetId)	460
null	ImportHeightmap (Region3 region, Content heightmapAssetId, Content colormapAssetId, Material defaultMaterial)	459 458 459 573
Tuple	IsValidColormap (Content colormapAssetId)	459 458 459
Tuple	IsValidHeightmap (Content heightmapAssetId)
null	SetImportHeightmapPaused (bool paused)	459 458 459 573
	ColormapHasUnknownPixels ()	464
	ProgressUpdate (float progressRatio, string operation)	459 458 459 464
57 members inherited from Instance

Removed member index (1)

Type		Member	History
Tuple		GetGreyscale (Content heightmapAssetId)	459 458 459 460

573 Change ReturnType of HeightmapImporterService.CancelImportHeightmap from void to null
573 Change ReturnType of HeightmapImporterService.ImportHeightmap from void to null
573 Change ReturnType of HeightmapImporterService.SetImportHeightmapPaused from void to null
464 Add HeightmapImporterService.ColormapHasUnknownPixels
464 Change Parameters of HeightmapImporterService.ProgressUpdate from (float progressRatio) to (float progressRatio, string operation)
460 Remove HeightmapImporterService.GetGreyscale
460 Add HeightmapImporterService.GetHeightmapPreviewAsync
459 Add HeightmapImporterService.CancelImportHeightmap
459 Add HeightmapImporterService.GetGreyscale
459 Add HeightmapImporterService.ImportHeightmap
459 Change Parameters of HeightmapImporterService.IsValidColormap from (Content heightmapAssetId) to (Content colormapAssetId)
459 Add HeightmapImporterService.SetImportHeightmapPaused
459 Add HeightmapImporterService.ProgressUpdate
458 Remove HeightmapImporterService.CancelImportHeightmap
458 Remove HeightmapImporterService.GetGreyscale
458 Remove HeightmapImporterService.ImportHeightmap
458 Change Parameters of HeightmapImporterService.IsValidColormap from (Content colormapAssetId) to (Content heightmapAssetId)
458 Remove HeightmapImporterService.SetImportHeightmapPaused
458 Remove HeightmapImporterService.ProgressUpdate
459 Add HeightmapImporterService.CancelImportHeightmap
459 Add HeightmapImporterService.GetGreyscale
459 Add HeightmapImporterService.ImportHeightmap
459 Change Parameters of HeightmapImporterService.IsValidColormap from (Content heightmapAssetId) to (Content colormapAssetId)
459 Add HeightmapImporterService.SetImportHeightmapPaused
459 Add HeightmapImporterService.ProgressUpdate
458 Add HeightmapImporterService

Members

CancelImportHeightmap On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of HeightmapImporterService.CancelImportHeightmap from void to null
459 Add HeightmapImporterService.CancelImportHeightmap
458 Remove HeightmapImporterService.CancelImportHeightmap
459 Add HeightmapImporterService.CancelImportHeightmap

ColormapHasUnknownPixels On DevHub

Parameters	0

Name	Type	Default
No parameters.

Security	RobloxScriptSecurity

History

464 Add HeightmapImporterService.ColormapHasUnknownPixels

GetHeightmapPreviewAsync On DevHub

This function yields. It will block the calling thread until completion.

Parameters	1

Name	Type	Default
heightmapAssetId	Content	none

Return Type	Tuple
Security	RobloxScriptSecurity

History

460 Add HeightmapImporterService.GetHeightmapPreviewAsync

Tags: [Yields]

ImportHeightmap On DevHub

This function yields. It will block the calling thread until completion.

Parameters	4

Name	Type	Default
region	Region3	none
heightmapAssetId	Content	none
colormapAssetId	Content	none
defaultMaterial	Material	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of HeightmapImporterService.ImportHeightmap from void to null
459 Add HeightmapImporterService.ImportHeightmap
458 Remove HeightmapImporterService.ImportHeightmap
459 Add HeightmapImporterService.ImportHeightmap

Tags: [Yields]

IsValidColormap On DevHub

Parameters	1

Name	Type	Default
colormapAssetId	Content	none

Return Type	Tuple
Security	RobloxScriptSecurity

History

459 Change Parameters of HeightmapImporterService.IsValidColormap from (Content heightmapAssetId) to (Content colormapAssetId)
458 Change Parameters of HeightmapImporterService.IsValidColormap from (Content colormapAssetId) to (Content heightmapAssetId)
459 Change Parameters of HeightmapImporterService.IsValidColormap from (Content heightmapAssetId) to (Content colormapAssetId)

IsValidHeightmap On DevHub

Parameters	1

Name	Type	Default
heightmapAssetId	Content	none

Return Type	Tuple
Security	RobloxScriptSecurity

ProgressUpdate On DevHub

Parameters	2

Name	Type	Default
progressRatio	float	none
operation	string	none

Security	RobloxScriptSecurity

History

464 Change Parameters of HeightmapImporterService.ProgressUpdate from (float progressRatio) to (float progressRatio, string operation)
459 Add HeightmapImporterService.ProgressUpdate
458 Remove HeightmapImporterService.ProgressUpdate
459 Add HeightmapImporterService.ProgressUpdate

SetImportHeightmapPaused On DevHub

Parameters	1

Name	Type	Default
paused	bool	none

Return Type	null
Security	RobloxScriptSecurity

History

573 Change ReturnType of HeightmapImporterService.SetImportHeightmapPaused from void to null
459 Add HeightmapImporterService.SetImportHeightmapPaused
458 Remove HeightmapImporterService.SetImportHeightmapPaused
459 Add HeightmapImporterService.SetImportHeightmapPaused

Removed members

GetGreyscale

Parameters	1

Name	Type	Default
heightmapAssetId	Content	none

Return Type	Tuple
Security	RobloxScriptSecurity

History

460 Remove HeightmapImporterService.GetGreyscale
459 Add HeightmapImporterService.GetGreyscale
458 Remove HeightmapImporterService.GetGreyscale
459 Add HeightmapImporterService.GetGreyscale

Relevant enums (1)

Material