Version: 2020.1
LanguageEnglish
  • C#

PreviewSceneStage.OnCloseStage

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

protected void OnCloseStage();

Description

Unity calls this method when the Stage is closed. Classes that inherit from PreviewSceneStage should implement cleanup logic in this method.

A Stage can remain open even after another Stage becomes the active Stage. Unity only closes a Stage once it's no longer visible in the Scene view breadcrumb bar. OnOpenStage and OnCloseStage is only called once each.

If you override this method, call the base method base.OnCloseStage() from within the implementation to unload the preview Scene associated with the stage. PreviewSceneStage.scene will be invalid after that point.

Did you find this page useful? Please give it a rating: