AssetService

Clones a place with placeId equal to given templatePlaceId. The clone place displays within the inventory of the place's creator with the given name and description. This method returns the placeId of the new place, which you can use with TeleportService. The template place must have template copying enabled through place settings. You cannot use this method to clone places that you don't own.

Frequent use of this API isn't recommended, particularly if the created places contain scripts, as updating the code in a large volume of places quickly becomes infeasible. For user-generated worlds, consider serializing user creations and saving them in DataStores instead.

Parameters

Returns

This function has been removed as of Release 471. Clones a place which has a placeId equal to the given templatePlaceID, placing it into the inventory of the given player with the given name and description, if they accept when prompted. This method cannot be used to clone places that you do not own, or those which have disabled the use of the CreatePlace API in their place's configuration.

Parameters

Returns

Returns an array of assetIds that are contained in a specified package.

Parameters

Returns

If the bundle Id does not exist, it throws HTTP 400 (HTTP/1.1 400 Bad Request). If bundleId is not convertible to int, throws "Unable to cast string to int64". If param type is string, it implicitly tries to convert to int.

This function returns details of the contents of the specified bundle.

Understanding the returned ValueTable

It returns a ValueTable object with the following key-value pairs containing details about the specified bundle

Each object in the Items array contains details of the item as described in the table below:

Parameters

Returns

local AssetService = game:GetService("AssetService")

local BUNDLE_ID = 13

local bundleDetails = AssetService:GetBundleDetailsAsync(BUNDLE_ID)

print(bundleDetails)

Returns a StandardPages object which contains the name and placeId of places within the current 'Game' (otherwise known as a 'Universe').

Returns

local AssetService = game:GetService("AssetService")

local pages = AssetService:GetGamePlacesAsync()

while true do
	for _, place in pairs(pages:GetCurrentPage()) do
		print("Name: " .. place.Name)
		print("PlaceId: " .. tostring(place.PlaceId))
	end
	if pages.IsFinished then
		-- we reached the last page of results
		break
	end
	pages:AdvanceToNextPageAsync()
end

Parameters

Returns

Saves the state of the current place. This only works for places that are created with AssetService:CreatePlaceAsync() or have the API enabled through place settings.

Returns

Returns a AudioPages object containing the result of the given search. Will not return fields with empty values.

Note that this method has a low HTTP request limit and can throw an error, so it should always be wrapped in pcall() for error handling. Possible error messages include:

Parameters

Returns

local AssetService = game:GetService("AssetService")

local audioSearchParams = Instance.new("AudioSearchParams")
audioSearchParams.SearchKeyword = "happy"

local success, result = pcall(function()
    return AssetService:SearchAudio(audioSearchParams)
end)

if success then
    local currentPage = result:GetCurrentPage()
    for _, audio in currentPage do
        print(audio.Title)
    end
else
    warn("AssetService error: " .. result)
end

--[[ Returned data format
{
    "AudioType": string,
    "Artist": string,
    "Title": string,
    "Tags": {
        "string"
    },
    "Id": number,
    "IsEndorsed": boolean,
    "Description": string,
    "Duration": number,
    "CreateTime": string,
    "UpdateTime": string,
    "Creator": {
        "Id": number,
        "Name": string,
        "Type": number,
        "IsVerifiedCreator": boolean
    }
}
--]]