DownloadHandlerAssetBundle
A DownloadHandler subclass specialized for downloading AssetBundle s.
Read time 3 minutesLast updated 6 days ago
Definition
- Type: Class
- Namespace: UnityEngine.Networking
- Assembly: UnityEngine.UnityWebRequestAssetBundleModule
- Inherits from: DownloadHandler
- Implements: IDisposable
public sealed class DownloadHandlerAssetBundle : DownloadHandler, IDisposable
Remarks
This subclass streams downloaded data into Unity's AssetBundle decompression and decoding system on worker threads, providing efficient downloading and processing for AssetBundle objects.
The advantage to this download handler is that it can stream data to Unity's AssetBundle system. After all the data has been received, the AssetBundle is available as an AssetBundle object. Only one copy of the AssetBundle object is created. This reduces runtime memory allocation and the memory impact of loading the AssetBundle. It also allows AssetBundles to be partially used while not fully downloaded, so you can stream assets.
All downloading and decompression occurs on worker threads, except on the Web platform.
Downloaded AssetBundle data is processed by a object, which has a special property to retrieve the AssetBundle object.
DownloadHandlerAssetBundleassetBundleDue to the way the AssetBundle system works, all AssetBundles must have an address associated with them. Generally, this is the nominal URL at which they're located (meaning the URL before any redirects). In almost all cases, you should pass in the same URL as you passed to the UnityWebRequest. When using the High Level API (HLAPI), this is done for you.
Additional Resources: UnityWebRequestAssetBundle
Examples
using UnityEngine;using UnityEngine.Networking;using System.Collections;public class MyBehaviour : MonoBehaviour { void Start() { StartCoroutine(GetAssetBundle()); } IEnumerator GetAssetBundle() { UnityWebRequest www = new UnityWebRequest("https://www.my-server.com"); DownloadHandlerAssetBundle handler = new DownloadHandlerAssetBundle(www.url, 0); www.downloadHandler = handler; yield return www.SendWebRequest(); if (www.result != UnityWebRequest.Result.Success) { Debug.Log(www.error); } else { // Extracts AssetBundle AssetBundle bundle = handler.assetBundle; } }}
Constructors
Constructor | Description |
|---|---|
| DownloadHandlerAssetBundle(System.String,System.String,UnityEngine.Hash128,System.UInt32) | Versioned constructor. Caches downloaded asset bundles to a customized cache path. |
| DownloadHandlerAssetBundle(System.String,System.UInt32) | Standard constructor for non-cached asset bundles. |
| DownloadHandlerAssetBundle(System.String,System.UInt32,System.UInt32) | Simple versioned constructor. Caches downloaded asset bundles. |
| DownloadHandlerAssetBundle(System.String,UnityEngine.CachedAssetBundle,System.UInt32) | Versioned constructor. Caches downloaded asset bundles to a customized cache path. |
| DownloadHandlerAssetBundle(System.String,UnityEngine.Hash128,System.UInt32) | Versioned constructor. Caches downloaded asset bundles. |
Properties
Property | Description |
|---|---|
| assetBundle | Returns the downloaded AssetBundle, or |
| autoLoadAssetBundle | If true, the AssetBundle will be loaded as part of the UnityWebRequest process. If false, the AssetBundle will be loaded on demand when accessing the DownloadHandlerAssetBundle.assetBundle property. |
| isDownloadComplete | Returns true if the data downloading portion of the operation is complete. |
Methods
Method | Description |
|---|---|
| GetData | Not implemented. Throws NotSupportedException. |
| GetText | Not implemented. Throws NotSupportedException. |
Static Methods
Method | Description |
|---|---|
| GetContent | Returns the downloaded AssetBundle, or |