Legacy Documentation: Version 5.5
LanguageEnglish
  • C#
  • JS

Script language

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

MonoBehaviour.OnApplicationPause(bool)

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

Parameters

pauseStatus True if the application is paused, else False.

Description

Sent to all GameObjects when the application pauses.

OnApplicationPause is called OnApplicationPause can be a co-routine; to do this use the yield statement in the function. Implemented this way, it is evaluated twice during the initial frame: first as an early notification, and secondly during the normal co-routine update step.

On Android, when the on-screen keyboard is enabled, it causes a OnApplicationFocus( false ) event. Additionally, if you press "Home" at the moment the keyboard is enabled, the OnApplicationFocus() event is not called, but OnApplicationPause() is called instead.

#pragma strict
public class AppPaused extends MonoBehaviour {
	var isPaused: boolean = false;
	function OnGUI() {
		if (isPaused)
			GUI.Label(new Rect(100, 100, 50, 30), "Game paused");
	}
	function OnApplicationFocus(hasFocus: boolean) {
		isPaused = !hasFocus;
	}
	function OnApplicationPause(pauseStatus: boolean) {
		isPaused = pauseStatus;
	}
}
using UnityEngine;

public class AppPaused : MonoBehaviour { bool isPaused = false;

void OnGUI( ) { if( isPaused ) GUI.Label( new Rect( 100, 100, 50, 30 ), "Game paused" ); }

void OnApplicationFocus( bool hasFocus ) { isPaused = !hasFocus; }

void OnApplicationPause( bool pauseStatus ) { isPaused = pauseStatus; } }