Version: 2023.1
LanguageEnglish
  • C#

AssetBundle.LoadFromFileAsync

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

Submission failed

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

Close

Cancel

Declaration

public static AssetBundleCreateRequest LoadFromFileAsync(string path);

Declaration

public static AssetBundleCreateRequest LoadFromFileAsync(string path, uint crc);

Declaration

public static AssetBundleCreateRequest LoadFromFileAsync(string path, uint crc, ulong offset);

Parameters

path Path of the file on disk.
crc An optional CRC-32 checksum of the uncompressed content. If this is non-zero, then the content will be compared against the checksum before loading it, and give an error if it does not match.
offset An optional byte offset. This value specifies where to start reading the AssetBundle from.

Returns

AssetBundleCreateRequest Asynchronous load request for an AssetBundle. Use assetBundle property to get an AssetBundle once it is loaded.

Description

Asynchronously loads an AssetBundle from a file on disk.

The function supports bundles of any compression type. In case of LZMA compression, the data will be decompressed to the memory. See AssetBundles compression for more details.

This is the fastest way to load an AssetBundle.

using UnityEngine;
using System.Collections;
using System.IO;

public class LoadFromFileAsyncExample : MonoBehaviour { IEnumerator Start() { var bundleLoadRequest = AssetBundle.LoadFromFileAsync(Path.Combine(Application.streamingAssetsPath, "myassetBundle")); yield return bundleLoadRequest;

var myLoadedAssetBundle = bundleLoadRequest.assetBundle; if (myLoadedAssetBundle == null) { Debug.Log("Failed to load AssetBundle!"); yield break; }

var assetLoadRequest = myLoadedAssetBundle.LoadAssetAsync<GameObject>("MyObject"); yield return assetLoadRequest;

GameObject prefab = assetLoadRequest.asset as GameObject; Instantiate(prefab);

myLoadedAssetBundle.Unload(false); } }