Skip to content
Roblox API Reference

InsertService

Used to insert assets from the Roblox website.
  • Not creatable
  • Service
Memory category
Instances
Own members
24
Inherited members
75
Subclasses
0
Siblings
608

Properties24

Inherited fromObject2

Property categoryData

Inherited fromInstance21

Property categoryBehavior

Property categoryData

Property categoryPermissions

Defined byInsertService1

Property categoryBehavior

  • InsertService.AllowInsertFreeModels: boolean = false
    Deprecated: This item was never released. Do not use it in new work.
    Indicates whether ''Free Models'' can be inserted into the game.
    • Deprecated
    • Not browsable
    • Not replicated
    • Capabilities: LoadUnownedAsset

Methods64

Inherited fromObject3
  • Get an event that fires when a given property of the object changes.
    Parameters
    ParameterDescription
    property: string
    The property to connect to.
    Returns
    TypeDescription
    RBXScriptSignal
    A signal that fires whenever the property changes.
  • Object:IsA(className: string): boolean
    Returns true if an object's class matches or inherits from a given class.
    • Custom Lua state
    • Thread safe
    Parameters
    ParameterDescription
    className: string
    The class against which the Object's class will be checked. Case-sensitive.
    Returns
    TypeDescription
    boolean
    Describes whether the Object's class matched or is a subclass of the given class.
  • Object:isA(className: string): boolean
    Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
    • Deprecated
    • Custom Lua state
    Parameters
    Parameter
    className: string
    Returns
    Type
    boolean

    Use IsA instead.

Inherited fromInstance39
Defined byInsertService22
  • InsertService:CreateMeshPartAsync(meshId: string,collisionFidelity: Enum.CollisionFidelity,renderFidelity: Enum.RenderFidelity,): MeshPart
    Creates a new MeshPart with specified fidelity values.
    • Yields
    • Capabilities: Basic
    Parameters
    ParameterDescription
    meshId: string
    Mesh asset ID.
    collisionFidelity: Enum.CollisionFidelity
    renderFidelity: Enum.RenderFidelity
    Returns
    TypeDescription
    MeshPart
    New MeshPart instance.
  • InsertService:GetFreeDecalsAsync(searchText: string, pageNum: number): { any }
    Retrieves a list of free Decals from the Catalog.
    • Yields
    • Capabilities: AssetRead
    Parameters
    ParameterDescription
    searchText: string
    String used to search for free decals in the Catalog.
    pageNum: number
    The page number in the Catalog to return.
    Returns
    TypeDescription
    { any }
    A single table (of returned free decals) wrapped in a table.
  • InsertService:GetFreeModelsAsync(searchText: string, pageNum: number): { any }
    Retrieves a list of Free Models from the Catalog.
    • Yields
    • Capabilities: AssetRead
    Parameters
    ParameterDescription
    searchText: string
    String used to search for free decals in the Catalog.
    pageNum: number
    The page number in the Catalog to return.
    Returns
    TypeDescription
    { any }
    A single table (of returned free models) wrapped in a table.
  • InsertService:GetLatestAssetVersionAsync(assetId: number): number
    Returns the latest AssetVersionId of an asset for assets created by the place creator. Can be used in combination with InsertService:LoadAssetVersion() to load the latest version of a model, even if it gets updated while the game is running.
    • Yields
    • Capabilities: AssetRead
    Parameters
    ParameterDescription
    assetId: number
    The ID of the asset to retrieve the latest version for.
    Returns
    TypeDescription
    number
    The latest asset version ID for the specified asset.
  • InsertService:GetLocalFileContents(contentId: string): string
    • Roblox script security
    Parameters
    Parameter
    contentId: string
    Returns
    Type
    string
  • InsertService:LoadAsset(assetId: number): Instance
    Returns a Model containing the asset.
    • Yields
    • Capabilities: LoadOwnedAsset
    Parameters
    ParameterDescription
    assetId: number
    The asset ID of the asset being loaded.
    Returns
    TypeDescription
    Instance
    An instance of the loaded asset.
  • InsertService:LoadAssetVersion(assetVersionId: number): Instance
    Returns a model inserted into InsertService containing the asset with the given assetVersionId.
    • Yields
    • Capabilities: LoadOwnedAsset
    Parameters
    ParameterDescription
    assetVersionId: number
    The version ID of the asset to load.
    Returns
    TypeDescription
    Instance
    A Model containing the asset at the specified version.
  • InsertService:LoadAssetWithBytecodeAsync(content: Content): Instance
    • Yields
    • Roblox script security
    Parameters
    Parameter
    content: Content
    Returns
    Type
    Instance
  • InsertService:LoadAssetWithFormat(assetId: number, format: string): { Instance }
    • Yields
    • Roblox script security
    Parameters
    Parameter
    assetId: number
    format: string
    Returns
    Type
    { Instance }
  • InsertService:LoadLocalAsset(assetPath: string): Instance
    • Roblox script security
    Parameters
    Parameter
    assetPath: string
    Returns
    Type
    Instance
  • InsertService:LoadPackageAssetAsync(url: string): { Instance }
    • Yields
    • Roblox script security
    Parameters
    Parameter
    url: string
    Returns
    Type
    { Instance }
  • InsertService:ApproveAssetId(assetId: number)
    Deprecated: This item is deprecated. Do not use it for new work.
    Deprecated. Accepts an asset ID for InsertService approval; calling it has no effect.
    • Deprecated
    Parameters
    ParameterDescription
    assetId: number
    The ID of the asset.
  • InsertService:ApproveAssetVersionId(assetVersionId: number)
    Deprecated: This item is deprecated. Do not use it for new work.
    Deprecated. Accepts an asset version ID for InsertService approval; calling it has no effect.
    • Deprecated
    Parameters
    ParameterDescription
    assetVersionId: number
    The version ID of the asset.
  • InsertService:GetBaseCategories(): { any }
    Deprecated: This item is deprecated. Do not use it for new work.
    • Deprecated
    • Yields
    Returns
    Type
    { any }

    Use GetBaseSets instead.

  • InsertService:GetBaseSets(): { any }
    Deprecated:Sets have been removed (opens in a new tab) from Roblox.
    Returns an array of dictionaries, containing information about various Roblox approved sets.
    • Deprecated
    • Yields
    Returns
    TypeDescription
    { any }
    An array of dictionaries containing information about Roblox-approved sets.
  • InsertService:GetCollection(categoryId: number): { any }
    Deprecated:Sets have been removed (opens in a new tab) from Roblox.
    Returns the most recently uploaded models in the specified category.
    • Deprecated
    • Yields
    Parameters
    ParameterDescription
    categoryId: number
    The ID of the set (category) to retrieve models from.
    Returns
    TypeDescription
    { any }
    An array of the most recently uploaded models in the specified set.
  • InsertService:GetFreeDecals(searchText: string, pageNum: number): { any }
    Deprecated: Use GetFreeDecalsAsync() instead.
    Retrieves a list of free Decals from the Catalog.
    • Deprecated
    • Yields
    • Capabilities: AssetRead
    Parameters
    ParameterDescription
    searchText: string
    String used to search for free decals in the Catalog.
    pageNum: number
    The page number in the Catalog to return.
    Returns
    TypeDescription
    { any }
    A single table (of returned free decals) wrapped in a table.

    Use GetFreeDecalsAsync instead.

  • InsertService:GetFreeModels(searchText: string, pageNum: number): { any }
    Deprecated: Use GetFreeModelsAsync() instead.
    Retrieves a list of Free Models from the Catalog.
    • Deprecated
    • Yields
    • Capabilities: AssetRead
    Parameters
    ParameterDescription
    searchText: string
    String used to search for free models in the Catalog.
    pageNum: number
    The page number in the Catalog to return.
    Returns
    TypeDescription
    { any }
    A single table (of returned free models) wrapped in a table.

    Use GetFreeModelsAsync instead.

  • InsertService:GetUserCategories(userId: User): { any }
    Deprecated: This item is deprecated. Do not use it for new work.
    • Deprecated
    • Yields
    Parameters
    Parameter
    userId: User
    Returns
    Type
    { any }

    Use GetUserSets instead.

  • InsertService:GetUserSets(userId: User): { any }
    Deprecated:Sets have been removed (opens in a new tab) from Roblox.
    Returns an array of dictionaries, containing information about sets owned by the user.
    • Deprecated
    • Yields
    Parameters
    ParameterDescription
    userId: User
    The ID of the user whose sets to retrieve.
    Returns
    TypeDescription
    { any }
    An array of dictionaries containing information about the user's sets.
  • InsertService:Insert(instance: Instance)
    Deprecated: This function has been superseded by InsertService:LoadAsset() which should be used in all new work.
    Inserts Instance into Workspace.
    • Deprecated
    Parameters
    ParameterDescription
    instance: Instance
    The Instance to insert into Workspace.
  • InsertService:loadAsset(assetId: number): Instance
    Deprecated: This function is a deprecated variant of InsertService:LoadAsset() which should be used instead.
    • Deprecated
    • Yields
    • Capabilities: LoadOwnedAsset
    Parameters
    Parameter
    assetId: number
    Returns
    Type
    Instance

    Use LoadAsset instead.

Events11

Inherited fromObject1
Inherited fromInstance9
Defined byInsertService1