Method LoadSceneAsync

LoadSceneAsync(LoadSceneMode, bool, int)

Loads the reference as a scene.

Declaration

public virtual AsyncOperationHandle<SceneInstance> LoadSceneAsync(LoadSceneMode loadMode = LoadSceneMode.Single, bool activateOnLoad = true, int priority = 100)

Parameters

Type	Name	Description
LoadSceneMode	loadMode	Scene load mode.
bool	activateOnLoad	If false, the scene will load but not activate (for background loading). The SceneInstance returned has an Activate() method that can be called to do this at a later point.
int	priority	Async operation priority for scene loading.

Returns

Type	Description
AsyncOperationHandle<SceneInstance>	The operation handle for the request if there is not a valid cached operation, otherwise return default operation

Remarks

This cannot be used a second time until the first load is unloaded. If you wish to call load multiple times on an AssetReference, use Addressables.LoadSceneAsync() and pass your AssetReference in as the key. See the Loading Addressable Assets documentation for more details.