class in UnityEditor.Callbacks
/
Inherits from:CallbackOrderAttribute
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.
CloseFor 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.
CloseInvokes a static callback method when the Unity Editor attempts to open an asset.
Unity calls any static method decorated with [OnOpenAssetAttribute]
when attempting to open an asset, such as when double-clicking the asset in the Editor. This offers the opportunity to implement custom asset opening logic or to verify that an asset can open in the Unity Editor as opposed to an external program.
The attribute targets methods and accepts two optional positional parameters:
callbackOrder
: The first parameter represents the index of the callback invocation order and must be of type int
. This is useful if you have more than one OnOpenAssetAttribute callbacks, and you would like them to be called in a certain order. Methods are called in ascending numerical order, starting from 0.attributeMode
: The second parameter is an enum
value from OnOpenAssetAttributeMode that indicates whether the decorated method is called in Execute
or Validate
mode. Execute
mode is intended for callbacks that implement some custom asset-opening behavior. Validate
mode is intended to check if the Editor can open the asset. If not specified the default mode is OnOpenAssetAttributeMode.Execute.A method decorated with [OnOpenAssetAttribute]
and in Execute
mode must have one of the following signatures:
static bool OnOpenAsset(int instanceID)
static bool OnOpenAsset(int instanceID, int line)
static bool OnOpenAsset(int instanceID, int line, int column)
Note: The callback method does not have to be named OnOpenAsset
but its signature must match one of those shown.
A method decorated with [OnOpenAssetAttribute]
and in Validate
mode must have the following signature:static bool OnOpenAsset(int instanceID)
In OnOpenAssetAttributeMode.Validate mode, the method does not open the asset but checks to see if the Editor can open it. It returns true
if the Editor can open the asset or false
otherwise. This is equivalent to the check AssetDatabase.CanOpenAssetInEditor performs.
Version control system integrations primarily use this validation function to determine what files to check out. Native assets like GameObjects, Scenes, or user-made assets return true
because they are opened and edited in the Editor. Assets like sound clips and textures return false
because they're opened and edited in an external program.
See Also: OnOpenAssetAttributeMode, AssetDatabase.CanOpenAssetInEditor
// Return true if you handled the opening of the asset or false if an external tool should open it.
using UnityEngine; using UnityEditor; using UnityEditor.Callbacks;
public class MyAssetHandler : ScriptableObject { [OnOpenAssetAttribute(1)] public static bool step1(int instanceID, int line) { string name = EditorUtility.InstanceIDToObject(instanceID).name; Debug.Log("Open Asset step: 1 (" + name + ")"); return false; // we did not handle the open }
// step2 has an attribute with index 2, so will be called after step1 [OnOpenAssetAttribute(2)] public static bool step2(int instanceID, int line) { Debug.Log("Open Asset step: 2 (" + instanceID + ")"); return false; // we did not handle the open }
[OnOpenAsset(OnOpenAssetAttributeMode.Validate)] public static bool WillOpenInUnity(int instanceID) { if (AssetDatabase.GetMainAssetTypeAtPath(AssetDatabase.GetAssetPath(instanceID)) == typeof(MyAssetHandler)) { // We can open MyAssetHandler asset using MyAssetHandler opening method return true; } else return false; // The passed instance doesn't belong to MyAssetHandler type asset so we won't be able to open it using opening method inside MyAssetHandler } }
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.