Version: 2018.2 (switch to 2018.1 or 2017.4)
LanguageEnglish
  • C#

AssetBundle.LoadFromFile

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

public static AssetBundle LoadFromFile(string path, uint crc, ulong offset);

Parameters

pathPath of the file on disk.
crcAn 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.
offsetAn optional byte offset. This value specifies where to start reading the AssetBundle from.

Returns

AssetBundle Loaded AssetBundle object or null if failed.

Description

Synchronously 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. Uncompressed and chunk-compressed bundles can be read directly from disk.

Compared to LoadFromFileAsync, this version is synchronous and will not return until it is done creating the AssetBundle object.

This is the fastest way to load an AssetBundle.

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

public class LoadFromFileExample : MonoBehaviour { void Start() { var myLoadedAssetBundle = AssetBundle.LoadFromFile(Path.Combine(Application.streamingAssetsPath, "myassetBundle")); if (myLoadedAssetBundle == null) { Debug.Log("Failed to load AssetBundle!"); return; }

var prefab = myLoadedAssetBundle.LoadAsset<GameObject>("MyObject"); Instantiate(prefab);

myLoadedAssetBundle.Unload(false); } }

Parameters

pathPath of the file on disk.
crcAn 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.
offsetAn optional byte offset. This value specifies where to start reading the AssetBundle from.

Returns

void Loaded AssetBundle object or null if failed.

Description

Synchronously loads an AssetBundle from a file on disk.

The function supports bundles of any compression type.

Did you find this page useful? Please give it a rating: