ClickableText changes

osu.Game.Tests/Visual/TestCaseClickableText.cs

@@ -0,0 +1,70 @@
+// Copyright (c) 2007-2018 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
+
+using OpenTK;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Game.Graphics.UserInterface;
+using System;
+using System.Collections.Generic;
+
+namespace osu.Game.Tests.Visual
+{
+    public class TestCaseClickableText : OsuTestCase
+    {
+        public override IReadOnlyList<Type> RequiredTypes => new[] {
+            typeof(ClickableText),
+            typeof(FillFlowContainer<ClickableText>)
+        };
+
+        public TestCaseClickableText()
+        {
+            ClickableText text;
+
+            Add(new FillFlowContainer<ClickableText>
+            {
+                Spacing = new Vector2(10),
+                RelativeSizeAxes = Axes.Both,
+                Anchor = Anchor.Centre,
+                Origin = Anchor.Centre,
+                Children = new[]
+                {
+                    new ClickableText
+                    {
+                        Text = "Default",
+                    },
+                    new ClickableText
+                    {
+                        IsEnabled = false,
+                        Text = "Disabled",
+                    },
+                    new ClickableText
+                    {
+                        Text = "Without sounds",
+                        IsMuted = true,
+                    },
+                    new ClickableText
+                    {
+                        Text = "Without click sounds",
+                        IsClickMuted = true,
+                    },
+                    new ClickableText
+                    {
+                        Text = "Without hover sounds",
+                        IsHoverMuted = true,
+                    },
+                    text = new ClickableText
+                    {
+                        Text = "Disables after click (Action)",
+                    },
+                    new ClickableText
+                    {
+                        Text = "Has tooltip",
+                        TooltipText = "Yep",
+                    },
+                },
+            });
+            text.Action = () => text.IsEnabled = false;
+        }
+    }
+}

osu.Game/Graphics/UserInterface/ClickableText.cs

@@ -1,44 +1,81 @@
 // Copyright (c) 2007-2018 ppy Pty Ltd <contact@ppy.sh>.
 // Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
 
-using OpenTK.Graphics;
 using osu.Framework.Allocation;
 using osu.Framework.Audio;
 using osu.Framework.Audio.Sample;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Cursor;
-using osu.Framework.Graphics.Shapes;
-using osu.Framework.Graphics.Sprites;
 using osu.Framework.Input;
+using osu.Game.Graphics.Sprites;
 using System;
 
 namespace osu.Game.Graphics.UserInterface
-{
+{/// <summary>
-    public class ClickableText : SpriteText, IHasTooltip
+/// 
+/// </summary>
+    public class ClickableText : OsuSpriteText, IHasTooltip
     {
         private bool isEnabled;
+        private bool isMuted;
         private SampleChannel sampleHover;
         private SampleChannel sampleClick;
 
+        /// <summary>
+        /// An action that can be set to execute after click.
+        /// </summary>
         public Action Action;
 
+        /// <summary>
+        /// If set to true, a sound will be played on click.
+        /// </summary>
+        public bool IsClickMuted;
+
+        /// <summary>
+        /// If set to true, a sound will be played on hover.
+        /// </summary>
+        public bool IsHoverMuted;
+
+        /// <summary>
+        /// If disabled, no sounds will be played and <see cref="Action"/> wont execute.
+        /// True by default.
+        /// </summary>
         public bool IsEnabled
         {
             get { return isEnabled; }
             set
             {
                 isEnabled = value;
-                Alpha = value ? 1 : 0.5f;
+                this.FadeTo(value ? 1 : 0.5f, 250);
             }
         }
 
+        /// <summary>
+        /// Whether to play sounds on hover and click. Automatically sets
+        /// <see cref="IsClickMuted"/> and <see cref="IsHoverMuted"/> to the same value.>
+        /// </summary>
+        public bool IsMuted {
+            get { return isMuted; }
+            set
+            {
+                IsHoverMuted = value;
+                IsClickMuted = value;
+                isMuted = value;
+            }
+        }
+
+        /// <summary>
+        /// A text with sounds on hover and click,
+        /// an action that can be set to execute on click,
+        /// and a tooltip.
+        /// </summary>
         public ClickableText() => isEnabled = true;
 
         public override bool HandleMouseInput => true;
 
         protected override bool OnHover(InputState state)
         {
-            if (isEnabled)
+            if (isEnabled && !IsHoverMuted)
                 sampleHover?.Play();
             return base.OnHover(state);
         }
@@ -47,7 +84,8 @@ namespace osu.Game.Graphics.UserInterface
         {
             if (isEnabled)
             {
-                sampleClick?.Play();
+                if (!IsClickMuted)
+                    sampleClick?.Play();
                 Action?.Invoke();
             }
             return base.OnClick(state);
@@ -58,6 +96,7 @@ namespace osu.Game.Graphics.UserInterface
         [BackgroundDependencyLoader]
         private void load(AudioManager audio)
         {
+            sampleClick = audio.Sample.Get(@"UI/generic-select-soft");
             sampleHover = audio.Sample.Get(@"UI/generic-hover-soft");
         }
     }