Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


LoadLevelAsync

Loads the level asynchronously in the background.
Read time 2 minutesLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule

LoadLevelAsync(int)

Loads the level asynchronously in the background.
Warning
Deprecated. Use SceneManager.LoadSceneAsync
public static AsyncOperation LoadLevelAsync(int index)

Parameters

index

Returns

Type

Description

AsyncOperation

Remarks

Unity will completely load all assets and all objects in the Scene in a background loading thread. This allows you to load new levels while still playing the current one, show a progress bar or create a completely streaming world where you constantly load and unload different parts of the world based on the player position, without any hiccups in game play.
AsyncOperation.isDone variable from the resulting AsyncOperation can be used to query if the level load has completed. The result of a LoadLevelAsync can also be used to yield in a coroutine.
When building a player Unity automatically optimizes assets in such a way that LoadLevelAsync will load them from disk linearly to avoid seek times. Note that background loading performance in the Unity Editor is much lower than in the standalone build. In the Editor you might also get more loading hiccups than in the player.
Refer to Order of execution for event functions for more information regarding the calling sequence once a level is loaded. Additional Resources: AsyncOperation, Application.backgroundLoadingPriority, Application.LoadLevel, Application.LoadLevelAdditive, Application.LoadLevelAdditiveAsync.

LoadLevelAsync(string)

Loads the level asynchronously in the background.
Warning
Deprecated. Use SceneManager.LoadSceneAsync
public static AsyncOperation LoadLevelAsync(string levelName)

Parameters

levelName

Returns

Type

Description

AsyncOperation

Remarks

Unity will completely load all assets and all objects in the Scene in a background loading thread. This allows you to load new levels while still playing the current one, show a progress bar or create a completely streaming world where you constantly load and unload different parts of the world based on the player position, without any hiccups in game play.
AsyncOperation.isDone variable from the resulting AsyncOperation can be used to query if the level load has completed. The result of a LoadLevelAsync can also be used to yield in a coroutine.
When building a player Unity automatically optimizes assets in such a way that LoadLevelAsync will load them from disk linearly to avoid seek times. Note that background loading performance in the Unity Editor is much lower than in the standalone build. In the Editor you might also get more loading hiccups than in the player.
Refer to Order of execution for event functions for more information regarding the calling sequence once a level is loaded. Additional Resources: AsyncOperation, Application.backgroundLoadingPriority, Application.LoadLevel, Application.LoadLevelAdditive, Application.LoadLevelAdditiveAsync.