fix: button sound on hover

jcs090218 · jcs090218 · commit 00ee7b717af1 · 2025-12-03T05:31:23.000+08:00
diff --git a/Assets/JCSUnity/Scripts/Effects/JCS_ButtonSoundEffect.cs b/Assets/JCSUnity/Scripts/Effects/JCS_ButtonSoundEffect.cs
@@ -24,9 +24,15 @@ public class JCS_ButtonSoundEffect : MonoBehaviour
     {
         /* Variables */
 
-        private RectTransform mRectTransform = null;
         private EventTrigger mEventTrigger = null;
 
+        [Separator("Check Variables (JCS_ButtonSoundEffect)")]
+
+        [Tooltip("Is true when mouse is over this button.")]
+        [SerializeField]
+        [ReadOnly]
+        private bool mIsEntered = false;
+
         [Separator("Optional Variables (JCS_ButtonSoundEffect)")]
 
         [Tooltip(@"Sound Player for this button, if this transform dose not 
@@ -55,7 +61,6 @@ public class JCS_ButtonSoundEffect : MonoBehaviour
         [SerializeField]
         private AudioClip mOnMouseDoubleClickSound = null;
 
-        private bool mIsOver = false;
 
         [SerializeField]
         private JCS_SoundMethod mOnMouseOverSoundMethod = JCS_SoundMethod.PLAY_SOUND;
@@ -141,7 +146,6 @@ private void Awake()
         {
             if (mSoundPlayer == null)
                 mSoundPlayer = GetComponent<JCS_SoundPlayer>();
-            mRectTransform = GetComponent<RectTransform>();
             mEventTrigger = GetComponent<EventTrigger>();
 
             if (mBtn == null)
@@ -164,8 +168,7 @@ private void Start()
 
             if (mAutoAddEvent)
             {
-                JCS_UIUtil.AddEventTriggerEvent(mEventTrigger, EventTriggerType.PointerEnter, ItOnMouseOver);
-                JCS_UIUtil.AddEventTriggerEvent(mEventTrigger, EventTriggerType.PointerEnter, ItOnMouseDoubleClick);
+                JCS_UIUtil.AddEventTriggerEvent(mEventTrigger, EventTriggerType.PointerEnter, ItOnMouseEnter);
                 JCS_UIUtil.AddEventTriggerEvent(mEventTrigger, EventTriggerType.PointerExit, ItOnMouseExit);
                 JCS_UIUtil.AddEventTriggerEvent(mEventTrigger, EventTriggerType.PointerDown, ItOnMouseDown);
                 JCS_UIUtil.AddEventTriggerEvent(mEventTrigger, EventTriggerType.PointerUp, ItOnMouseUp);
@@ -181,26 +184,17 @@ private void Update()
         private void HandleDoubleClick()
         {
             // IMPORTANT(JenChieh): only double click need update
-            if (!mIsOver)
-                return;
-
-            if (mBtn == null)
+            if (mBtn == null || !mIsEntered)
                 return;
 
             if (JCS_Input.OnMouseDoubleClick(0))
             {
-                // either time is out or double click, 
-                // both are all over the "double click event".
-                mIsOver = false;
-
                 if (!mBtn.interactable)
                 {
                     // play not ineractable sound
                     mSoundPlayer.PlayOneShotByMethod(
                         mOnMouseDoubleClickRefuseSound,
                         mOnMouseDoubleClickRefuseSoundMethod);
-
-                    return;
                 }
                 else
                 {
@@ -210,18 +204,16 @@ private void HandleDoubleClick()
                         mOnMouseDoubleClickSoundMethod);
                 }
             }
-
-            // check if the mouse still over or not
-            if (!JCS_UIUtil.MouseOverGUI(mRectTransform))
-                mIsOver = false;
         }
 
-        public void ItOnMouseOver()
+        public void ItOnMouseEnter()
         {
-            ItOnMouseOver(null);
+            ItOnMouseEnter(null);
         }
-        public void ItOnMouseOver(PointerEventData data)
+        public void ItOnMouseEnter(PointerEventData data)
         {
+            mIsEntered = true;
+
             if (mBtn != null)
             {
                 if (!mBtn.interactable)
@@ -245,6 +237,8 @@ public void ItOnMouseExit()
         }
         public void ItOnMouseExit(PointerEventData data)
         {
+            mIsEntered = false;
+
             if (mBtn == null)
                 return;
 
@@ -269,7 +263,7 @@ public void ItOnMouseDown()
         }
         public void ItOnMouseDown(PointerEventData data)
         {
-            if (mBtn == null)
+            if (mBtn == null || !mIsEntered)
                 return;
 
             if (!mBtn.interactable)
@@ -294,7 +288,7 @@ public void ItOnMouseUp()
         }
         public void ItOnMouseUp(PointerEventData data)
         {
-            if (mBtn == null)
+            if (mBtn == null || !mIsEntered)
                 return;
 
             if (!mBtn.interactable)
@@ -335,15 +329,5 @@ public void ItOnMouseClick(PointerEventData data)
                     mOnMouseClickSoundMethod);
             }
         }
-
-        // plz put this in Pointer Enter event
-        public void ItOnMouseDoubleClick()
-        {
-            ItOnMouseDoubleClick(null);
-        }
-        public void ItOnMouseDoubleClick(PointerEventData data)
-        {
-            mIsOver = true;
-        }
     }
 }
diff --git a/Assets/JCSUnity/Scripts/Input/JCS_ButtonSelection.cs b/Assets/JCSUnity/Scripts/Input/JCS_ButtonSelection.cs
@@ -138,11 +138,9 @@ private void Start()
         /// </summary>
         public void DoSelection()
         {
-            if (mButton != null)
-                mButton.ButtonClick();
+            mButton?.InterBtnClick();
 
-            if (mSelectedEvent != null)
-                mSelectedEvent.Invoke();
+            mSelectedEvent?.Invoke();
         }
 
         /// <summary>
diff --git a/Assets/JCSUnity/Scripts/Input/JCS_Input.cs b/Assets/JCSUnity/Scripts/Input/JCS_Input.cs
@@ -258,15 +258,17 @@ static bool OnMouseDoubleClick(int button)
             // Check first click
             if (!CLICK)
             {
-                if (GetMouseButtonDown(button))
+                if (GetMouseButtonUp(button))
                     CLICK = true;
             }
             // Check double click
             else
             {
-                if (GetMouseButtonDown(button))
+                if (GetMouseButtonUp(button))
                 {
                     CLICK = false;
+                    CLICK_TIMER = 0.0f;
+
                     return true;
                 }
             }
diff --git a/Assets/JCSUnity/Scripts/UI/Button/JCS_RollSelectorButton.cs b/Assets/JCSUnity/Scripts/UI/Button/JCS_RollSelectorButton.cs
@@ -69,7 +69,7 @@ private void Start()
         /// <summary>
         /// Override
         /// </summary>
-        public override void ButtonClick()
+        public override void InterBtnClick()
         {
             if (mRollBtnSelector == null)
             {
@@ -84,7 +84,7 @@ public override void ButtonClick()
             }
             else
             {
-                base.ButtonClick();
+                base.InterBtnClick();
             }
         }
 
@@ -146,7 +146,7 @@ private void OverwriteAllButton()
             mButton.onClick.RemoveAllListeners();
 
             // only add this listener
-            mButton.onClick.AddListener(ButtonClick);
+            mButton.onClick.AddListener(InterBtnClick);
 
             // get all the buttons on this transform
             btns = GetComponents<JCS_Button>();
@@ -171,8 +171,8 @@ private void ActiveAllOtherButtons()
                 // don't call if is itself
                 if (b == this)
                     continue;
-                
-                b.ButtonClick();
+
+                b.InterBtnClick();
             }
         }
     }
diff --git a/Assets/JCSUnity/Scripts/UI/JCS_Button.cs b/Assets/JCSUnity/Scripts/UI/JCS_Button.cs
@@ -137,9 +137,9 @@ protected virtual void Awake()
         /// <summary>
         /// Intialize the button once.
         /// </summary>
-        public void Init(bool forceInit = false)
+        public void Init(bool force = false)
         {
-            if (!forceInit)
+            if (!force)
             {
                 if (mInitialized)
                     return;
@@ -163,14 +163,14 @@ public void Init(bool forceInit = false)
 
             if (mAutoListener)
             {
-                // add listener itself, but it won't show in the inspector
-                mButton.onClick.AddListener(ButtonClick);
+                // Add listener itself, but it won't show in the inspector.
+                mButton.onClick.AddListener(InterBtnClick);
             }
 
-            // set the stating interactable.
+            // Set the stating interactable.
             SetInteractable();
 
-            // part of the on click callback
+            // Part of the on click callback.
             SetSystemCallback(OnClick);
 
             mInitialized = true;
@@ -182,7 +182,7 @@ public void Init(bool forceInit = false)
         /// 
         /// * Good for organize code and game data file in Unity.
         /// </summary>
-        public virtual void ButtonClick()
+        public virtual void InterBtnClick()
         {
             mIsSelectedInGroup = IsSelected();
 
diff --git a/Assets/JCSUnity/Scripts/UI/JCS_GamepadButton.cs b/Assets/JCSUnity/Scripts/UI/JCS_GamepadButton.cs
@@ -85,7 +85,7 @@ protected virtual void Update()
             {
                 if (JCS_Input.IsAnyKeyBuffer(mKeyActionType))
                 {
-                    ButtonClick();
+                    InterBtnClick();
                     PlayButtonClickSound();
                 }
             }
@@ -97,7 +97,7 @@ protected virtual void Update()
                     // listen to game pad.
                     JCS_Input.GetJoystickKeyByAction(mKeyActionType, mJoystickLitener, mJKeyToListen))
                 {
-                    ButtonClick();
+                    InterBtnClick();
                     PlayButtonClickSound();
                 }
             }
diff --git a/Assets/JCSUnity/Scripts/Util/JCS_UIUtil.cs b/Assets/JCSUnity/Scripts/Util/JCS_UIUtil.cs
@@ -60,11 +60,13 @@ public static bool IsUnityDefinedUI(Component comp)
         /// <param name="te"></param>
         /// <param name="type"></param>
         /// <param name="func"></param>
-        public static void AddEventTriggerEvent(EventTrigger te, EventTriggerType type, Action<PointerEventData> func)
+        public static void AddEventTriggerEvent(
+            EventTrigger te, EventTriggerType type,
+            Action<PointerEventData> func)
         {
-            EventTrigger.Entry entry = new EventTrigger.Entry();
+            var entry = new EventTrigger.Entry();
             entry.eventID = type;
-            entry.callback.AddListener((data) => { func((PointerEventData)data); });
+            entry.callback.AddListener((data) => { func?.Invoke((PointerEventData)data); });
             te.triggers.Add(entry);
         }
 
@@ -74,11 +76,14 @@ public static void AddEventTriggerEvent(EventTrigger te, EventTriggerType type,
         /// <param name="te"></param>
         /// <param name="type"></param>
         /// <param name="func"></param>
-        public static void AddEventTriggerEvent(EventTrigger te, EventTriggerType type, Action<PointerEventData, JCS_ButtonSelection> func, JCS_ButtonSelection selection)
+        public static void AddEventTriggerEvent(
+            EventTrigger te, EventTriggerType type,
+            Action<PointerEventData, JCS_ButtonSelection> func,
+            JCS_ButtonSelection selection)
         {
-            EventTrigger.Entry entry = new EventTrigger.Entry();
+            var entry = new EventTrigger.Entry();
             entry.eventID = type;
-            entry.callback.AddListener((data) => { func((PointerEventData)data, selection); });
+            entry.callback.AddListener((data) => { func?.Invoke((PointerEventData)data, selection); });
             te.triggers.Add(entry);
         }
 

Original file line number	Diff line number	Diff line change
`@@ -24,9 +24,15 @@ public class JCS_ButtonSoundEffect : MonoBehaviour`
`24`	`24`	`{`
`25`	`25`	`/* Variables */`
`26`	`26`
`27`		`- private RectTransform mRectTransform = null;`
`28`	`27`	`private EventTrigger mEventTrigger = null;`
`29`	`28`
	`29`	`+ [Separator("Check Variables (JCS_ButtonSoundEffect)")]`
	`30`	`+`
	`31`	`+ [Tooltip("Is true when mouse is over this button.")]`
	`32`	`+ [SerializeField]`
	`33`	`+ [ReadOnly]`
	`34`	`+ private bool mIsEntered = false;`
	`35`	`+`
`30`	`36`	`[Separator("Optional Variables (JCS_ButtonSoundEffect)")]`
`31`	`37`
`32`	`38`	`[Tooltip(@"Sound Player for this button, if this transform dose not`
`@@ -55,7 +61,6 @@ public class JCS_ButtonSoundEffect : MonoBehaviour`
`55`	`61`	`[SerializeField]`
`56`	`62`	`private AudioClip mOnMouseDoubleClickSound = null;`
`57`	`63`
`58`		`- private bool mIsOver = false;`
`59`	`64`
`60`	`65`	`[SerializeField]`
`61`	`66`	`private JCS_SoundMethod mOnMouseOverSoundMethod = JCS_SoundMethod.PLAY_SOUND;`
`@@ -141,7 +146,6 @@ private void Awake()`
`141`	`146`	`{`
`142`	`147`	`if (mSoundPlayer == null)`
`143`	`148`	`mSoundPlayer = GetComponent<JCS_SoundPlayer>();`
`144`		`- mRectTransform = GetComponent<RectTransform>();`
`145`	`149`	`mEventTrigger = GetComponent<EventTrigger>();`
`146`	`150`
`147`	`151`	`if (mBtn == null)`
`@@ -164,8 +168,7 @@ private void Start()`
`164`	`168`
`165`	`169`	`if (mAutoAddEvent)`
`166`	`170`	`{`
`167`		`- JCS_UIUtil.AddEventTriggerEvent(mEventTrigger, EventTriggerType.PointerEnter, ItOnMouseOver);`
`168`		`- JCS_UIUtil.AddEventTriggerEvent(mEventTrigger, EventTriggerType.PointerEnter, ItOnMouseDoubleClick);`
	`171`	`+ JCS_UIUtil.AddEventTriggerEvent(mEventTrigger, EventTriggerType.PointerEnter, ItOnMouseEnter);`
`169`	`172`	`JCS_UIUtil.AddEventTriggerEvent(mEventTrigger, EventTriggerType.PointerExit, ItOnMouseExit);`
`170`	`173`	`JCS_UIUtil.AddEventTriggerEvent(mEventTrigger, EventTriggerType.PointerDown, ItOnMouseDown);`
`171`	`174`	`JCS_UIUtil.AddEventTriggerEvent(mEventTrigger, EventTriggerType.PointerUp, ItOnMouseUp);`
`@@ -181,26 +184,17 @@ private void Update()`
`181`	`184`	`private void HandleDoubleClick()`
`182`	`185`	`{`
`183`	`186`	`// IMPORTANT(JenChieh): only double click need update`
`184`		`- if (!mIsOver)`
`185`		`- return;`
`186`		`-`
`187`		`- if (mBtn == null)`
	`187`	`+ if (mBtn == null \|\| !mIsEntered)`
`188`	`188`	`return;`
`189`	`189`
`190`	`190`	`if (JCS_Input.OnMouseDoubleClick(0))`
`191`	`191`	`{`
`192`		`- // either time is out or double click,`
`193`		`- // both are all over the "double click event".`
`194`		`- mIsOver = false;`
`195`		`-`
`196`	`192`	`if (!mBtn.interactable)`
`197`	`193`	`{`
`198`	`194`	`// play not ineractable sound`
`199`	`195`	`mSoundPlayer.PlayOneShotByMethod(`
`200`	`196`	`mOnMouseDoubleClickRefuseSound,`
`201`	`197`	`mOnMouseDoubleClickRefuseSoundMethod);`
`202`		`-`
`203`		`- return;`
`204`	`198`	`}`
`205`	`199`	`else`
`206`	`200`	`{`
`@@ -210,18 +204,16 @@ private void HandleDoubleClick()`
`210`	`204`	`mOnMouseDoubleClickSoundMethod);`
`211`	`205`	`}`
`212`	`206`	`}`
`213`		`-`
`214`		`- // check if the mouse still over or not`
`215`		`- if (!JCS_UIUtil.MouseOverGUI(mRectTransform))`
`216`		`- mIsOver = false;`
`217`	`207`	`}`
`218`	`208`
`219`		`- public void ItOnMouseOver()`
	`209`	`+ public void ItOnMouseEnter()`
`220`	`210`	`{`
`221`		`- ItOnMouseOver(null);`
	`211`	`+ ItOnMouseEnter(null);`
`222`	`212`	`}`
`223`		`- public void ItOnMouseOver(PointerEventData data)`
	`213`	`+ public void ItOnMouseEnter(PointerEventData data)`
`224`	`214`	`{`
	`215`	`+ mIsEntered = true;`
	`216`	`+`
`225`	`217`	`if (mBtn != null)`
`226`	`218`	`{`
`227`	`219`	`if (!mBtn.interactable)`
`@@ -245,6 +237,8 @@ public void ItOnMouseExit()`
`245`	`237`	`}`
`246`	`238`	`public void ItOnMouseExit(PointerEventData data)`
`247`	`239`	`{`
	`240`	`+ mIsEntered = false;`
	`241`	`+`
`248`	`242`	`if (mBtn == null)`
`249`	`243`	`return;`
`250`	`244`
`@@ -269,7 +263,7 @@ public void ItOnMouseDown()`
`269`	`263`	`}`
`270`	`264`	`public void ItOnMouseDown(PointerEventData data)`
`271`	`265`	`{`
`272`		`- if (mBtn == null)`
	`266`	`+ if (mBtn == null \|\| !mIsEntered)`
`273`	`267`	`return;`
`274`	`268`
`275`	`269`	`if (!mBtn.interactable)`
`@@ -294,7 +288,7 @@ public void ItOnMouseUp()`
`294`	`288`	`}`
`295`	`289`	`public void ItOnMouseUp(PointerEventData data)`
`296`	`290`	`{`
`297`		`- if (mBtn == null)`
	`291`	`+ if (mBtn == null \|\| !mIsEntered)`
`298`	`292`	`return;`
`299`	`293`
`300`	`294`	`if (!mBtn.interactable)`
`@@ -335,15 +329,5 @@ public void ItOnMouseClick(PointerEventData data)`
`335`	`329`	`mOnMouseClickSoundMethod);`
`336`	`330`	`}`
`337`	`331`	`}`
`338`		`-`
`339`		`- // plz put this in Pointer Enter event`
`340`		`- public void ItOnMouseDoubleClick()`
`341`		`- {`
`342`		`- ItOnMouseDoubleClick(null);`
`343`		`- }`
`344`		`- public void ItOnMouseDoubleClick(PointerEventData data)`
`345`		`- {`
`346`		`- mIsOver = true;`
`347`		`- }`
`348`	`332`	`}`
`349`	`333`	`}`
Original file line number	Diff line number	Diff line change
`@@ -138,11 +138,9 @@ private void Start()`
`138`	`138`	`/// </summary>`
`139`	`139`	`public void DoSelection()`
`140`	`140`	`{`
`141`		`- if (mButton != null)`
`142`		`- mButton.ButtonClick();`
	`141`	`+ mButton?.InterBtnClick();`
`143`	`142`
`144`		`- if (mSelectedEvent != null)`
`145`		`- mSelectedEvent.Invoke();`
	`143`	`+ mSelectedEvent?.Invoke();`
`146`	`144`	`}`
`147`	`145`
`148`	`146`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -258,15 +258,17 @@ static bool OnMouseDoubleClick(int button)`
`258`	`258`	`// Check first click`
`259`	`259`	`if (!CLICK)`
`260`	`260`	`{`
`261`		`- if (GetMouseButtonDown(button))`
	`261`	`+ if (GetMouseButtonUp(button))`
`262`	`262`	`CLICK = true;`
`263`	`263`	`}`
`264`	`264`	`// Check double click`
`265`	`265`	`else`
`266`	`266`	`{`
`267`		`- if (GetMouseButtonDown(button))`
	`267`	`+ if (GetMouseButtonUp(button))`
`268`	`268`	`{`
`269`	`269`	`CLICK = false;`
	`270`	`+ CLICK_TIMER = 0.0f;`
	`271`	`+`
`270`	`272`	`return true;`
`271`	`273`	`}`
`272`	`274`	`}`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ private void Start()`
`69`	`69`	`/// <summary>`
`70`	`70`	`/// Override`
`71`	`71`	`/// </summary>`
`72`		`- public override void ButtonClick()`
	`72`	`+ public override void InterBtnClick()`
`73`	`73`	`{`
`74`	`74`	`if (mRollBtnSelector == null)`
`75`	`75`	`{`
`@@ -84,7 +84,7 @@ public override void ButtonClick()`
`84`	`84`	`}`
`85`	`85`	`else`
`86`	`86`	`{`
`87`		`- base.ButtonClick();`
	`87`	`+ base.InterBtnClick();`
`88`	`88`	`}`
`89`	`89`	`}`
`90`	`90`
`@@ -146,7 +146,7 @@ private void OverwriteAllButton()`
`146`	`146`	`mButton.onClick.RemoveAllListeners();`
`147`	`147`
`148`	`148`	`// only add this listener`
`149`		`- mButton.onClick.AddListener(ButtonClick);`
	`149`	`+ mButton.onClick.AddListener(InterBtnClick);`
`150`	`150`
`151`	`151`	`// get all the buttons on this transform`
`152`	`152`	`btns = GetComponents<JCS_Button>();`
`@@ -171,8 +171,8 @@ private void ActiveAllOtherButtons()`
`171`	`171`	`// don't call if is itself`
`172`	`172`	`if (b == this)`
`173`	`173`	`continue;`
`174`		`-`
`175`		`- b.ButtonClick();`
	`174`	`+`
	`175`	`+ b.InterBtnClick();`
`176`	`176`	`}`
`177`	`177`	`}`
`178`	`178`	`}`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ protected virtual void Update()`
`85`	`85`	`{`
`86`	`86`	`if (JCS_Input.IsAnyKeyBuffer(mKeyActionType))`
`87`	`87`	`{`
`88`		`- ButtonClick();`
	`88`	`+ InterBtnClick();`
`89`	`89`	`PlayButtonClickSound();`
`90`	`90`	`}`
`91`	`91`	`}`
`@@ -97,7 +97,7 @@ protected virtual void Update()`
`97`	`97`	`// listen to game pad.`
`98`	`98`	`JCS_Input.GetJoystickKeyByAction(mKeyActionType, mJoystickLitener, mJKeyToListen))`
`99`	`99`	`{`
`100`		`- ButtonClick();`
	`100`	`+ InterBtnClick();`
`101`	`101`	`PlayButtonClickSound();`
`102`	`102`	`}`
`103`	`103`	`}`