class in Unity.IO.Archive
/
Implemented in:UnityEngine.CoreModule
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.
CloseFor 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.
CloseProvides methods for managing Unity archive files.
This class offers a low level interface for managing Unity archive files.
Archive files are mounted into a ContentNamespace. Once an archive is mounted its contents can be accessed with AsyncReadManager or ContentLoadInterface.LoadContentFileAsync.
AssetBundles use the archive format and can be loaded with this API, but in most cases it's preferable to load AssetBundles using the AssetBundle class, or via the Addressables package.
The data.unity3d file generated when BuildPipeline.BuildPlayer is called with BuildOptions.CompressWithLz4 or BuildOptions.CompressWithLz4HC is also an archive file. In that case the ArchiveFileInterface API is not normally needed, because the contents of the archive are automatically available in the Player.
Additional resources: ContentBuildInterface.ArchiveAndCompress.
// The following example describes how to create an archive with // ContentBuildInterface.ArchiveAndCompress and mount the archive with // ArchiveFileInterface.MountAsync. This example produces an archive that uses LZ4 // compression and contains one text file.
using Unity.Collections.LowLevel.Unsafe; using Unity.Content; using Unity.IO.Archive; using Unity.IO.LowLevel.Unsafe; using UnityEngine; #if UNITY_EDITOR using UnityEditor.Build.Content; #endif
public class SampleBehaviour : MonoBehaviour { #if UNITY_EDITOR unsafe void CreateAndMountArchive() { // Create the Archive ResourceFile[] rFiles = new ResourceFile[1]; ResourceFile rf = new ResourceFile(); rf.fileName = "Assets/file1.txt"; // Path of the existing file, to copy into the Archive rf.fileAlias = "file1.txt"; // Path given to the file inside the Archive rFiles[0] = rf;
string archivePath = System.IO.Path.Combine(Application.streamingAssetsPath, "myArchive"); ContentBuildInterface.ArchiveAndCompress(rFiles, archivePath, UnityEngine.BuildCompression.LZ4);
// Mount the Archive var ns = ContentNamespace.GetOrCreateNamespace("MyNamespace123"); ArchiveHandle ahandle = ArchiveFileInterface.MountAsync(ns, archivePath, "a:"); ahandle.JobHandle.Complete();
string textFilePath = ahandle.GetMountPath() + "file1.txt"; // ns:/MyNamespace123/a:/file1.txt ReadCommand cmd; cmd.Size = 1024; cmd.Buffer = UnsafeUtility.Malloc(cmd.Size, 4, Unity.Collections.Allocator.Temp); cmd.Offset = 0; NativeArray<ReadCommand> cmds = new NativeArray<ReadCommand>(1, Allocator.Persistent); cmds[0] = cmd;
ReadHandle rHandle = AsyncReadManager.Read(textFilePath, (ReadCommand*)cmds.GetUnsafePtr(), 1); rHandle.JobHandle.Complete();
// ...At this point cmd.Buffer contains contents from file1.txt (up to 1024 bytes)...
rHandle.Dispose(); UnsafeUtility.Free(cmd.Buffer, Unity.Collections.Allocator.Temp); cmds.Dipose():
ahandle.Unmount().Complete(); } #endif }
| Method | Description |
|---|---|
| GetMountedArchives | Retrieves all mounted archives. |
| MountAsync | Loads all files in an archive to a mount point. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.