AssetService On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.

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

Memory Category	Instances

Tags: [NotCreatable, Service]

Inherits (1)

Instance

Member index (18)

Type	Member	History
EditableImage	CreateEditableImageAsync (Content textureId)	601
EditableMesh	CreateEditableMeshAsync (Content meshId)	602
EditableMesh	CreateEditableMeshFromPartAsync (Instance meshPart)	602
int64	CreatePlaceAsync (string placeName, int64 templatePlaceID, string description = )	138 315 325
int64	CreatePlaceInPlayerInventoryAsync (Instance player, string placeName, int64 templatePlaceID, string description = )	138 315 325
Instance	DeserializeInstance (string serializedInstance)	583
Array	GetAssetIdsForPackage (int64 packageAssetId)	268 315
Dictionary	GetBundleDetailsAsync (int64 bundleId)	360
Dictionary	GetBundleDetailsSync (int64 bundleId)	375
int64	GetCreatorAssetID (int64 creationID)	122 292 319 325
Instance	GetGamePlacesAsync ()	163
Tuple	PromptCreateAssetAsync (Player player, Instance instance, AssetType assetType)	587
Tuple	PromptImportAnimationClipFromVideoAsync (Player player, Function progressCallback)	594
null	RegisterUGCValidationFunction (Function function)	589
null	SavePlaceAsync ()	138 573
AudioPages	SearchAudio (AudioSearchParams searchParameters)	568
	OpenCreateResultModal (PromptCreateAssetResult resultType)	587
	OpenPublishResultModal (PromptPublishAssetResult resultType)	567
57 members inherited from Instance

Removed member index (13)

Type	Member	History
DynamicImage	CreateDynamicImageAsync (Content textureId)	591 601
DynamicMesh	CreateDynamicMeshAsync (Content meshId)	593 602
Tuple	GetAssetThumbnailAsync (int64 assetId, Vector2 thumbnailSize, int assetType = 0)	312 311 312 315 558
Dictionary	GetAssetVersions (int placeId, int pageNum = 1)	319
Dictionary	GetPlacePermissions (int placeId)	319
DynamicImage	LoadImageAsync (Content textureId)	583 591
Tuple	PromptPublishAssetAsync (Player player, Instance instance, AssetType assetType)	567 587
bool	RevertAsset (int placeId, int versionNumber)	319
void	SetAssetRevertUrl (string revertUrl)	310
void	SetAssetVersionsUrl (string versionsUrl)	310
void	SetPlaceAccessUrl (string accessUrl)	310
bool	SetPlacePermissions (int placeId, AccessType accessType = Everyone, Array inviteList = {})	319
DynamicMesh	createDynamicMeshFromPartAsync (Instance meshPart)	601 602

602 Remove AssetService.CreateDynamicMeshAsync
602 Add AssetService.CreateEditableMeshAsync
602 Add AssetService.CreateEditableMeshFromPartAsync
602 Remove AssetService.createDynamicMeshFromPartAsync
601 Remove AssetService.CreateDynamicImageAsync
601 Add AssetService.CreateEditableImageAsync
601 Add AssetService.createDynamicMeshFromPartAsync
594 Add AssetService.PromptImportAnimationClipFromVideoAsync
593 Add AssetService.CreateDynamicMeshAsync
591 Add AssetService.CreateDynamicImageAsync
591 Remove AssetService.LoadImageAsync
589 Add AssetService.RegisterUGCValidationFunction
587 Add AssetService.PromptCreateAssetAsync
587 Remove AssetService.PromptPublishAssetAsync
587 Add AssetService.OpenCreateResultModal
583 Add AssetService.DeserializeInstance
583 Add AssetService.LoadImageAsync
573 Change ReturnType of AssetService.SavePlaceAsync from void to null
568 Add AssetService.SearchAudio
567 Add AssetService.PromptPublishAssetAsync
567 Add AssetService.OpenPublishResultModal
558 Remove AssetService.GetAssetThumbnailAsync
375 Add AssetService.GetBundleDetailsSync
360 Add AssetService.GetBundleDetailsAsync
325 Change ReturnType of AssetService.CreatePlaceAsync from int to int64
325 Change ReturnType of AssetService.CreatePlaceInPlayerInventoryAsync from int to int64
325 Change ReturnType of AssetService.GetCreatorAssetID from int to int64
319 Remove AssetService.GetAssetVersions
319 Change Parameters of AssetService.GetCreatorAssetID from (int creationID) to (int64 creationID)
319 Remove AssetService.GetPlacePermissions
319 Remove AssetService.RevertAsset
319 Remove AssetService.SetPlacePermissions
315 Change Parameters of AssetService.CreatePlaceAsync from (string placeName, int templatePlaceID, string description = ) to (string placeName, int64 templatePlaceID, string description = )
315 Change Parameters of AssetService.CreatePlaceInPlayerInventoryAsync from (Instance player, string placeName, int templatePlaceID, string description = ) to (Instance player, string placeName, int64 templatePlaceID, string description = )
315 Change Parameters of AssetService.GetAssetIdsForPackage from (int packageAssetId) to (int64 packageAssetId)
315 Change Parameters of AssetService.GetAssetThumbnailAsync from (int assetId, Vector2 thumbnailSize, int assetType = 0) to (int64 assetId, Vector2 thumbnailSize, int assetType = 0)
312 Add AssetService.GetAssetThumbnailAsync
311 Remove AssetService.GetAssetThumbnailAsync
312 Add AssetService.GetAssetThumbnailAsync
310 Remove AssetService.SetAssetRevertUrl
310 Remove AssetService.SetAssetVersionsUrl
310 Remove AssetService.SetPlaceAccessUrl
292 Change Tags of AssetService.GetCreatorAssetID from [Yields] to [Yields, Deprecated]
268 Add AssetService.GetAssetIdsForPackage
163 Add AssetService.GetGamePlacesAsync
138 Add AssetService.CreatePlaceAsync
138 Add AssetService.CreatePlaceInPlayerInventoryAsync
138 Add AssetService.SavePlaceAsync
122 Add AssetService.GetCreatorAssetID
119 Add AssetService

Members

CreateEditableImageAsync On DevHub

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

Parameters	1

Name	Type	Default
textureId	Content	none

Return Type	EditableImage

History

601 Add AssetService.CreateEditableImageAsync

Tags: [Yields]

CreateEditableMeshAsync On DevHub

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

Parameters	1

Name	Type	Default
meshId	Content	none

Return Type	EditableMesh

History

602 Add AssetService.CreateEditableMeshAsync

Tags: [Yields]

CreateEditableMeshFromPartAsync On DevHub

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

Parameters	1

Name	Type	Default
meshPart	Instance	none

Return Type	EditableMesh

History

602 Add AssetService.CreateEditableMeshFromPartAsync

Tags: [Yields]

CreatePlaceAsync On DevHub

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

Parameters	3

Name	Type	Default
placeName	string	none
templatePlaceID	int64	none
description	string

Return Type	int64

History

325 Change ReturnType of AssetService.CreatePlaceAsync from int to int64
315 Change Parameters of AssetService.CreatePlaceAsync from (string placeName, int templatePlaceID, string description = ) to (string placeName, int64 templatePlaceID, string description = )
138 Add AssetService.CreatePlaceAsync

Tags: [Yields]

CreatePlaceInPlayerInventoryAsync On DevHub

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

Parameters	4

Name	Type	Default
player	Instance	none
placeName	string	none
templatePlaceID	int64	none
description	string

Return Type	int64

History

325 Change ReturnType of AssetService.CreatePlaceInPlayerInventoryAsync from int to int64
315 Change Parameters of AssetService.CreatePlaceInPlayerInventoryAsync from (Instance player, string placeName, int templatePlaceID, string description = ) to (Instance player, string placeName, int64 templatePlaceID, string description = )
138 Add AssetService.CreatePlaceInPlayerInventoryAsync

Tags: [Yields]

DeserializeInstance On DevHub

Parameters	1

Name	Type	Default
serializedInstance	string	none

Return Type	Instance
Security	RobloxScriptSecurity

History

583 Add AssetService.DeserializeInstance

GetAssetIdsForPackage On DevHub

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

Parameters	1

Name	Type	Default
packageAssetId	int64	none

Return Type	Array

History

315 Change Parameters of AssetService.GetAssetIdsForPackage from (int packageAssetId) to (int64 packageAssetId)
268 Add AssetService.GetAssetIdsForPackage

Tags: [Yields]

GetBundleDetailsAsync On DevHub

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

Parameters	1

Name	Type	Default
bundleId	int64	none

Return Type	Dictionary

History

360 Add AssetService.GetBundleDetailsAsync

Tags: [Yields]

GetBundleDetailsSync On DevHub

Parameters	1

Name	Type	Default
bundleId	int64	none

Return Type	Dictionary
Security	RobloxScriptSecurity

History

375 Add AssetService.GetBundleDetailsSync

GetCreatorAssetID On DevHub

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

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	1

Name	Type	Default
creationID	int64	none

Return Type	int64

History

325 Change ReturnType of AssetService.GetCreatorAssetID from int to int64
319 Change Parameters of AssetService.GetCreatorAssetID from (int creationID) to (int64 creationID)
292 Change Tags of AssetService.GetCreatorAssetID from [Yields] to [Yields, Deprecated]
122 Add AssetService.GetCreatorAssetID

Tags: [Yields, Deprecated]

GetGamePlacesAsync On DevHub

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

Parameters	0

Name	Type	Default
No parameters.

Return Type	Instance

History

163 Add AssetService.GetGamePlacesAsync

Tags: [Yields]

OpenCreateResultModal On DevHub

Parameters	1

Name	Type	Default
resultType	PromptCreateAssetResult	none

Security	RobloxScriptSecurity

History

587 Add AssetService.OpenCreateResultModal

OpenPublishResultModal On DevHub

Parameters	1

Name	Type	Default
resultType	PromptPublishAssetResult	none

Security	RobloxScriptSecurity

History

567 Add AssetService.OpenPublishResultModal

PromptCreateAssetAsync On DevHub

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

Parameters	3

Name	Type	Default
player	Player	none
instance	Instance	none
assetType	AssetType	none

Return Type	Tuple

History

587 Add AssetService.PromptCreateAssetAsync

Tags: [Yields]

PromptImportAnimationClipFromVideoAsync On DevHub

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

Parameters	2

Name	Type	Default
player	Player	none
progressCallback	Function	none

Return Type	Tuple

History

594 Add AssetService.PromptImportAnimationClipFromVideoAsync

Tags: [Yields]

RegisterUGCValidationFunction On DevHub

Parameters	1

Name	Type	Default
function	Function	none

Return Type	null
Security	RobloxScriptSecurity

History

589 Add AssetService.RegisterUGCValidationFunction

SavePlaceAsync On DevHub

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

Parameters	0

Name	Type	Default
No parameters.

Return Type	null

History

573 Change ReturnType of AssetService.SavePlaceAsync from void to null
138 Add AssetService.SavePlaceAsync

Tags: [Yields]

SearchAudio On DevHub

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

Parameters	1

Name	Type	Default
searchParameters	AudioSearchParams	none

Return Type	AudioPages

History

568 Add AssetService.SearchAudio

Tags: [Yields]

Removed members

CreateDynamicImageAsync

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

Parameters	1

Name	Type	Default
textureId	Content	none

Return Type	DynamicImage

History

601 Remove AssetService.CreateDynamicImageAsync
591 Add AssetService.CreateDynamicImageAsync

Tags: [Yields]

CreateDynamicMeshAsync

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

Parameters	1

Name	Type	Default
meshId	Content	none

Return Type	DynamicMesh

History

602 Remove AssetService.CreateDynamicMeshAsync
593 Add AssetService.CreateDynamicMeshAsync

Tags: [Yields]

GetAssetThumbnailAsync

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

Parameters	3

Name	Type	Default
assetId	int64	none
thumbnailSize	Vector2	none
assetType	int	0

Return Type	Tuple
Security	RobloxScriptSecurity

History

558 Remove AssetService.GetAssetThumbnailAsync
315 Change Parameters of AssetService.GetAssetThumbnailAsync from (int assetId, Vector2 thumbnailSize, int assetType = 0) to (int64 assetId, Vector2 thumbnailSize, int assetType = 0)
312 Add AssetService.GetAssetThumbnailAsync
311 Remove AssetService.GetAssetThumbnailAsync
312 Add AssetService.GetAssetThumbnailAsync

Tags: [Yields]

GetAssetVersions

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

Parameters	2

Name	Type	Default
placeId	int	none
pageNum	int	1

Return Type	Dictionary

History

319 Remove AssetService.GetAssetVersions

Tags: [Yields]

GetPlacePermissions

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

Parameters	1

Name	Type	Default
placeId	int	none

Return Type	Dictionary

History

319 Remove AssetService.GetPlacePermissions

Tags: [Yields]

LoadImageAsync

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

Parameters	1

Name	Type	Default
textureId	Content	none

Return Type	DynamicImage

History

591 Remove AssetService.LoadImageAsync
583 Add AssetService.LoadImageAsync

Tags: [Yields]

PromptPublishAssetAsync

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

Parameters	3

Name	Type	Default
player	Player	none
instance	Instance	none
assetType	AssetType	none

Return Type	Tuple

History

587 Remove AssetService.PromptPublishAssetAsync
567 Add AssetService.PromptPublishAssetAsync

Tags: [Yields]

RevertAsset

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

Parameters	2

Name	Type	Default
placeId	int	none
versionNumber	int	none

Return Type	bool

History

319 Remove AssetService.RevertAsset

Tags: [Yields]

SetAssetRevertUrl

Parameters	1

Name	Type	Default
revertUrl	string	none

Return Type	void
Security	LocalUserSecurity

History

310 Remove AssetService.SetAssetRevertUrl

SetAssetVersionsUrl

Parameters	1

Name	Type	Default
versionsUrl	string	none

Return Type	void
Security	LocalUserSecurity

History

310 Remove AssetService.SetAssetVersionsUrl

SetPlaceAccessUrl

Parameters	1

Name	Type	Default
accessUrl	string	none

Return Type	void
Security	LocalUserSecurity

History

310 Remove AssetService.SetPlaceAccessUrl

SetPlacePermissions

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

Parameters	3

Name	Type	Default
placeId	int	none
accessType	AccessType	Everyone
inviteList	Array	{}

Return Type	bool

History

319 Remove AssetService.SetPlacePermissions

Tags: [Yields]

createDynamicMeshFromPartAsync

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

Parameters	1

Name	Type	Default
meshPart	Instance	none

Return Type	DynamicMesh

History

Tags: [Yields]