ContentProvider

Used by the ContentProvider to download assets from the Roblox website.

This URL points to a Roblox hosted website from which assets are downloaded and is pulled from the AppSettings.xml file, located in the version-hash folder.

It is possible to overwrite this property using the ContentProvider:SetBaseUrl() function in the command bar; however, this is not recommended and may cause asset loading issues.

Gives the number of items in the ContentProvider request queue that need to be downloaded.

Items are added to the client's request queue when an asset is used for the first time or ContentProvider:PreloadAsync() is called.

Developers are advised not to use RequestQueueSize to create loading bars. This is because the queue size can both increase and decrease over time as new assets are added and downloaded. Developers looking to display loading progress should load assets one at a time (see example below).

Gets the current AssetFetchStatus of the contentId provided. Use GetAssetFetchStatusChangedSignal() to listen for changes to this value.

A signal that fires when the AssetFetchStatus of the provided content changes. Connect to this signal by using a callback with one argument of type AssetFetchStatus. This is particularly useful for assets that might update themselves automatically like the thumbnail of a user when they change clothes.

Returns an array containing every asset ID that currently has an encryption key registered on this ContentProvider, whether the key was registered directly through RegisterEncryptedAsset() or through RegisterSessionEncryptedAsset().

The default key set through RegisterDefaultEncryptionKey() is not included, because it isn't associated with any specific asset.

Usually, content is loaded only when it starts being used. That explains why it often takes a moment for an image to appear in a GuiObject, or a Mesh|mesh to appear in a part, or why a sound doesn't play for the first time. All because the asset has not yet finished loading. Preload is used to load this content beforehand, so that it works instantly.

Yields until all of the assets associated with the given Instances have loaded. This can be used to pause a script and not use content until it is certain that the content has been loaded into the experience.

When called, the engine identifies links to content for each item in the list. For any of the Instances which have properties that define links to content, such as a Decal or a Sound, the engine attempts to load these assets from Roblox. For each requested asset, the callback function runs, indicating the asset's final AssetFetchStatus.

If any of the assets fail to load, an error message appears in the output. The method itself will not error and it will continue executing until it has processed each requested instance.

Limitations#

SurfaceAppearance and MaterialVariant are not supported by PreloadAsync() because these objects rely on processed texture pack assets rather than directly loading individual textures. Calling it on a SurfaceAppearance instance will not do anything, but the associated textures will still be streamed in during runtime.

If PreloadAsync is called on Instances that are not currently visible, such as a Decal or an ImageLabel, the Engine will download and store textures used by those Instances in its disk cache. Because the Instances are not visible in these cases, the Engine may reduce memory consumption by unloading the textures after preloading them.

Sets a fallback encryption key that the ContentProvider uses to decrypt any encrypted asset that isn't matched by a key registered for a specific asset through RegisterEncryptedAsset(). When an asset is fetched, the engine first looks for a key registered for that asset's ID; if none exists, it falls back to this default key.

Decrypts sessionKey using the session's cryptographic context and then registers the decrypted result as the default encryption key, exactly as RegisterDefaultEncryptionKey() does. Use this variant when the key is delivered to the client in session-encrypted form rather than as plaintext.

Associates encryptionKey with the given assetId so that, when the ContentProvider fetches that asset, it uses the key to decrypt the downloaded file. A key registered for a specific asset takes precedence over the default key set through RegisterDefaultEncryptionKey(). The method throws an error if assetId isn't a valid asset ID.

Decrypts sessionKey using the session's cryptographic context and then registers the decrypted result as the encryption key for contentId, exactly as RegisterEncryptedAsset() does. Use this variant when the per-asset key is delivered to the client in session-encrypted form rather than as plaintext.

Removes the default encryption key registered through RegisterDefaultEncryptionKey(), so that assets without a specifically registered key are no longer decrypted with a fallback key. Keys registered for individual assets through RegisterEncryptedAsset() are unaffected.

Removes the encryption key associated with assetId by RegisterEncryptedAsset(), so the asset is no longer decrypted with that key. If no key is registered for the asset, the call has no effect.

Fires when an asset requested through the ContentProvider fails to be fetched, passing the content ID of the asset that failed.