Documentation

Unity Engine


Unity Engine


UnloadAtEndOfFrame()

Will trigger the scene to unload at the end of the frame.
Read time 1 minuteLast updated a month ago

Definition

  • Type: Method
  • Namespace: Unity.Loading
  • Assembly: UnityEngine.ContentLoadModule
public bool UnloadAtEndOfFrame()

Returns

Type

Description

boolTrue if successful. False if the scene is not in a state that can be unloaded.

Remarks

This must be called on a ContentSceneFile even if the status is SceneLoadingStatus.Failed in order to release internal resources.
The call will fail if the scene is not in an unloadable state. For example, it is actively being loaded or unloaded.