Version: 2018.2 (switch to 2018.3b or 2017.4)
LanguageEnglish
  • C#

SceneManager.LoadSceneAsync

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

public static AsyncOperation LoadSceneAsync(string sceneName, SceneManagement.LoadSceneMode mode = LoadSceneMode.Single);
public static AsyncOperation LoadSceneAsync(int sceneBuildIndex, SceneManagement.LoadSceneMode mode = LoadSceneMode.Single);

Parameters

sceneNameName or path of the Scene to load.
sceneBuildIndexIndex of the Scene in the Build Settings to load.
modeIf LoadSceneMode.Single then all current Scenes will be unloaded before loading.

Returns

AsyncOperation Use the AsyncOperation to determine if the operation has completed.

Description

Loads the Scene asynchronously in the background.

The given Scene name can either be the full Scene path, the path shown in the Build Settings window or just the Scene name. If only the Scene name is given this will load the first Scene in the list that matches. If you have multiple Scenes with same name but different paths, you should use the full Scene path in the Build Settings.

Examples of supported formats:
"Scene1"
"Scene2"
"Scenes/Scene3"
"Scenes/Others/Scene3"
"Assets/scenes/others/scene3.unity"

Note: The name of the Scene to load can be case insensitive.

using System.Collections;
using UnityEngine;
using UnityEngine.SceneManagement;

public class Example : MonoBehaviour { void Update() { // Press the space key to start coroutine if (Input.GetKeyDown(KeyCode.Space)) { // Use a coroutine to load the Scene in the background StartCoroutine(LoadYourAsyncScene()); } }

IEnumerator LoadYourAsyncScene() { // The Application loads the Scene in the background as the current Scene runs. // This is particularly good for creating loading screens. // You could also load the Scene by using sceneBuildIndex. In this case Scene2 has // a sceneBuildIndex of 1 as shown in Build Settings.

AsyncOperation asyncLoad = SceneManager.LoadSceneAsync("Scene2");

// Wait until the asynchronous scene fully loads while (!asyncLoad.isDone) { yield return null; } } }

Did you find this page useful? Please give it a rating: