Legacy Documentation: Version 5.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

UnityWebRequest.GetAssetBundle

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function GetAssetBundle(uri: string, crc: uint): Networking.UnityWebRequest;
public static Networking.UnityWebRequest GetAssetBundle(string uri, uint crc);
public static function GetAssetBundle(uri: string, version: uint, crc: uint): Networking.UnityWebRequest;
public static Networking.UnityWebRequest GetAssetBundle(string uri, uint version, uint crc);
public static function GetAssetBundle(uri: string, hash: Hash128, crc: uint): Networking.UnityWebRequest;
public static Networking.UnityWebRequest GetAssetBundle(string uri, Hash128 hash, uint crc);

Parameters

uri The URI of the asset bundle to download.
crc If nonzero, this number will be compared to the checksum of the downloaded asset bundle data. If the CRCs do not match, an error will be logged and the asset bundle will not be loaded. If set to zero, CRC checking will be skipped.
version An integer version number, which will be compared to the cached version of the asset bundle to download. Increment this number to force Unity to redownload a cached asset bundle.

Analogous to the version parameter for WWW.LoadFromCacheOrDownload.
hash A version hash. If this hash does not match the hash for the cached version of this asset bundle, the asset bundle will be redownloaded.

Returns

UnityWebRequest A UnityWebRequest configured to downloading a Unity Asset Bundle.

Description

Creates a UnityWebRequest optimized for downloading a Unity Asset Bundle via HTTP GET.

This method creates a UnityWebRequest, sets the method to GET and sets the target URL to the string uri argument. Sets no other flags or custom headers.

This method attaches a DownloadHandlerAssetBundle to the UnityWebRequest. This DownloadHandler has a special DownloadHandlerAssetBundle.assetBundle property, which can be used to extract the asset bundle once enough data has been downloaded and decoded to permit access to the resources inside the bundle.

In addition, the DownloadHandlerAssetBundle streams data into a ringbuffer and decompresses the data on a worker thread, saving many memory allocations compared to downloading the data all at once.

If supplied with an integer version or Hash128 hash argument, the DownloadHandlerAssetBundle will employ the Asset Bundle caching system. If an Asset Bundle has been cached and does not need to be redownloaded, then the UnityWebRequest will complete once the Asset Bundle has finished loading from the cache.