Version: 2017.2 (switch to 2017.3b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

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 method LoadSceneAsync(sceneName: string, mode: SceneManagement.LoadSceneMode = LoadSceneMode.Single): AsyncOperation;
public static AsyncOperation LoadSceneAsync(string sceneName, SceneManagement.LoadSceneMode mode = LoadSceneMode.Single);
public static method LoadSceneAsync(sceneBuildIndex: int, mode: SceneManagement.LoadSceneMode = LoadSceneMode.Single): AsyncOperation;
public static AsyncOperation LoadSceneAsync(int sceneBuildIndex, SceneManagement.LoadSceneMode mode = LoadSceneMode.Single);

Parameters

sceneName Name or path of the scene to load.
sceneBuildIndex Index of the scene in the Build Settings to load.
mode If 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. Examples of supported formats: "Assets/Scenes/Scene1.unity" "Scenes/Scene1" "Scene1"

Note that this is case insensitive.

no example available in JavaScript
using System.Collections;
using UnityEngine;
using UnityEngine.SceneManagement;

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

IEnumerator LoadYourAsyncScene() { // The Application loads the Scene in the background at the same time as the current Scene. //This is particularly good for creating loading screens. You could also load the scene by build //number. AsyncOperation asyncLoad = SceneManager.LoadSceneAsync("Scene2");

//Wait until the last operation fully loads to return anything while (!asyncLoad.isDone) { yield return null; } } }

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