PreloadAsync

Yields

This is a yielding function. When called, it will pause the Lua thread that called the function until a result is ready to be returned, without interrupting other scripts.

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Function of:

ContentProvider

Description:

Yields until all of the assets associated with the given Instance|Instances have loaded and takes an array of Instance|Instances as a parameter.

This can be used to pause a script and not use content until it is certain that the content has been loaded into the game.

When the function is called, the engine will go through the array of instances (and all of the descendants of the passed-in instances). If any of the instances have a property that defines a link to content, such as a Decal or a Sound, then the function will attempt to load the asset from the Roblox website. If any of the assets fail to load, an error message will appear in the output, but the PreloadAsync function itself will not error and will continue executing until it has processed each passed-in instance.

Parameters

Name	Type	Default	Description
Name contentIdList	Type Array	Default	Summary An array of `Instance`s to be preloaded.
Name callbackFunction	Type Function	Default nil	Summary The Lua function to be called on completion of each asset request

Returns

Return Type	Summary
Return Type void	Summary No return

Code Samples

Preloading Assets

In this code sample, several textures and sounds are preloaded using Sound and Decal instances, as well as plain /articles/Content|Content. Furthermore, 50 random user avatars are preloaded.

			
				Preloading Assets

				Expected Output
			
				Expand
				
			local ContentProvider = game:GetService("ContentProvider")

-- Create some objects to be preloaded
local sound = Instance.new("Sound")
sound.SoundId = "rbxassetid://1838058421"
local decal = Instance.new("Decal")
decal.Texture = "rbxassetid://5447528495"

-- A table of various assets to preload (Instances or content)
local assets = {
	decal,
	sound,
	"rbxassetid://5173222739",
	"rbxthumb://type=Avatar&w=100&h=100&id=269323"
}

-- For demonstration, pre-load 50 random user's avatar thumbnails
for i = 1, 50 do
	table.insert(assets, "rbxthumb://type=Avatar&w=100&h=100&id=" .. math.random(1,1000000))
end

-- Preload the content and time it
local startTime = os.clock()
ContentProvider:PreloadAsync(assets)
local deltaTime = os.clock() - startTime
print(("Preloading complete, took %.2f seconds"):format(deltaTime))
		
				Copy Code
			
				Light Theme

PreloadAsync

Parameters

contentIdList

callbackFunction

Returns

void

Code Samples

Preloading Assets