feat(Util): Reuse overload withinrange

jcs090218 · Nov 13, 2024 · 121664e · 121664e
1 parent d3814f7
commit 121664e
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 11 deletions.
diff --git a/Assets/JCSUnity/Scripts/Input/JCS_ButtonSelectionGroup.cs b/Assets/JCSUnity/Scripts/Input/JCS_ButtonSelectionGroup.cs
@@ -203,7 +203,7 @@ public void SelectSelection(int selectionIndex, bool hoverCheck = false)
         {
             if (hoverCheck)
             {
-                if (JCS_Util.WithInArrayRange(selectionIndex, mSelections))
+                if (JCS_Util.WithInRange(selectionIndex, mSelections))
                 {
                     if (mSelections[selectionIndex].Skip)
                         return;
@@ -214,15 +214,15 @@ public void SelectSelection(int selectionIndex, bool hoverCheck = false)
             if (mCurrentSelectIndex == selectionIndex)
                 return;
 
-            if (JCS_Util.WithInArrayRange(mCurrentSelectIndex, mSelections))
+            if (JCS_Util.WithInRange(mCurrentSelectIndex, mSelections))
             {
                 // disable current active selection.
                 mSelections[mCurrentSelectIndex].Active = false;
             }
 
             this.mCurrentSelectIndex = selectionIndex;
 
-            this.mCurrentSelectIndex = JCS_Util.LoopInArray(this.mCurrentSelectIndex, mSelections);
+            this.mCurrentSelectIndex = JCS_Util.LoopIn(this.mCurrentSelectIndex, mSelections);
 
             // active the new active selection.
             mSelections[mCurrentSelectIndex].Active = true;

diff --git a/Assets/JCSUnity/Scripts/UI/LinkedObject/JCS_TransformLinkedObjectController.cs b/Assets/JCSUnity/Scripts/UI/LinkedObject/JCS_TransformLinkedObjectController.cs
@@ -151,7 +151,7 @@ public List<JCS_TransformLinkedObject> NewLinked(int n = 1, int startIndex = 0)
         /// <returns> List of removed linked object. </returns>
         public List<JCS_TransformLinkedObject> RemoveLinked(int n = 1, int startIndex = 0)
         {
-            if (!JCS_Util.WithInArrayRange(startIndex, mManagedList))
+            if (!JCS_Util.WithInRange(startIndex, mManagedList))
             {
                 JCS_Debug.LogReminder("Can't remove linked node with index lower than 0");
                 return null;

diff --git a/Assets/JCSUnity/Scripts/UI/Page/JCS_PageIndicators.cs b/Assets/JCSUnity/Scripts/UI/Page/JCS_PageIndicators.cs
@@ -55,7 +55,7 @@ public void SetPage(int page)
         {
             SetSprite(mInactiveSprite);
 
-            if (!JCS_Util.WithInArrayRange(page, mIndicators))
+            if (!JCS_Util.WithInRange(page, mIndicators))
             {
                 JCS_Debug.LogWarning("Page indicators out of range exception");
                 return;

diff --git a/Assets/JCSUnity/Scripts/Util/JCS_Util.cs b/Assets/JCSUnity/Scripts/Util/JCS_Util.cs
@@ -195,7 +195,7 @@ public static bool WithInRange(float minRange, float maxRange, float currentVal)
         /// With in array range. (Array)
         /// </summary>
         /// <returns></returns>
-        public static bool WithInArrayRange<T>(int index, T[] arr)
+        public static bool WithInRange<T>(int index, T[] arr)
         {
             return index >= 0 && index < arr.Length;
         }
@@ -204,7 +204,7 @@ public static bool WithInArrayRange<T>(int index, T[] arr)
         /// With in array range. (List)
         /// </summary>
         /// <returns></returns>
-        public static bool WithInArrayRange<T>(int index, List<T> arr)
+        public static bool WithInRange<T>(int index, List<T> arr)
         {
             return index >= 0 && index < arr.Count;
         }
@@ -216,7 +216,7 @@ public static bool WithInArrayRange<T>(int index, List<T> arr)
         /// <param name="index"> Index </param>
         /// <param name="arr"> Array. </param>
         /// <returns> index that looped. </returns>
-        public static int LoopInArray<T>(int index, T[] arr)
+        public static int LoopIn<T>(int index, T[] arr)
         {
             // loop through the array, if at the tail of the array set it to head.
             if (index < 0)
@@ -234,7 +234,7 @@ public static int LoopInArray<T>(int index, T[] arr)
         /// <param name="index"> Index </param>
         /// <param name="arr"> List. </param>
         /// <returns> index that looped. </returns>
-        public static int LoopInArray<T>(int index, List<T> arr)
+        public static int LoopIn<T>(int index, List<T> arr)
         {
             // loop through the array, if at the tail of the array set it to head.
             if (index < 0)

diff --git a/docs/ScriptReference/Util/JCS_Util.md b/docs/ScriptReference/Util/JCS_Util.md
@@ -12,8 +12,8 @@ All code utility is stored here.
 | FindObjectByType                     | Retrieves the first active loaded object of Type type.                                            |
 | FindObjectsByType                    | Retrieves a list of all loaded objects of Type type.                                              |
 | WithInRange                          | Check if the value is within the range.                                                           |
-| WithInArrayRange                     | Check if the index valid within the array length.&nbsp&nbsp(0 ~ (length - 1))                     |
-| LoopInArray                          | Make the index is within the array length by setting the maxinum of (legnth - 1) or mininum of 0. |
+| WithInRange                          | Check if the index valid within the array length.                                                 |
+| LoopIn                               | Make the index is within the array length by setting the maxinum of (legnth - 1) or mininum of 0. |
 | SpawnAnimateObject                   | Spawn a gameobject with animation attached.                                                       |
 | SpawnAnimateObjectDeathEvent         | Spawn a gameobject with the animator and death event on it.                                       |
 | SetActiveToAllChildren               | Active all the child in a transform.                                                              |