Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

OnExitingPlayModeAttribute

Marks a static method as a callback to be invoked when exiting Play mode.
Read time 1 minuteLast updated 5 days ago

Definition

  • Type: Class
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule
[AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]public sealed class OnExitingPlayModeAttribute : LifecycleAttributeBase

Remarks

Methods marked with this attribute are called when exiting Play mode. This happens:
  • When stopping Play mode in the Editor.
  • Before code reload in Play mode (Editor only).
  • Before application quit (Player only).
Use this callback to:
  • Save Play mode state.
  • Clean up runtime resources.
  • Prepare for Edit mode or code reload.
This is a method attribute that can only be applied to 
static
methods with no parameters and return type 
void
.
Important: Due to differences in the way different platforms handle closing or navigating away from a running application, 
[OnExitingPlayMode]
is subject to the same platform-specific limitations in built Players as MonoBehaviour.OnApplicationQuit(). For more information, refer to the description for MonoBehaviour.OnApplicationQuit().
Additional Resources: OnEnteringPlayModeAttribute, BeforeManagedObjectsBackupAttribute.

Examples

using UnityEngine;public static partial class PlayModeManager{    [OnExitingPlayMode]    static void OnPlayModeExited()    {        Debug.Log("Exiting Play mode");    }}

Constructors

Constructor

Description

OnExitingPlayModeAttribute()Marks the decorated static method to be invoked when exiting Play mode.