InsertService

extends Instance

Class fields

FieldXML typeValue
NamestringInsertService
summarystringA service used to insert objects stored on the website into the game.

Properties

1
AllowInsertFreeModels
bool
FieldXML typeValue
NamestringAllowInsertFreeModels

Functions

14
ApproveAssetId
(assetId: int) → void
FieldXML typeValue
NamestringApproveAssetId
Deprecatedbooltrue
summarystringDeprecated
ApproveAssetVersionId
(assetVersionId: int) → void
FieldXML typeValue
NamestringApproveAssetVersionId
Deprecatedbooltrue
summarystringDeprecated
Insert
(instance: Instance) → void
FieldXML typeValue
NamestringInsert
summarystringInserts the Instance into the workspace. It is recommended to use Instance.Parent = game.Workspace instead, as this can cause issues currently.
SetAdvancedResults
(enable: bool, user: bool = …) → void
FieldXML typeValue
NamestringSetAdvancedResults
SetAssetUrl
(assetUrl: string) → void
FieldXML typeValue
NamestringSetAssetUrl
SetAssetVersionUrl
(assetVersionUrl: string) → void
FieldXML typeValue
NamestringSetAssetVersionUrl
SetBaseCategoryUrl
(baseSetsUrl: string) → void
FieldXML typeValue
NamestringSetBaseCategoryUrl
SetBaseSetsUrl
(baseSetsUrl: string) → void
FieldXML typeValue
NamestringSetBaseSetsUrl
SetCollectionUrl
(collectionUrl: string) → void
FieldXML typeValue
NamestringSetCollectionUrl
SetFreeDecalUrl
(freeDecalUrl: string) → void
FieldXML typeValue
NamestringSetFreeDecalUrl
SetFreeModelUrl
(freeModelUrl: string) → void
FieldXML typeValue
NamestringSetFreeModelUrl
SetTrustLevel
(trustLevel: float) → void
FieldXML typeValue
NamestringSetTrustLevel
SetUserCategoryUrl
(userSetsUrl: string) → void
FieldXML typeValue
NamestringSetUserCategoryUrl
SetUserSetsUrl
(userSetsUrl: string) → void
FieldXML typeValue
NamestringSetUserSetsUrl

Yield functions

11
GetBaseCategories
() → Array
FieldXML typeValue
NamestringGetBaseCategories
Deprecatedbooltrue
summarystringDeprecated. Use GetBaseSets() instead.
GetBaseSets
() → Array
FieldXML typeValue
NamestringGetBaseSets
summarystringReturns a table containing a list of the various setIds that are ROBLOX approved. <a href="http://wiki.roblox.com/index.php/Sets" target="_blank">More info on sets</a>
GetCollection
(categoryId: int) → Array
FieldXML typeValue
NamestringGetCollection
summarystringReturns a table for the assets stored in the category. A category is an setId from www.roblox.com that links to a set. <a href="http://wiki.roblox.com/index.php?title=API:Class/InsertService/GetCollection" target="_blank">More info on table format</a>. <a href="http://wiki.roblox.com/index.php/Sets" target="_blank">More info on sets</a>
GetFreeDecals
(searchText: string, pageNum: int) → Array
FieldXML typeValue
NamestringGetFreeDecals
GetFreeModels
(searchText: string, pageNum: int) → Array
FieldXML typeValue
NamestringGetFreeModels
GetLatestAssetVersionAsync
(assetId: int) → int
FieldXML typeValue
NamestringGetLatestAssetVersionAsync
GetUserCategories
(userId: int) → Array
FieldXML typeValue
NamestringGetUserCategories
Deprecatedbooltrue
summarystringDeprecated. Use GetUserSets() instead.
GetUserSets
(userId: int) → Array
FieldXML typeValue
NamestringGetUserSets
summarystringReturns a table containing a list of the various setIds that correspond to argument 'userId'. <a href="http://wiki.roblox.com/index.php/Sets" target="_blank">More info on sets</a>
LoadAsset
(assetId: int) → Instance
FieldXML typeValue
NamestringLoadAsset
summarystringReturns a Model containing the Instance that resides at AssetId on the web. This call will also yield the script until the model is returned. Script execution can still continue, however, if you use a <a href="http://wiki.roblox.com/index.php?title=Coroutine" target="_blank">coroutine</a>.
LoadAssetVersion
(assetVersionId: int) → Instance
FieldXML typeValue
NamestringLoadAssetVersion
summarystringSimilar to LoadAsset, but instead an AssetVersionId is passed in, which refers to a particular version of the asset which is not neccessarily the latest version.
loadAsset
(assetId: int) → Instance
FieldXML typeValue
NamestringloadAsset

Events

6
InsertError
(key: string, message: string) → void
FieldXML typeValue
NamestringInsertError
InsertReady
(key: string, instance: Instance) → void
FieldXML typeValue
NamestringInsertReady
InsertRequest
(key: string, contentId: Content) → void
FieldXML typeValue
NamestringInsertRequest
InsertRequestAsset
(key: string, assetId: int, userId: int) → void
FieldXML typeValue
NamestringInsertRequestAsset
InsertRequestAssetVersion
(key: string, assetVersionId: int, userId: int) → void
FieldXML typeValue
NamestringInsertRequestAssetVersion
InternalDelete
(instance: Instance) → void
FieldXML typeValue
NamestringInternalDelete