ScriptedImporter
Abstract base class for custom Asset importers.
Read time 6 minutesLast updated 8 days ago
Definition
- Type: Class
- Namespace: UnityEditor.AssetImporters
- Assembly: UnityEditor
- Inherits from: AssetImporter
public abstract class ScriptedImporter : AssetImporter
Remarks
Scripted importers are scripts that are associated with specific file extensions. They are invoked by Unity's Asset pipeline to convert the contents of associated files into Assets.
Use the ScriptedImporterAttribute class to register custom importers with the Asset pipeline.
The C# fields of a ScriptedImporter are serialized, exactly like fields on a MonoBehaviour. See Script Serialization for details. You can see these properties in the Inspector and use them to control the behaviour of the importer for each asset. To programmatically access the value of an asset's properties, use AssetImporter.GetAtPath and type cast the return value to the correct class derived from ScriptedImporter. After changing values, trigger a fresh import by calling EditorUtility.SetDirty and then AssetImporter.SaveAndReimport().
Examples
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); ctx.SetMainObject(cube); var material = new Material(Shader.Find("Standard")); material.color = Color.red; // 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(); DestroyImmediate(tempMesh); }}
Methods
Method | Description |
|---|---|
| GatherDependenciesFromSourceFile | A static callback that you can implement to set up artifact dependencies to other Assets, and optimize the order your assets are imported. |
| OnImportAsset | This method must be overriden by the derived class and is called by the Asset pipeline to import files. |
| OnValidate | This function is called when the importer is loaded or a value is changed in the Inspector. |
| Reset | Reset to default values. |
| SupportsRemappedAssetType | Override this method if your ScriptedImporter supports remapping specific asset types. |
Inheritance
Operators
Operator | Description |
|---|---|
| operator == | Compares two object references to see if they refer to the same object. |
| bool | Determines whether the object exists. |
| operator != | Compares if two objects refer to a different object. |