AssetImporter

Description

Provides access to import settings and base functionality for all asset types.

Although this is the base class for all asset importers, the recommended best practice is that you derive from the ScriptedImporter class if you want to write a new, custom importer.

Each asset imported into the project is linked to a corresponding asset importer object. This object provides access to the settings applied during the asset import process. These settings are stored in the .meta file, are located adjacent to the source asset file. They encompass asset bundle information, custom user data, and any external objects upon which the asset relies.

To obtain the asset importer object associated with an asset, use the AssetImporter.GetAtPath method.

To apply and save any changes made to the settings, use the AssetImporter.SaveAndReimport method. This action reimports the asset with the updated configuration.

The following example iterates through all assets within the project, identifying those that lack an asset bundle name by examining their respective asset importer objects.

using System.Collections.Generic;
using System.IO;
using System.Linq;
using UnityEditor;
using UnityEngine;

public class AddUserData : MonoBehaviour
{
    [MenuItem("Examples/Log Unbundled Assets")]
    static void LogUnbundledAssets()
    {
        CreateAssets();
        List<string> unbundledAssets = FindUnbundledAssets();
        if (unbundledAssets.Count > 0)
        {
            Debug.Log("Unbundled assets:");
            foreach (string asset in unbundledAssets)
                Debug.Log("  " + asset);
        }
        else
        {
            Debug.Log("All assets are bundled.");
        }
    }

    static List<string> FindUnbundledAssets()
    {
        // Fetch all the assets under Assets/ExampleAssets, excluding the
        // folders.
        string[] assets = AssetDatabase.GetAllAssetPaths()
            .Where(path => path.StartsWith("Assets/ExampleAssets") &&
                !Directory.Exists(path))  // Exclude directories
            .ToArray();

        // Unbundled assets do not have an asset bundle name set in their
        // importer settings.
        List<string> unbundledAssets = new List<string>();
        foreach (string asset in assets)
        {
            AssetImporter importer = AssetImporter.GetAtPath(asset);
            if (importer.assetBundleName == "")
            {
                unbundledAssets.Add(asset);
            }
        }

        return unbundledAssets;
    }

    static void CreateAssets()
    {
        // Create a folder for the assets in this example.
        if (!AssetDatabase.IsValidFolder("Assets/ExampleAssets"))
        {
            AssetDatabase.CreateFolder("Assets", "ExampleAssets");
        }

        // Create a folder for prefab assets.
        if (!AssetDatabase.IsValidFolder("Assets/ExampleAssets/Prefabs"))
        {
            AssetDatabase.CreateFolder("Assets/ExampleAssets",
                                       "Prefabs");
        }

        // Create a sphere asset.
        GameObject sphere =
            GameObject.CreatePrimitive(PrimitiveType.Sphere);
        PrefabUtility.SaveAsPrefabAsset(
            sphere, "Assets/ExampleAssets/Prefabs/Sphere.prefab");

        // Create a text asset.
        TextAsset text = new TextAsset("Hello, World!");
        AssetDatabase.CreateAsset(text,
                                  "Assets/ExampleAssets/Text.asset");

        // Only the text assets has its asset bundle name set.
        AssetImporter importer =
            AssetImporter.GetAtPath("Assets/ExampleAssets/Text.asset");
        importer.assetBundleName = "myBundle";
        importer.SaveAndReimport();

        // Create a material asset.
        Material material = new Material(Shader.Find("Standard"));
        AssetDatabase.CreateAsset(material,
                                  "Assets/ExampleAssets/Material.mat");
    }
}

Properties

Public Methods

Static Methods

Inherited Members