feat(Manager): Add toggle pause function

Author: jcs090218

Assets/JCSUnity/Scripts/Managers/JCS_PauseManager.cs

@@ -29,9 +29,9 @@ public class JCS_PauseManager : JCS_Manager<JCS_PauseManager>
         [ReadOnly]
         private float mTimeScale = 1.0f;
 
-        [Tooltip("Test this module?")]
+        [Tooltip("Turn on to test this behaviour.")]
         [SerializeField]
-        private bool mTestWithKey = false;
+        private bool mTest = false;
 
         [Tooltip("Key to toggle game pause/unpause.")]
         [SerializeField]
@@ -139,7 +139,7 @@ private void Update()
 #if UNITY_EDITOR
         private void TestPauseGame()
         {
-            if (!mTestWithKey)
+            if (!mTest)
                 return;
 
             if (Input.GetKeyDown(mToggleGamePause))
@@ -181,7 +181,7 @@ public void ResetState()
             mTargetTimeScale = mDefaultTimeScale;
             Time.timeScale = mDefaultTimeScale;
 
-            PauseTheWholeGame(false);
+            SetPause(false);
         }
 
         /// <summary>
@@ -196,7 +196,7 @@ public void Pause()
             else
                 Time.timeScale = 0.0f;
 
-            PauseTheWholeGame(true);
+            SetPause(true);
         }
 
         /// <summary>
@@ -211,20 +211,30 @@ public void Unpause()
             else
                 Time.timeScale = mDefaultTimeScale;
 
-            PauseTheWholeGame(false);
+            SetPause(false);
         }
 
         /// <summary>
-        /// Pause/Unpause the whole game.
+        /// Toggle between pause/unpause the game.
         /// </summary>
-        public void PauseTheWholeGame(bool act = true)
+        public void TogglePause()
+        {
+            if (mPaused)
+                Unpause();
+            else
+                Pause();
+        }
+
+        /// <summary>
+        /// Set pause/unpause the game.
+        /// </summary>
+        public void SetPause(bool act = true)
         {
             foreach (JCS_PauseAction pauseAction in mPauseActions)
             {
                 if (pauseAction == null)
                     continue;
 
-
                 // NOTE(jenchieh): the act should be opposite with the 
                 // enable /disable.
 

docs/ScriptReference/Managers/JCS_PauseManager.md

@@ -14,10 +14,11 @@ need the pause manager to add it to `JCS_Managers` transform in the Hierarchy.
 
 ## Functions
 
-| Name              | Description                                                                                            |
-|:------------------|:-------------------------------------------------------------------------------------------------------|
-| AddActionToList   | Add the pause action to the list of pause action list, in order to get manage by this "pause manager". |
-| ResetState        | Reset pause state.                                                                                     |
-| Pause             | Pause the game.                                                                                        |
-| Unpase            | Unpause the game.                                                                                      |
-| PauseTheWholeGame | ause/Unpause the whole game.                                                                           |
+| Name            | Description                                                                                            |
+|:----------------|:-------------------------------------------------------------------------------------------------------|
+| AddActionToList | Add the pause action to the list of pause action list, in order to get manage by this "pause manager". |
+| ResetState      | Reset pause state.                                                                                     |
+| Pause           | Pause the game.                                                                                        |
+| Unpase          | Unpause the game.                                                                                      |
+| TogglePause     | Toggle between pause/unpause the game.                                                                 |
+| SetPause        | Set pause/unpause the game.                                                                            |