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

BuildAssetBundleOptions

enumeration

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

Asset Bundle building options.

This allows you to choose options for building Asset Bundles. To build Asset Bundle(s) with extra instructions, use this as a parameter of BuildPipeline.BuildAssetBundle or BuildPipeline.BuildAssetBundles.

See Also: AssetBundle, BuildPipeline.BuildAssetBundle, 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 : MonoBehaviour { //Creates a new menu (Build Asset Bundles) and item (Normal) in the Editor [MenuItem("Build Asset Bundles/Normal")] static void BuildABsNone() { //Create a folder to put the Asset Bundle in. // This puts the bundles in your custom folder (this case it's "MyAssetBuilds") within the Assets folder. //Build AssetBundles with no special options 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); } }

Properties

NoneBuild assetBundle without any special option.
UncompressedAssetBundleDon't compress the data when creating the asset bundle.
DisableWriteTypeTreeDo not include type information within the AssetBundle.
DeterministicAssetBundleBuilds an asset bundle using a hash for the id of the object stored in the asset bundle.
ForceRebuildAssetBundleForce rebuild the assetBundles.
IgnoreTypeTreeChangesIgnore the type tree changes when doing the incremental build check.
AppendHashToAssetBundleNameAppend the hash to the assetBundle name.
ChunkBasedCompressionUse chunk-based LZ4 compression when creating the AssetBundle.
StrictModeDo not allow the build to succeed if any errors are reporting during it.
DryRunBuildDo a dry run build.
DisableLoadAssetByFileNameDisables Asset Bundle LoadAsset by file name.
DisableLoadAssetByFileNameWithExtensionDisables Asset Bundle LoadAsset by file name with extension.

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