Merge pull request #13539 from peppy/improve-updateable-avatar-tooltip-handling

Fix edges of participant tiles showing incorrect tooltip

osu.Game/Overlays/BeatmapSet/AuthorInfo.cs

@@ -53,9 +53,8 @@ namespace osu.Game.Overlays.BeatmapSet
                     AutoSizeAxes = Axes.Both,
                     CornerRadius = 4,
                     Masking = true,
-                    Child = avatar = new UpdateableAvatar
+                    Child = avatar = new UpdateableAvatar(showGuestOnNull: false)
                     {
-                        ShowGuestOnNull = false,
                         Size = new Vector2(height),
                     },
                     EdgeEffect = new EdgeEffectParameters

osu.Game/Overlays/BeatmapSet/Scores/TopScoreUserSection.cs

@@ -61,7 +61,7 @@ namespace osu.Game.Overlays.BeatmapSet.Scores
                             },
                         }
                     },
-                    avatar = new UpdateableAvatar
+                    avatar = new UpdateableAvatar(showGuestOnNull: false)
                     {
                         Anchor = Anchor.Centre,
                         Origin = Anchor.Centre,
@@ -75,7 +75,6 @@ namespace osu.Game.Overlays.BeatmapSet.Scores
                             Offset = new Vector2(0, 2),
                             Radius = 1,
                         },
-                        ShowGuestOnNull = false,
                     },
                     new FillFlowContainer
                     {

osu.Game/Overlays/Chat/Tabs/PrivateChannelTabItem.cs

@@ -51,7 +51,7 @@ namespace osu.Game.Overlays.Chat.Tabs
                             Child = new DelayedLoadWrapper(avatar = new ClickableAvatar(value.Users.First())
                             {
                                 RelativeSizeAxes = Axes.Both,
-                                OpenOnClick = { Value = false },
+                                OpenOnClick = false,
                             })
                             {
                                 RelativeSizeAxes = Axes.Both,

osu.Game/Overlays/Profile/Header/TopHeaderContainer.cs

@@ -58,13 +58,11 @@ namespace osu.Game.Overlays.Profile.Header
                     Origin = Anchor.CentreLeft,
                     Children = new Drawable[]
                     {
-                        avatar = new UpdateableAvatar
+                        avatar = new UpdateableAvatar(openOnClick: false, showGuestOnNull: false)
                         {
                             Size = new Vector2(avatar_size),
                             Masking = true,
                             CornerRadius = avatar_size * 0.25f,
-                            OpenOnClick = { Value = false },
-                            ShowGuestOnNull = false,
                         },
                         new Container
                         {

osu.Game/Overlays/Toolbar/ToolbarUserButton.cs

@@ -32,14 +32,13 @@ namespace osu.Game.Overlays.Toolbar
 
             Add(new OpaqueBackground { Depth = 1 });
 
-            Flow.Add(avatar = new UpdateableAvatar
+            Flow.Add(avatar = new UpdateableAvatar(openOnClick: false)
             {
                 Masking = true,
                 Size = new Vector2(32),
                 Anchor = Anchor.CentreLeft,
                 Origin = Anchor.CentreLeft,
                 CornerRadius = 4,
-                OpenOnClick = { Value = false },
                 EdgeEffect = new EdgeEffectParameters
                 {
                     Type = EdgeEffectType.Shadow,

osu.Game/Screens/OnlinePlay/Components/ParticipantsList.cs

@@ -5,7 +5,6 @@ using osu.Framework.Allocation;
 using osu.Framework.Extensions.Color4Extensions;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
-using osu.Framework.Graphics.Cursor;
 using osu.Framework.Graphics.Shapes;
 using osu.Framework.Threading;
 using osu.Game.Users;
@@ -91,7 +90,7 @@ namespace osu.Game.Screens.OnlinePlay.Components
             });
         }
 
-        private class UserTile : CompositeDrawable, IHasTooltip
+        private class UserTile : CompositeDrawable
         {
             public User User
             {
@@ -99,8 +98,6 @@ namespace osu.Game.Screens.OnlinePlay.Components
                 set => avatar.User = value;
             }
 
-            public string TooltipText => User?.Username ?? string.Empty;
-
             private readonly UpdateableAvatar avatar;
 
             public UserTile()
@@ -116,7 +113,7 @@ namespace osu.Game.Screens.OnlinePlay.Components
                         RelativeSizeAxes = Axes.Both,
                         Colour = Color4Extensions.FromHex(@"27252d"),
                     },
-                    avatar = new UpdateableAvatar { RelativeSizeAxes = Axes.Both },
+                    avatar = new UpdateableAvatar(showUsernameTooltip: true) { RelativeSizeAxes = Axes.Both },
                 };
             }
         }

osu.Game/Users/Drawables/ClickableAvatar.cs

@@ -2,7 +2,6 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using osu.Framework.Allocation;
-using osu.Framework.Bindables;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Textures;
@@ -13,16 +12,32 @@ namespace osu.Game.Users.Drawables
 {
     public class ClickableAvatar : Container
     {
+        private const string default_tooltip_text = "view profile";
+
         /// <summary>
         /// Whether to open the user's profile when clicked.
         /// </summary>
-        public readonly BindableBool OpenOnClick = new BindableBool(true);
+        public bool OpenOnClick
+        {
+            set => clickableArea.Enabled.Value = value;
+        }
+
+        /// <summary>
+        /// By default, the tooltip will show "view profile" as avatars are usually displayed next to a username.
+        /// Setting this to <c>true</c> exposes the username via tooltip for special cases where this is not true.
+        /// </summary>
+        public bool ShowUsernameTooltip
+        {
+            set => clickableArea.TooltipText = value ? (user?.Username ?? string.Empty) : default_tooltip_text;
+        }
 
         private readonly User user;
 
         [Resolved(CanBeNull = true)]
         private OsuGame game { get; set; }
 
+        private readonly ClickableArea clickableArea;
+
         /// <summary>
         /// A clickable avatar for the specified user, with UI sounds included.
         /// If <see cref="OpenOnClick"/> is <c>true</c>, clicking will open the user's profile.
@@ -31,35 +46,35 @@ namespace osu.Game.Users.Drawables
         public ClickableAvatar(User user = null)
         {
             this.user = user;
-        }
 
-        [BackgroundDependencyLoader]
-        private void load(LargeTextureStore textures)
-        {
-            ClickableArea clickableArea;
             Add(clickableArea = new ClickableArea
             {
                 RelativeSizeAxes = Axes.Both,
                 Action = openProfile
             });
+        }
 
+        [BackgroundDependencyLoader]
+        private void load(LargeTextureStore textures)
+        {
             LoadComponentAsync(new DrawableAvatar(user), clickableArea.Add);
-
-            clickableArea.Enabled.BindTo(OpenOnClick);
         }
 
         private void openProfile()
         {
-            if (!OpenOnClick.Value)
-                return;
-
             if (user?.Id > 1)
                 game?.ShowUser(user.Id);
         }
 
         private class ClickableArea : OsuClickableContainer
         {
-            public override string TooltipText => Enabled.Value ? @"view profile" : null;
+            private string tooltip = default_tooltip_text;
+
+            public override string TooltipText
+            {
+                get => Enabled.Value ? tooltip : null;
+                set => tooltip = value;
+            }
 
             protected override bool OnClick(ClickEvent e)
             {

osu.Game/Users/Drawables/UpdateableAvatar.cs

@@ -1,7 +1,6 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-using osu.Framework.Bindables;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.Effects;
@@ -45,33 +44,38 @@ namespace osu.Game.Users.Drawables
 
         protected override double LoadDelay => 200;
 
-        /// <summary>
+        private readonly bool openOnClick;
-        /// Whether to show a default guest representation on null user (as opposed to nothing).
+        private readonly bool showUsernameTooltip;
-        /// </summary>
+        private readonly bool showGuestOnNull;
-        public bool ShowGuestOnNull = true;
 
         /// <summary>
-        /// Whether to open the user's profile when clicked.
+        /// Construct a new UpdateableAvatar.
         /// </summary>
-        public readonly BindableBool OpenOnClick = new BindableBool(true);
+        /// <param name="user">The initial user to display.</param>
-
+        /// <param name="openOnClick">Whether to open the user's profile when clicked.</param>
-        public UpdateableAvatar(User user = null)
+        /// <param name="showUsernameTooltip">Whether to show the username rather than "view profile" on the tooltip.</param>
+        /// <param name="showGuestOnNull">Whether to show a default guest representation on null user (as opposed to nothing).</param>
+        public UpdateableAvatar(User user = null, bool openOnClick = true, bool showUsernameTooltip = false, bool showGuestOnNull = true)
         {
+            this.openOnClick = openOnClick;
+            this.showUsernameTooltip = showUsernameTooltip;
+            this.showGuestOnNull = showGuestOnNull;
+
             User = user;
         }
 
         protected override Drawable CreateDrawable(User user)
         {
-            if (user == null && !ShowGuestOnNull)
+            if (user == null && !showGuestOnNull)
                 return null;
 
             var avatar = new ClickableAvatar(user)
             {
+                OpenOnClick = openOnClick,
+                ShowUsernameTooltip = showUsernameTooltip,
                 RelativeSizeAxes = Axes.Both,
             };
 
-            avatar.OpenOnClick.BindTo(OpenOnClick);
-
             return avatar;
         }
     }

osu.Game/Users/ExtendedUserPanel.cs

@@ -48,11 +48,7 @@ namespace osu.Game.Users
             statusIcon.FinishTransforms();
         }
 
-        protected UpdateableAvatar CreateAvatar() => new UpdateableAvatar
+        protected UpdateableAvatar CreateAvatar() => new UpdateableAvatar(User, false);
-        {
-            User = User,
-            OpenOnClick = { Value = false }
-        };
 
         protected UpdateableFlag CreateFlag() => new UpdateableFlag(User.Country)
         {