chore: Add function to get canvas by name

Author: jcs090218

Assets/JCSUnity/Scripts/Managers/JCS_UIManager.cs

@@ -89,7 +89,7 @@ public void SetDialogue(JCS_DialogueType type, JCS_DialogueObject jdo)
                         //    return;
                         //}
 
-                        this.mFocusGameDialogue = jdo;
+                        mFocusGameDialogue = jdo;
                     }
                     break;
                 case JCS_DialogueType.SYSTEM_DIALOGUE:
@@ -105,7 +105,7 @@ public void SetDialogue(JCS_DialogueType type, JCS_DialogueObject jdo)
                     break;
             }
         }
-        public JCS_DialogueObject GetJCSDialogue(JCS_DialogueType type)
+        public JCS_DialogueObject GetDialogue(JCS_DialogueType type)
         {
             switch (type)
             {
@@ -133,15 +133,15 @@ private void Awake()
         {
             RegisterInstance(this);
 
-            this.mOpenWindow = new LinkedList<JCS_DialogueObject>();
+            mOpenWindow = new LinkedList<JCS_DialogueObject>();
 
-            this.mGlobalUndoRedoSystem = this.gameObject.AddComponent<JCS_UndoRedoSystem>();
+            mGlobalUndoRedoSystem = gameObject.AddComponent<JCS_UndoRedoSystem>();
         }
         private void Start()
         {
             // pop the fade screen.
             string path = JCS_UISettings.FADE_SCREEN_PATH;
-            this.mFadeScreen = JCS_Util.Instantiate(path).GetComponent<JCS_FadeScreen>();
+            mFadeScreen = JCS_Util.Instantiate(path).GetComponent<JCS_FadeScreen>();
         }
 
 #if UNITY_EDITOR
@@ -165,7 +165,7 @@ private void Test()
 
             if (JCS_Input.GetKeyDown(KeyCode.S))
             {
-                UnFocus();
+                Unfocus();
             }
         }
 #endif
@@ -175,7 +175,7 @@ private void Test()
         /// </summary>
         public void AddCanvas(JCS_Canvas canvas)
         {
-            this.mCanvases.Add(canvas);
+            mCanvases.Add(canvas);
             mCanvases = JCS_Array.RemoveEmptyMissing(mCanvases);
             mCanvases = SortCanvases_Insertion();
         }
@@ -196,6 +196,20 @@ private List<JCS_Canvas> SortCanvases_Insertion()
             return mCanvases;
         }
 
+        /// <summary>
+        /// Return the canvas by name.
+        /// </summary>
+        public JCS_Canvas CanvasByName(string name)
+        {
+            foreach (JCS_Canvas canvas in mCanvases)
+            {
+                if (canvas.name == name)
+                    return canvas;
+            }
+
+            return null;
+        }
+
         /// <summary>
         /// Hide the last open dialogue in the current scene.
         /// </summary>
@@ -286,7 +300,7 @@ public void Focus(float time, Color color)
         /// <summary>
         /// Fade out the screen, back to original amount of value.
         /// </summary>
-        public void UnFocus()
+        public void Unfocus()
         {
             JCS_FadeObject fadeObj = mFadeScreen.fadeObject;
             fadeObj.FadeOut();
@@ -295,7 +309,7 @@ public void UnFocus()
         /// <summary>
         /// Fade out the screen, back to original amount of value.
         /// </summary>
-        public void UnFocus(float time)
+        public void Unfocus(float time)
         {
             JCS_FadeObject fadeObj = mFadeScreen.fadeObject;
             fadeObj.FadeOut(time);

Assets/JCSUnity/Scripts/UI/JCS_Canvas.cs

@@ -137,22 +137,22 @@ public enum ShowMethod
 
         /* Setter & Getter */
 
-        public RectTransform appRect { get { return this.mAppRect; } }
-        public Canvas canvas { get { return this.mCanvas; } }
-        public CanvasGroup canvasGroup { get { return this.mCanvasGroup; } }
-        public JCS_ResizeUI resizeUI { get { return this.mResizeUI; } }
+        public RectTransform appRect { get { return mAppRect; } }
+        public Canvas canvas { get { return mCanvas; } }
+        public CanvasGroup canvasGroup { get { return mCanvasGroup; } }
+        public JCS_ResizeUI resizeUI { get { return mResizeUI; } }
 
-        public bool displayOnAwake { get { return this.mDisplayOnAwake; } }
-        public bool mainCanvas { get { return this.mMainCanvas; } }
-        public ShowMethod showMethod { get { return this.mShowMethod; } set { this.mShowMethod = value; } }
+        public bool displayOnAwake { get { return mDisplayOnAwake; } }
+        public bool mainCanvas { get { return mMainCanvas; } }
+        public ShowMethod showMethod { get { return mShowMethod; } set { mShowMethod = value; } }
 
-        public float fadeFriction { get { return this.mFadeFriction; } set { this.mFadeFriction = value; } }
-        public float fadeInAmount { get { return this.mFadeInAmount; } set { this.mFadeInAmount = value; } }
-        public float fadeOutAmount { get { return this.mFadeOutAmount; } set { this.mFadeOutAmount = value; } }
+        public float fadeFriction { get { return mFadeFriction; } set { mFadeFriction = value; } }
+        public float fadeInAmount { get { return mFadeInAmount; } set { mFadeInAmount = value; } }
+        public float fadeOutAmount { get { return mFadeOutAmount; } set { mFadeOutAmount = value; } }
 
-        public JCS_TimeType timeType { get { return this.mTimeType; } set { this.mTimeType = value; } }
-        public AudioClip soundOnShow { get { return this.mSoundOnShow; } set { this.mSoundOnShow = value; } }
-        public AudioClip soundOnHide { get { return this.mSoundOnHide; } set { this.mSoundOnHide = value; } }
+        public JCS_TimeType timeType { get { return mTimeType; } set { mTimeType = value; } }
+        public AudioClip soundOnShow { get { return mSoundOnShow; } set { mSoundOnShow = value; } }
+        public AudioClip soundOnHide { get { return mSoundOnHide; } set { mSoundOnHide = value; } }
 
         public static float SCALE_FACTOR
         {
@@ -171,9 +171,9 @@ private void Awake()
         {
             CheckMainCanvas();
 
-            this.mAppRect = this.GetComponent<RectTransform>();
-            this.mCanvas = this.GetComponent<Canvas>();
-            this.mCanvasGroup = this.GetComponent<CanvasGroup>();
+            mAppRect = GetComponent<RectTransform>();
+            mCanvas = GetComponent<Canvas>();
+            mCanvasGroup = GetComponent<CanvasGroup>();
 
             var uis = JCS_UISettings.FirstInstance();
             var screens = JCS_ScreenSettings.FirstInstance();
@@ -186,7 +186,7 @@ private void Awake()
                 // resizable UI in order to resize the UI correctly
                 mResizeUI = spawned.GetComponent<JCS_ResizeUI>();
 
-                mResizeUI.transform.SetParent(this.transform);
+                mResizeUI.transform.SetParent(transform);
             }
 
             uim.AddCanvas(this);
@@ -293,7 +293,7 @@ public static JCS_Canvas GuessCanvas(Transform trans = null)
         /// <param name="com"> Component add to canvas. </param>
         public void AddComponentToResizeCanvas(Component com)
         {
-            Transform newParent = (mResizeUI != null) ? mResizeUI.transform : this.mCanvas.transform;
+            Transform newParent = (mResizeUI != null) ? mResizeUI.transform : mCanvas.transform;
 
             if (newParent == null)
                 Debug.LogError($"Attach resize canvas exception: {com}");
@@ -422,7 +422,7 @@ public bool IsFading()
         /// </summary>
         private void CheckMainCanvas()
         {
-            if (!this.mMainCanvas)
+            if (!mMainCanvas)
                 return;
 
             if (main != null)