Version: 2022.3
LanguageEnglish
  • C#

BuildAssetBundleOptions.DisableLoadAssetByFileName

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

Disables Asset Bundle LoadAsset by file name.

Asset Bundles by default have three ways to look up the same asset: full asset path, asset file name, and asset file name with extension. The full path is serialized into Asset Bundles, while file name and file name with extension are generated when an Asset Bundle is loaded from file.

Example: "Assets/Prefabs/Player.prefab", "Player", and "Player.prefab"

This option will set a flag on Asset Bundles to prevent creating the asset file name lookup. This option saves runtime memory and loading performance for asset bundles.

Additional resources: BuildAssetBundleOptions.DisableLoadAssetByFileNameLoadingWithExtension.

//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 “Disable Load Asset By filename”. Click these menu items to build an AssetBundle into a folder.

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 (Disable Load Asset By Name) in the new Build Asset Bundles menu [MenuItem("Build Asset Bundles/Disable Load Asset By Name")] static void BuildABsDisable() { //Build the AssetBundles in this mode BuildPipeline.BuildAssetBundles("Assets/MyAssetBuilds", BuildAssetBundleOptions.DisableLoadAssetByFileName, BuildTarget.StandaloneOSX); } }