Method LoadSceneAsync
LoadSceneAsync(LoadSceneMode, Boolean, Int32)
Loads the reference as a scene.
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.
Declaration
public virtual AsyncOperationHandle<SceneInstance> LoadSceneAsync(LoadSceneMode loadMode = null, bool activateOnLoad = true, int priority = 100)
Parameters
Type |
Name |
Description |
LoadSceneMode |
loadMode |
Scene load mode.
|
Boolean |
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.
|
Int32 |
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
|
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:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.