Places the Asset Database into a state that temporarily prevents automatic import, allowing you to group several asset imports together into one larger import.
This class allows you to pause the Asset Database's automatic import of new or modified assets. This is useful if you want to perform actions via script that make multiple changes to assets without the Asset Database importing each change in a separate import process.
Instead, you can pause imports, make multiple changes, then resume imports, which means Unity will only perform one input process for all the changes you made while the importing was paused.
This class is an alternative to the AssetDatabase.StartAssetEditing and AssetDatabase.StopAssetEditing methods, which serve the same purpose.
The AssetEditingScope
class is intended to be used within a using
statement, which automatically disposes of the class, as in the following example:
using UnityEngine; using UnityEditor;
public class AssetEditingScopeExample : MonoBehaviour { [MenuItem("APIExamples/AssetEditingScope")] static void CallAssetDatabaseAPIsBetweenAssetEditingScope() { // Place the Asset Database in a state where // importing is suspended for most APIs using (var editingScope = new AssetDatabase.AssetEditingScope()) { // Modify the assets however we like AssetDatabase.CopyAsset("Assets/CopyAsset.txt", "Assets/Text/CopyAsset.txt"); AssetDatabase.MoveAsset("Assets/MoveAsset.txt", "Assets/Text/MoveAsset.txt"); } // Assets will now be imported again, as editingScope has been disposed. } }
If you use it in a different context other than a using
statement, you must ensure that its Dispose()
method is called or the Asset Database will remain in a paused state.
See Also: AssetDatabase.StartAssetEditing, AssetDatabase.StopAssetEditing.
AssetDatabase.AssetEditingScope | Instantiates AssetEditingScope. Equivalent to calling AssetDatabase.StartAssetEditing(). |
Dispose | Disposes of AssetEditingScope. Equivalent to calling AssetDatabase.StopAssetEditing(). |
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.