Version: 2018.1 (switch to 2018.2 or 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Application.wantsToQuit

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

Unity raises this event when the player application wants to quit.

Add an event handler to this event to receive a notification that application is attempting to quit.

When this event is raised the quit process has started but can be cancelled. This means the player is not guaranteed to quit. For a guaranteed quit event take a look at Application.quitting.

Return true and the quit process will continue. Return false and the quit process will cancel.

Note: The return value of this event is ignored when exiting play mode in the editor. IMPORTANT: The return has no effect on iPhone. Application can not prevent termination under iPhone OS.

#pragma strict
public class PlayerWantsToQuitExample {
	static function WantsToQuit() {
		Debug.Log("Player prevented from quitting.");
		return false;
	}
	@RuntimeInitializeOnLoadMethod
	static function RunOnStart() {
		Application.wantsToQuit += WantsToQuit;
	}
}
using UnityEngine;

public class PlayerWantsToQuitExample { static bool WantsToQuit() { Debug.Log("Player prevented from quitting."); return false; }

[RuntimeInitializeOnLoadMethod] static void RunOnStart() { Application.wantsToQuit += WantsToQuit; } }

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