You can use batching to reduce the amount of time and processing taken when making changes to Assets in your code.
If you make changes to multiple Asset in your code (for example, copying or moving Asset files), the Asset Database’s default behavior is to process each change in turn, and perform a full Refresh process for the Asset before moving on to the next line of code.
In the example below, three Assets are changed. Asset1 is copied, Asset2 is moved, and Asset3 is deleted:
AssetDatabase.CopyAsset("Assets/Asset1.txt", "Assets/Text/Asset1.txt"); AssetDatabase.MoveAsset("Assets/Asset2.txt", "Assets/Text/Asset2.txt"); AssetDatabase.DeleteAsset("Assets/Asset3.txt");
Without batching, Unity processes each change before moving on to the next line of code. This not only takes an unnecessarily long amount of time, but also triggers many callbacks that you can avoid if you use batching.
Instead, you can specify that the Asset Database should process a group of operations at once. To do this, you need to tell the Asset Database to pause its normal behavior before you make your changes, then tell it to resume after your changes are complete.
In particular, you should try to use batching if you are doing more than one of any of the following operations:
To specify that the Asset Database should process a group of operations at once, you can use the following methods: AssetDatabase.StartAssetEditing and AssetDatabase.StopAssetEditing.
AssetDatabase.StartAssetEditing
This method tells the Asset Database that you are starting to make edits to Assets. The Asset Database enters a paused state, and does not process any further changes to your Assets until you call the corresponding StopAssetEditing method to tell it you are finished.
AssetDatabase.StopAssetEditing
Once you perform all of your Asset changes, call this method to tell the Asset Database to process your changes and resume its normal behavior of automatically processing changes immediately. The Asset Database then processes the changes you made between StartAssetEditing
and StopAssetEditing
in a Batch, which is faster than if they had been processed one by one.
If you make more than one call to StartAssetEditing
, you must make the corresponding number of calls to StopAssetEditing
to make the Asset Database resume its normal behavior of automatically processing changes.
This is because these functions increment and decrement a counter, rather than acting as a simple on/off switch. Calling StartAssetEditing
increments the counter, and calling StopAssetEditing
decrements the counter. The Asset Database resumes its normal behavior when the counter reaches zero.
The reason Unity uses a counter rather than a simple on/off boolean is so that if your code executes multiple nested “start” and “stop” pairs, the inner pairs do not accidentally re-enable the Asset Database’s normal behavior too early. Instead, each pair increments and decrements the counter by one, and if your code is correctly nested, the final outer call to StopAssetEditing
sets the counter to zero.
Note: Your code should never cause the counter to go below zero. Doing so generates an error.
The following example shows the recommended way to use these methods:
using UnityEditor; public class StartStopAssetEditingExample : MonoBehaviour { [MenuItem("APIExamples/StartStopAssetEditing")] static void CallAssetDatabaseAPIsBetweenStartStopAssetEditing() { try { //Place the Asset Database in a state where //importing is suspended for most APIs AssetDatabase.StartAssetEditing(); AssetDatabase.CopyAsset("Assets/Asset1.txt", "Assets/Text/Asset1.txt"); AssetDatabase.MoveAsset("Assets/Asset2.txt", "Assets/Text/Asset2.txt"); AssetDatabase.DeleteAsset("Assets/Asset3.txt"); } finally { //Adding a call to StopAssetEditing inside //a "finally" block ensures that the AssetDatabase //state will be reset when leaving this function AssetDatabase.StopAssetEditing(); } } }
When you call AssetDatabase.StartAssetEditing
, Unity puts the entire Editor’s AssetDatabase in a paused state. As such, if you do not make a corresponding call to AssetDatabase.StopAssetEditing
, the Editor appears to be unresponsive when it comes to any Asset-related operations (Importing, Refreshing, etc.), and requires an Editor restart to restore its normal operation.
Without using a try
… finally
block, if any of your code which modifies Assets causes an error, it might prevent the StopAssetEditing
from being called. To avoid this situation, wrap the calls inside a try
…finally
block, with the StartAssetEditing
, and your Asset modification code in the try
block, and the StopAssetEditing
call placed in the finally
block. This ensures that if any exceptions happen while your changes are made in the try
block, it’s still guaranteed that AssetDatabase.StopAssetEditing
will be called.
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.