Legacy Documentation: Version 2018.1 (Go to current version)
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.OnImportAsset

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

public method OnImportAsset(ctx: Experimental.AssetImporters.AssetImportContext): void;
public void OnImportAsset(Experimental.AssetImporters.AssetImportContext ctx);

Parameters

ctxThis argument contains all the contextual information needed to process the import event and is also used by the custom importer to store the resulting Unity Asset.

Description

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

#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.AddObjectToAsset("main obj", cube);
		ctx.SetMainObject(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.AddObjectToAsset("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.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); } }

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