h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2024-12-14 14:32:55 +08:00
Code Issues Releases Wiki Activity

Refactor message highlighting logic to rely on a Channel data bindable

Browse Source
This commit is contained in:
Salman Ahmed 2022-03-08 03:19:35 +03:00
parent 5764c53c17
commit 7f47be4680
4 changed files with 63 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
osu.Game.Tests/Visual/Online/TestSceneStandAloneChatDisplay.cs
View File

@ -152,7 +152,7 @@ namespace osu.Game.Tests.Visual.Online
AddStep("highlight first message", () =>
{
highlighted = testChannel.Messages[0];
chatDisplay.DrawableChannel.HighlightMessage(highlighted);
chatDisplay.DrawableChannel.Channel.HighlightedMessage.Value = highlighted;
});
AddUntilStep("chat scrolled to first message", () =>
@ -167,7 +167,7 @@ namespace osu.Game.Tests.Visual.Online
AddStep("highlight last message", () =>
{
highlighted = testChannel.Messages[^1];
chatDisplay.DrawableChannel.HighlightMessage(highlighted);
chatDisplay.DrawableChannel.Channel.HighlightedMessage.Value = highlighted;
});
AddUntilStep("chat scrolled to last message", () =>
@ -182,7 +182,7 @@ namespace osu.Game.Tests.Visual.Online
AddRepeatStep("highlight other random messages", () =>
{
highlighted = testChannel.Messages[RNG.Next(0, testChannel.Messages.Count - 1)];
chatDisplay.DrawableChannel.HighlightMessage(highlighted);
chatDisplay.DrawableChannel.Channel.HighlightedMessage.Value = highlighted;
}, 10);
}
@ -193,7 +193,7 @@ namespace osu.Game.Tests.Visual.Online
AddRepeatStep("highlight random messages", () =>
{
chatDisplay.DrawableChannel.HighlightMessage(testChannel.Messages[RNG.Next(0, testChannel.Messages.Count - 1)]);
chatDisplay.DrawableChannel.Channel.HighlightedMessage.Value = testChannel.Messages[RNG.Next(0, testChannel.Messages.Count - 1)];
}, 10);
}

7
osu.Game/Online/Chat/Channel.cs
View File

@ -9,6 +9,7 @@ using Newtonsoft.Json;
using osu.Framework.Bindables;
using osu.Framework.Lists;
using osu.Game.Online.API.Requests.Responses;
using osu.Game.Overlays.Chat;
namespace osu.Game.Online.Chat
{
@ -89,6 +90,12 @@ namespace osu.Game.Online.Chat
/// </summary>
public Bindable<bool> Joined = new Bindable<bool>();
/// <summary>
/// Signals if there is a message to highlight.
/// This is automatically cleared by the associated <see cref="DrawableChannel"/> after highlighting.
/// </summary>
public Bindable<Message> HighlightedMessage = new Bindable<Message>();
[JsonConstructor]
public Channel()
{

87
osu.Game/Overlays/Chat/DrawableChannel.cs
View File

@ -6,6 +6,7 @@ using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using osu.Framework.Allocation;
using osu.Framework.Bindables;
using osu.Framework.Extensions.Color4Extensions;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
@ -48,6 +49,8 @@ namespace osu.Game.Overlays.Chat
RelativeSizeAxes = Axes.Both;
}
private Bindable<Message> highlightedMessage;
[BackgroundDependencyLoader]
private void load()
{
@ -71,36 +74,36 @@ namespace osu.Game.Overlays.Chat
}
},
};
}
newMessagesArrived(Channel.Messages);
protected override void LoadComplete()
{
base.LoadComplete();
addChatLines(Channel.Messages);
Channel.NewMessagesArrived += newMessagesArrived;
Channel.MessageRemoved += messageRemoved;
Channel.PendingMessageResolved += pendingMessageResolved;
}
/// <summary>
/// Highlights a specific message in this drawable channel.
/// </summary>
/// <param name="message">The message to highlight.</param>
public void HighlightMessage(Message message)
highlightedMessage = Channel.HighlightedMessage.GetBoundCopy();
highlightedMessage.BindValueChanged(m =>
{
if (IsLoaded)
highlightMessage(message);
else
Schedule(highlightMessage, message);
}
private void highlightMessage(Message message)
{
var chatLine = chatLines.SingleOrDefault(c => c.Message == message);
if (chatLine == null)
if (m.NewValue == null)
return;
var chatLine = chatLines.SingleOrDefault(c => c.Message == m.NewValue);
if (chatLine != null)
{
scroll.ScrollIntoView(chatLine);
chatLine.ScheduleHighlight();
}
highlightedMessage.Value = null;
}, true);
}
protected override void Dispose(bool isDisposing)
{
base.Dispose(isDisposing);
@ -118,18 +121,39 @@ namespace osu.Game.Overlays.Chat
Colour = colours.ChatBlue.Lighten(0.7f),
};
private void newMessagesArrived(IEnumerable<Message> newMessages) => Schedule(() =>
private void newMessagesArrived(IEnumerable<Message> newMessages) => Schedule(addChatLines, newMessages);
private void pendingMessageResolved(Message existing, Message updated) => Schedule(() =>
{
if (newMessages.Min(m => m.Id) < chatLines.Max(c => c.Message.Id))
var found = chatLines.LastOrDefault(c => c.Message == existing);
if (found != null)
{
Trace.Assert(updated.Id.HasValue, "An updated message was returned with no ID.");
ChatLineFlow.Remove(found);
found.Message = updated;
ChatLineFlow.Add(found);
}
});
private void messageRemoved(Message removed) => Schedule(() =>
{
chatLines.FirstOrDefault(c => c.Message == removed)?.FadeColour(Color4.Red, 400).FadeOut(600).Expire();
});
private void addChatLines(IEnumerable<Message> messages)
{
if (messages.Min(m => m.Id) < chatLines.Max(c => c.Message.Id))
{
// there is a case (on initial population) that we may receive past messages and need to reorder.
// easiest way is to just combine messages and recreate drawables (less worrying about day separators etc.)
newMessages = newMessages.Concat(chatLines.Select(c => c.Message)).OrderBy(m => m.Id).ToList();
messages = messages.Concat(chatLines.Select(c => c.Message)).OrderBy(m => m.Id).ToList();
ChatLineFlow.Clear();
}
// Add up to last Channel.MAX_HISTORY messages
var displayMessages = newMessages.Skip(Math.Max(0, newMessages.Count() - Channel.MAX_HISTORY));
var displayMessages = messages.Skip(Math.Max(0, messages.Count() - Channel.MAX_HISTORY));
Message lastMessage = chatLines.LastOrDefault()?.Message;
@ -168,28 +192,9 @@ namespace osu.Game.Overlays.Chat
// due to the scroll adjusts from old messages removal above, a scroll-to-end must be enforced,
// to avoid making the container think the user has scrolled back up and unwantedly disable auto-scrolling.
if (newMessages.Any(m => m is LocalMessage))
if (messages.Any(m => m is LocalMessage))
scroll.ScrollToEnd();
});
private void pendingMessageResolved(Message existing, Message updated) => Schedule(() =>
{
var found = chatLines.LastOrDefault(c => c.Message == existing);
if (found != null)
{
Trace.Assert(updated.Id.HasValue, "An updated message was returned with no ID.");
ChatLineFlow.Remove(found);
found.Message = updated;
ChatLineFlow.Add(found);
}
});
private void messageRemoved(Message removed) => Schedule(() =>
{
chatLines.FirstOrDefault(c => c.Message == removed)?.FadeColour(Color4.Red, 400).FadeOut(600).Expire();
});
private IEnumerable<ChatLine> chatLines => ChatLineFlow.Children.OfType<ChatLine>();

33
osu.Game/Overlays/ChatOverlay.cs
View File

@ -4,7 +4,6 @@
using System.Collections.Generic;
using System.Collections.Specialized;
using System.Linq;
using JetBrains.Annotations;
using osuTK;
using osuTK.Graphics;
using osu.Framework.Allocation;
@ -47,8 +46,6 @@ namespace osu.Game.Overlays
private Container<DrawableChannel> currentChannelContainer;
private DrawableChannel currentDrawableChannel => currentChannelContainer.SingleOrDefault();
private readonly List<DrawableChannel> loadedChannels = new List<DrawableChannel>();
private LoadingSpinner loading;
@ -252,9 +249,6 @@ namespace osu.Game.Overlays
private Bindable<Channel> currentChannel;
[CanBeNull]
private Message messagePendingHighlight;
private void currentChannelChanged(ValueChangedEvent<Channel> e)
{
if (e.NewValue == null)
@ -296,24 +290,12 @@ namespace osu.Game.Overlays
currentChannelContainer.Clear(false);
currentChannelContainer.Add(loaded);
currentChannelContainer.FadeIn(500, Easing.OutQuint);
if (messagePendingHighlight != null)
{
tryHighlightMessage(messagePendingHighlight);
messagePendingHighlight = null;
}
});
}
else
{
currentChannelContainer.Clear(false);
currentChannelContainer.Add(loaded);
if (messagePendingHighlight != null)
{
tryHighlightMessage(messagePendingHighlight);
messagePendingHighlight = null;
}
}
// mark channel as read when channel switched
@ -327,21 +309,10 @@ namespace osu.Game.Overlays
/// <param name="message">The message to highlight.</param>
public void HighlightMessage(Message message)
{
if (currentDrawableChannel?.Channel.Id == message.ChannelId)
tryHighlightMessage(message);
else
{
messagePendingHighlight = message;
if (currentChannel.Value.Id != message.ChannelId)
currentChannel.Value = channelManager.JoinedChannels.Single(c => c.Id == message.ChannelId);
}
}
private void tryHighlightMessage(Message message)
{
if (message.ChannelId != currentDrawableChannel.Channel.Id)
return;
currentDrawableChannel.HighlightMessage(message);
currentChannel.Value.HighlightedMessage.Value = message;
}
private float startDragChatHeight;