Version: 2017.2 (switch to 2017.3b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Experimental: this API is experimental and might be changed or removed in the future.

ScriptedImporter

class in UnityEditor.Experimental.AssetImporters

/

Inherits from:AssetImporter

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

Abstract base class for custom Asset importers.

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.

#pragma strict
@ScriptedImporter(1, "cube")
public class CubeImporter extends ScriptedImporter {
	public var m_Scale: float = 1;
	public override function OnImportAsset(ctx: AssetImportContext) {
		var cube: var = GameObject.CreatePrimitive(PrimitiveType.Cube);
		var position: var = JsonUtility.FromJson.<Vector3>(File.ReadAllText(ctx.assetPath));
		cube.transform.position = position;
		cube.transform.localScale = new Vector3(m_Scale, m_Scale, m_Scale);
		// (Only the 'Main Asset' is elligible to become a Prefab.)
		ctx.SetMainAsset("main obj", cube);
		var material: var = new Material(Shader.Find("Standard"));
		material.color = Color.red;
		// Assets must be assigned a unique identifier string consistent across imports
		ctx.AddSubAsset("my Material", material);
		// Assets that are not passed into the context as import outputs must be destroyed
		var tempMesh: var = new Mesh();
		DestroyImmediate(tempMesh);
	}
}
using UnityEngine;
using UnityEditor.Experimental.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 a GameObject and will be automatically converted into a prefab // (Only the 'Main Asset' is elligible to become a Prefab.) ctx.SetMainAsset("main obj", cube);

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

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

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

Public Methods

OnImportAssetThis method must by overriden by the derived class and is called by the Asset pipeline to import files.

Inherited Members

Properties

assetBundleNameGet or set the AssetBundle name.
assetBundleVariantGet or set the AssetBundle variant.
assetPathThe path name of the asset for this importer. (Read Only)
userDataGet or set any user data.
hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Public Methods

AddRemapMap a sub-asset from an imported asset (such as an FBX file) to an external Asset of the same type.
GetExternalObjectMapGets a copy of the external object map used by the AssetImporter.
RemoveRemapRemoves an item from the map of external objects.
SaveAndReimportSave asset importer settings if asset importer is dirty.
SetAssetBundleNameAndVariantSet the AssetBundle name and variant.
GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the game object.

Static Methods

GetAtPathRetrieves the asset importer for the asset at path.
DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.

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