enumeration
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.
CloseAsset Bundle building options.
These flags allow you to configure options when calling BuildPipeline.BuildAssetBundles.
Use AssetBundleOptions to control the compression level of the AssetBundles.
By default, AssetBundles are built with full file compression using CompressionType.Lzma.
To compress the AssetBundle data into individual segments, use BuildAssetBundleOptions.ChunkBasedCompression.
To avoid compressing the data, use BuildAssetBundleOptions.UncompressedAssetBundle.
Additional resources: AssetBundle, BuildPipeline.BuildAssetBundles
//Create a folder (right click in the Assets folder and go to Create>Folder), and name it “Editor” if it doesn’t already exist //Place this script in the Editor folder
//This script creates a new Menu named “Build Asset” and new options within the menu named “Normal” and “Strict Mode”. Click these menu items to build an AssetBundle into a folder with either no extra build options, or a strict build.
using UnityEngine; using UnityEditor;
public class Example { //Creates a new menu (Build Asset Bundles) and item (Normal) in the Editor [MenuItem("Build Asset Bundles/Normal")] static void BuildABsNone() { //Build AssetBundles with no special options //They will be written in the custom folder ("MyAssetBuilds") which needs to exist prior to this call. BuildPipeline.BuildAssetBundles("Assets/MyAssetBuilds", BuildAssetBundleOptions.None, BuildTarget.StandaloneOSX); }
//Creates a new item (Strict Mode) in the new Build Asset Bundles menu [MenuItem("Build Asset Bundles/Strict Mode")] static void BuildABsStrict() { //Build the AssetBundles in strict mode (build fails if any errors are detected) BuildPipeline.BuildAssetBundles("Assets/MyAssetBuilds", BuildAssetBundleOptions.StrictMode, BuildTarget.StandaloneOSX); } }
None | Build assetBundle without any special option. |
UncompressedAssetBundle | Don't compress the data when creating the AssetBundle. |
DisableWriteTypeTree | Excludes type information from the AssetBundle. |
ForceRebuildAssetBundle | Initiates a complete rebuild of AssetBundles. |
IgnoreTypeTreeChanges | Ignore the type tree changes when doing the incremental build check. |
AppendHashToAssetBundleName | Appends the hash to the AssetBundle name. |
ChunkBasedCompression | Use chunk-based LZ4 compression when creating the AssetBundle. |
StrictMode | Fails the build if any errors are reported during it. |
DryRunBuild | Performs a simulated build of AssetBundles without actually creating the files. |
DisableLoadAssetByFileName | Disables calling LoadAsset on Asset Bundles using only the file name. |
DisableLoadAssetByFileNameWithExtension | Prevents loading assets from Asset Bundles using the file name with its extension. |
AssetBundleStripUnityVersion | Removes the Unity Version number in the Archive File and Serialized File headers during the build. |
UseContentHash | Use the content of the asset bundle to calculate the hash. This feature is always enabled. |
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.