Select your preferred scripting language. All code snippets will be displayed in this language.
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.
Closetarget | The object which is not destroyed on scene change. |
Makes the object target
not be destroyed automatically when loading a new scene.
When loading a new level all objects in the scene are destroyed, then the objects in the new level are loaded.
In order to preserve an object during level loading call DontDestroyOnLoad on it.
If the object is a component or game object then its entire transform hierarchy will not be destroyed either.
Note: DontDestroyOnLoad does not return a value. It is also intended to have it's argument changed. The typeof operator makes this change if it is needed.
Calling DontDestroyOnLoad can make the object exist on all scenes. In the example below there are two scenes - ExampleScript1
and ExampleScript2
.. One has a Cube and the other a Sphere. A DontDestroyOnLoad function on the first scene is connected to a Cylinder. This is loaded in Awake
. When the ExampleScript1 button is pressed ExampleScript1 is closed and ExampleScript2 is loaded. The Cylinder from ExampleScript1 is copied to ExampleScript2. When ExampleScript2 is closed by pressing the Button ExampleScript1 is reloaded. This scene always has the Cylinder. The management of the Cylinder is the DontDestroyOnLoad function.
ExampleScript1:
no example available in JavaScript
// Connected to the Cube and includes a DontDestroyOnLoad() // LoadScene() is called by the first script and switches to the second.
using UnityEngine; using UnityEngine.SceneManagement;
public class ExampleScript1 : MonoBehaviour { private static bool created = false;
void Awake() { if (!created) { DontDestroyOnLoad(this.gameObject); created = true; Debug.Log("Awake: " + this.gameObject); } }
public void LoadScene() { if (SceneManager.GetActiveScene().name == "scene1") { SceneManager.LoadScene("scene2", LoadSceneMode.Single); } } }
ExampleScript2:
no example available in JavaScript
// Connected to the Cube and includes a DontDestroyOnLoad() // LoadScene() is called by the second script and loads the first.
using UnityEngine; using UnityEngine.SceneManagement;
public class ExampleScript2 : MonoBehaviour { public void LoadScene() { if (SceneManager.GetActiveScene().name == "scene2") { SceneManager.LoadScene("scene1", LoadSceneMode.Single); } } }
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:
Thanks for helping to make the Unity documentation better!