Version: 2022.3
LanguageEnglish
  • C#

AssetPostprocessor

class in UnityEditor

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

AssetPostprocessor lets you hook into the import pipeline and run scripts prior or after importing assets.

During model import the functions are called in the the following order:

  • OnPreprocessModel is called at the very beginning and you can override ModelImporter settings that are used for the whole model import process.
  • After Meshes and Materials are imported, the GameObjects hierarchy is created from the imported nodes. Use OnPostprocessMeshHierarchy to change the hierarchy. Every GameObject that represents an imported node is given a corresponding MeshFilter, MeshRenderer, and MeshCollider component. Before assigning a Material to the MeshRenderer, the OnAssignMaterialModel function is invoked.
  • After GameObject has initialized MeshRenderers and "userdata" exists OnPostprocessGameObjectWithUserProperties is called. That happens before children GameObjects are generated.
  • If animation generation was not disabled at previous stages (see ModelImporter.generateAnimations), then SkinnedMesh and Animations are generated. If possible Avatar is also created and GameObjecs hierarchy is optimized. After that OnPostprocessModel is called for the root GameObject.

OnPreprocessSpeedTree and OnPostprocessSpeedTree are called on SpeedTree assets (.spm file) the same way as OnPreprocessModel and OnPostprocessModel, except that the assetImporter type is SpeedTreeImporter.

Properties

assetImporterReference to the asset importer.
assetPathThe path name of the asset being imported.
contextThe import context.

Public Methods

GetPostprocessOrderOverride the order in which importers are processed.
GetVersionReturns the version of the asset postprocessor.

Messages

OnAssignMaterialModelFeeds a source material.
OnPostprocessAllAssetsThis is called after importing of any number of assets is complete (when the Assets progress bar has reached the end).
OnPostprocessAnimationThis function is called when an AnimationClip has finished importing.
OnPostprocessAssetbundleNameChangedHandler called when asset is assigned to a different asset bundle.
OnPostprocessAudioAdd this function to a subclass to get a notification when an audio clip has completed importing.
OnPostprocessCubemapAdd this function to a subclass to get a notification just before a cubemap texture has completed importing.
OnPostprocessGameObjectWithAnimatedUserPropertiesThis function is called when the animation curves for a custom property are finished importing.
OnPostprocessGameObjectWithUserPropertiesGets called for each GameObject that had at least one user property attached to it in the imported file.
OnPostprocessMaterialAdd this function to a subclass to get a notification when a new Material is created during an import of a ModelImporter.
OnPostprocessMeshHierarchyThis function is called when a new transform hierarchy has finished importing.
OnPostprocessModelAdd this function to a subclass to get a notification when a model has completed importing.
OnPostprocessPrefabGets a notification when a Prefab completes importing.
OnPostprocessSpeedTreeAdd this function to a subclass to get a notification when a SpeedTree asset has completed importing.
OnPostprocessSpritesAdd this function to a subclass to get a notification when an texture of sprite(s) has completed importing.
OnPostprocessTextureAdd this function to a subclass to get a notification when a texture2D has completed importing just before Unity compresses it.
OnPostprocessTexture2DArrayAdd this function to a subclass to get a notification when a texture2DArray has completed importing just before Unity compresses it.
OnPostprocessTexture3DAdd this function to a subclass to get a notification when a texture3D has completed importing just before Unity compresses it.
OnPreprocessAnimationAdd this function to a subclass to get a notification just before animation from a model (.fbx, .mb file etc.) is imported.
OnPreprocessAssetAdd this function to a subclass to get a notification just before any Asset is imported.
OnPreprocessAudioAdd this function to a subclass to get a notification just before an audio clip is being imported.
OnPreprocessCameraDescriptionAdd this function to a subclass to recieve a notification when a camera is imported from a Model Importer.
OnPreprocessLightDescriptionAdd this function to a subclass to recieve a notification when a light is imported from a Model Importer.
OnPreprocessMaterialDescriptionAdd this function to a subclass to recieve a notification when a new material is created during the import of a ModelImporter.
OnPreprocessModelAdd this function to a subclass to get a notification just before a model (.fbx, .mb file etc.) is imported.
OnPreprocessSpeedTreeAdd this function to a subclass to get a notification just before a SpeedTree asset (.spm file) is imported.
OnPreprocessTextureAdd this function to a subclass to get a notification just before the texture importer is run.