Version: 2020.3
Importer Consistency


Scripted Importers are part of the Unity Scripting API. You can use Scripted Importers to write custom Asset importers in C#, which allows you to add your own support for file formats that are not natively supported by Unity.

You can create a custom importer by specializing the abstract class ScriptedImporter and applying the ScriptedImporter attribute. This registers your custom importer to handle one or more file extensions. When a file matching the registered file extensions is detected by the Asset pipeline as being new or changed, Unity invokes the method OnImportAsset of your custom importer.

Note: Scripted Importers cannot handle a file extension that is already natively handled by Unity.

Below is a simple example as Scripted Importer: It imports asset files with the extension “cube” into a Unity Prefab with a cube primitive as the main Asset and a default material and color, and assigns its position from a value read from the Asset file:

using UnityEngine;
using UnityEditor.AssetImporters;
using System.IO;

[ScriptedImporter(1, "cube")]
public class CubeImporter : ScriptedImporter
    public float m_Scale = 1;

    public override void OnImportAsset(AssetImportContext ctx)
        var cube = GameObject.CreatePrimitive(PrimitiveType.Cube);
        var position = JsonUtility.FromJson<Vector3>(File.ReadAllText(ctx.assetPath));

        cube.transform.position = position;
        cube.transform.localScale = new Vector3(m_Scale, m_Scale, m_Scale);

        // 'cube' is a GameObject and will be automatically converted into a prefab
        // (Only the 'Main Asset' is eligible to become a Prefab.)
        ctx.AddObjectToAsset("main obj", cube);

        var material = new Material(Shader.Find("Standard"));
        material.color =;

        // Assets must be assigned a unique identifier string consistent across imports
        ctx.AddObjectToAsset("my Material", material);

        // Assets that are not passed into the context as import outputs must be destroyed
        var tempMesh = new Mesh();


  • CubeImporter クラスに ScriptedImporter 属性を置くことによって、インポーターは Unity のアセットパイプラインに登録されます。
  • CubeImporter クラスは抽象クラス ScriptedImporter のベースクラスを実装します。
  • OnImportAsset の ctx 引数には、インポートイベントの入力データと出力データの両方が含まれます。
  • 各インポートイベントは、SetMainAsset への呼び出しを 1 回だけ発生させる必要があります。
  • 各インポートイベントは、必要に応じて AddSubAsset を呼び出します。
  • Please refer to the Scripting API documentation for more details.

You may also implement a custom Import Settings Editor by specializing ScriptedImporterEditor class and decorating it with the class attribute CustomEditor to tell it what type of importer it is used for.

using UnityEditor;
using UnityEditor.AssetImporters;
using UnityEditor.SceneManagement;
using UnityEngine;

public class CubeImporterEditor: ScriptedImporterEditor
    public override void OnInspectorGUI()
        var colorShift = new GUIContent("Color Shift");
        var prop = serializedObject.FindProperty("m_ColorShift");
        EditorGUILayout.PropertyField(prop, colorShift);


ScriptedImporter クラスをプロジェクトに加えると、Unity にサポートされるその他のネイティブのファイル形式同様に使用できます。

  • サポートされているファイルをインポートするアセットディレクトリ階層にドロップします。
  • Unity エディターを再起動すると、最後の更新以降に変更したファイルすべてが再インポートされます。
  • アセットファイルをディスク上で編集して Unity エディターに戻ると、再インポートが開始されます。
  • Asset > Import New Asset… を使用して新しいアセットをインポートします。
  • 明示的にメニューから再インポートを起動します:__Asset__ > Reimport
  • Asset をクリックすると、Inspector ウィンドウ にその設定が表示されます。設定を変更するには、Inspector ウィンドウで編集し Apply をクリックします。

ScriptedImporter によってインポートされたアセット (An Alembic Girl) の Inspector ウィンドウ
ScriptedImporter によってインポートされたアセット (An Alembic Girl) の Inspector ウィンドウ

ScriptedImporter の実際の使用例

  • Alembic: Alembic インポータープラグインは ScriptedImporter を使用して更新されています。詳しい情報は Unity github: AlembicImporter を参照してください。

  • USD: USD インポータープラグインは ScriptedImporter を使用して更新されています。

Importer Consistency