fix: Invocation time in first frame

Author: jcs090218

Assets/JCSUnity/Scripts/Actions/JCS_AdjustTimeTrigger.cs

@@ -41,6 +41,12 @@ public class JCS_AdjustTimeTrigger : MonoBehaviour
         [ReadOnly]
         private bool mDidAction = false;
 
+        [Separator("Initialize Variables (JCS_AdjustTimeTrigger)")]
+
+        [Tooltip("Run immediately on start.")]
+        [SerializeField]
+        private bool mRunImmediate = true;
+
         [Separator("Runtime Variables (JCS_AdjustTimeTrigger)")]
 
         [Tooltip("Is this component active?")]
@@ -67,6 +73,7 @@ public class JCS_AdjustTimeTrigger : MonoBehaviour
 
         /* Setter & Getter */
 
+        public bool RunImmediate { get { return this.mRunImmediate; } set { this.mRunImmediate = value; } }
         public bool Active { get { return this.mActive; } set { this.mActive = value; } }
         public float TimeZone { get { return this.mTimeZone; } set { this.mTimeZone = value; } }
         public float AdjustTimeZone { get { return this.mAdjustTimeZone; } set { this.mAdjustTimeZone = value; } }
@@ -75,6 +82,13 @@ public class JCS_AdjustTimeTrigger : MonoBehaviour
 
         /* Functions */
 
+        private void Start()
+        {
+            // Run immediately on the first frame.
+            if (mRunImmediate)
+                Invoke(nameof(ExecuteAction), JCS_Constants.FIRST_FRAME_INVOKE_TIME);
+        }
+
         private void Update()
         {
             if (!mActive)
@@ -109,14 +123,19 @@ private void DoAction()
             if (mRealTimeZone > mTimer)
                 return;
 
-            // active actions.
-            if (onAction != null)
-                onAction.Invoke();
-
-            if (mOnAction != null)
-                mOnAction.Invoke();
+            ExecuteAction();
 
             mDidAction = true;
         }
+
+        /// <summary>
+        /// Execute the action.
+        /// </summary>
+        private void ExecuteAction()
+        {
+            onAction?.Invoke();
+
+            mOnAction?.Invoke();
+        }
     }
 }

Assets/JCSUnity/Scripts/JCS_Constants.cs

@@ -16,6 +16,15 @@ public static class JCS_Constants
     {
         /* Variables */
 
+        // The time delay to be invoked for the first frame.
+        //
+        // First frame invocation can't be set to 0; therefore, we set
+        // to somthing really small. Generally has to be smaller than
+        // the 1/60 frame time.
+        //
+        // See https://docs.unity3d.com/6000.1/Documentation/ScriptReference/MonoBehaviour.Invoke.html
+        public const float FIRST_FRAME_INVOKE_TIME = 0.001f;
+
         // The minimum friction value.
         public const float FRICTION_MIN = 0.01f;
 

Assets/JCSUnity/Scripts/Managers/JCS_GameManager.cs

@@ -66,7 +66,7 @@ private void Awake()
 
             SetSpecificGameTypeGameManager();
 
-            Invoke("OnFirstFrame", 0.0f);
+            Invoke(nameof(OnFirstFrame), JCS_Constants.FIRST_FRAME_INVOKE_TIME);
         }
 
         /// <summary>

docs/ScriptReference/JCS_Constants.md

@@ -4,8 +4,9 @@ Place general game constant here.
 
 ## Variables
 
-| Name           | Description                                    |
-|:---------------|:-----------------------------------------------|
-| FRICTION_MIN   | The minimum friction value.                    |
-| FRICTION       | The default effect friction value.             |
-| NEAR_THRESHOLD | Below this threshold is consider close enough. |
+| Name                    | Description                                       |
+|:------------------------|:--------------------------------------------------|
+| FIRST_FRAME_INVOKE_TIME | The time delay to be invoked for the first frame. |
+| FRICTION_MIN            | The minimum friction value.                       |
+| FRICTION                | The default effect friction value.                |
+| NEAR_THRESHOLD          | Below this threshold is consider close enough.    |