LoadContentFileAsync(ContentNamespace, string, NativeArray<ContentFile>, JobHandle)
Loads a serialized file asynchronously from disk.
Read time 2 minutesLast updated 6 days ago
Definition
- Type: Method
- Namespace: Unity.Loading
- Assembly: UnityEngine.ContentLoadModule
public static ContentFile LoadContentFileAsync(ContentNamespace nameSpace, string filename, NativeArray<ContentFile> dependencies, JobHandle dependentFence = default)
Parameters
The ContentNamespace used to filter the results.
Path of the file on disk.
List of the ContentFiles that will be referenced by the file being loaded. The ordering must match the ordering returned from the build process. ContentFile.GlobalTableDependency can be used to indicate that the PersistentManager should be used to resolve references. This allows references to files such as "unity default resources".
Returns
Type | Description |
|---|---|
| ContentFile | Handle to access the results of the load process. |
Remarks
This is a low-level API. To load content built with BuildPipeline.BuildContentDirectory, use the ContentLoadManager and Loadable<T> API instead of this method.
The status of the load operation can be accessed using the returned ContentFile. Objects loaded with this method are not garbage collected. To free resources when they are no longer required, call ContentFile.UnloadAsync. You must always call ContentFile.UnloadAsync even if the load fails.
Examples
using System.Collections;using Unity.Collections;using Unity.Content;using Unity.Loading;using UnityEngine;namespace BuildDocExamples{ public class ContentLoadInterface_LoadContentFileAsyncExample : MonoBehaviour { public IEnumerator Start() { NativeArray<ContentFile> empty = new NativeArray<ContentFile>(); ContentFile depFileHandle = ContentLoadInterface.LoadContentFileAsync(ContentNamespace.Default, "path/to/depfile", empty); NativeArray<ContentFile> depFiles = new NativeArray<ContentFile>(1, Allocator.Temp); depFiles[0] = depFileHandle; ContentFile rootFileHandle = ContentLoadInterface.LoadContentFileAsync(ContentNamespace.Default, "path/to/rootfile", depFiles); depFiles.Dispose(); // yield coroutine until loading is complete while (rootFileHandle.LoadingStatus == LoadingStatus.InProgress) yield return null; ulong localFileIdentifierOfObjectIWant = 25; GameObject obj = (GameObject)rootFileHandle.GetObject(localFileIdentifierOfObjectIWant); // When done using obj. unload both files. ContentFileUnloadHandle unloadHandleRoot = rootFileHandle.UnloadAsync(); ContentFileUnloadHandle unloadHandleDep = depFileHandle.UnloadAsync(); // yield coroutine until loading is complete while (!unloadHandleRoot.IsCompleted || !unloadHandleRoot.IsCompleted) yield return null; // file is now completly unloaded. obj has been deleted } }}