feat: Add callback when on destroy

Author: jcs090218

Assets/JCSUnity/Scripts/Events/Destroy/JCS_DestroyObjectWithTime.cs

@@ -6,6 +6,7 @@
  * $Notice: See LICENSE.txt for modification and distribution information 
  *                   Copyright (c) 2016 by Shen, Jen-Chieh $
  */
+using System;
 using System.Collections.Generic;
 using UnityEngine;
 using MyBox;
@@ -19,6 +20,9 @@ public class JCS_DestroyObjectWithTime : MonoBehaviour
     {
         /* Variables */
 
+        // Execute when the time is up.
+        public Action onTimeIsUp = null;
+
         private float mTimer = 0;
 
         private bool mTimesUp = false;
@@ -38,7 +42,7 @@ public class JCS_DestroyObjectWithTime : MonoBehaviour
 
         [Tooltip("While destroying, fade out the game object.")]
         [SerializeField]
-        private bool mDestroyWithAlphaEffect = true;
+        private bool mWithAlphaEffect = true;
 
         [Tooltip("Fade out objects that fade out after the time is up.")]
         [SerializeField]
@@ -64,7 +68,7 @@ private void Update()
         {
             mTimer += JCS_Time.ItTime(mTimeType);
 
-            if (mDestroyWithAlphaEffect)
+            if (mWithAlphaEffect)
             {
                 if (mDestroyTime - mTimer <= mFadeTime)
                     FadeOut();
@@ -73,15 +77,17 @@ private void Update()
             if (mDestroyTime < mTimer)
             {
                 mTimesUp = true;
+
+                onTimeIsUp?.Invoke();
+
                 Destroy(gameObject);
             }
         }
 
         /// <summary>
-        /// Return the first fade object in the array.
+        /// Retrieve the first fade object.
         /// </summary>
-        /// <returns></returns>
-        public JCS_FadeObject GetFadeObject()
+        public JCS_FadeObject FirstFadeObject()
         {
             foreach (JCS_FadeObject fo in mFadeObjects)
             {

docs/ScriptReference/Events/Destroy/JCS_DestroyObjectWithTime.md

@@ -4,10 +4,17 @@ Destroy the game object by time.
 
 ## Variables
 
-| Name                    | Description                                          |
-|:------------------------|:-----------------------------------------------------|
-| mDestroyTime            | Target time to destroy.                              |
-| mDestroyWithAlphaEffect | While destroying, fade out the game object.          |
-| FadeObjects             | Fade out objects that fade out after the time is up. |
-| FadeObjects             | Fade out objects that fade out after the time is up. |
-| FadeTime                | How long it fades.                                   |
+| Name             | Description                                          |
+|:-----------------|:-----------------------------------------------------|
+| onTimeIsUp       | onTimeIsUp                                           |
+| mDestroyTime     | Target time to destroy.                              |
+| mWithAlphaEffect | While destroying, fade out the game object.          |
+| FadeObjects      | Fade out objects that fade out after the time is up. |
+| FadeObjects      | Fade out objects that fade out after the time is up. |
+| FadeTime         | How long it fades.                                   |
+
+## Functions
+
+| Name            | Description                     |
+|:----------------|:--------------------------------|
+| FirstFadeObject | Retrieve the first fade object. |