Version: 2023.2
LanguageEnglish
  • C#

ArchiveFileInterface

class in Unity.IO.Archive

/

Implemented in:UnityEngine.CoreModule

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

Description

Provides methods for managing Unity archive files.

This class offers a low level interface for managing Unity Archive Files.

Once an Archive is mounted its contents can be accessed with AsyncReadManager or ContentLoadInterface.LoadContentFileAsync.

AssetBundles are an example of an Archive file and can be loaded with this API. However, typically AssetBundles are loading using the AssetBundle class, or via the Addressables package.

Another example of an Archive file is the data.unity3d file generated when BuildPipeline.BuildPlayer is called with BuildOptions.CompressWithLz4 or BuildOptions.CompressWithLz4HC. In that case this API is not normally needed, because the contents of the Archive are automatically available in the player.

Additional resources: ContentBuildInterface.ArchiveAndCompress.

Static Methods

GetMountedArchivesRetrieves all mounted archives.
MountAsyncLoads all files in an archive to a mount point.