Version: 2023.1
LanguageEnglish
  • C#

ContentSceneFile

struct in Unity.Loading

/

Implemented in:UnityEngine.ContentLoadModule

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

Description

The handle returned from ContentLoadInterface.LoadSceneAsync. You can use this handle to access the status and results of the load operation.

Properties

IsValidReturns true if the ContentSceneFile handle is valid. A handle becomes invalid after the file is unloaded.
SceneThe Scene object being loaded. This is accessible both before and after the load operation completes.
StatusThe loading status of the scene.

Public Methods

IntegrateAtEndOfFrameCalling this will cause the scene to integrate at the end of the frame.
UnloadAtEndOfFrameWill trigger the scene to unload at the end of the frame.
WaitForLoadCompletionBlocks on the main thread until the load operation completes. This function can be slow and so should be used carefully to avoid frame rate stuttering.