Version: 2021.1
LanguageEnglish
  • C#

EditorSceneManager.SaveCurrentModifiedScenesIfUserWantsTo

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

Declaration

public static bool SaveCurrentModifiedScenesIfUserWantsTo();

Returns

bool This returns true if you chose to save the Scene or Scenes, and returns false if you pressed Cancel.

Description

Asks you if you want to save the modified Scene or Scenes.

The hierarchy window shows all open Scenes. They can be saved or unsaved. The SaveCurrentModifiedScenesIfUserWantsTo() presents a window showing the unsaved modified Scenes. Save will write the changed Scenes; Cancel will do nothing and leave the Scenes unchanged. The Save button returns true. The Cancel button returns false.

SaveCurrentModifiedScenesIfUserWantsTo() is run from the editor. The creation of an editor menu item is required. The following example shows this menu item.

// Add an editor menu item that enables Scenes to be saved or not,
// This example adds the editor extension into an Examples menu.

using UnityEngine; using UnityEditor; using UnityEditor.SceneManagement;

public class ExampleClass : MonoBehaviour { [MenuItem("Examples/Save current Scene(s) if required")] static void MaybeSaveScenes() { if (EditorSceneManager.SaveCurrentModifiedScenesIfUserWantsTo()) { Debug.Log("Save Scene(s)"); } else { Debug.Log("Don't save Scene(s)"); } } }

Note: Currently a window with three buttons is shown. Save and /Don't Save/ both cause the Scene(s) to be written. Cancel leaves the Scene(s) untouched.