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

Improve UsernameColour documentation

Browse Source
This commit is contained in:
Bartłomiej Dach 2023-06-18 18:37:28 +02:00
parent bd174b5193
commit dad32817ee
No known key found for this signature in database
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
osu.Game/Overlays/Chat/ChatLine.cs
View File

@ -70,8 +70,16 @@ namespace osu.Game.Overlays.Chat
private Container? highlight;
/// <summary>
/// if set, it will override <see cref="APIUser.Colour"/> or <see cref="default_colours"/>.
/// The colour to use to paint the chat mesasge author's username.
/// </summary>
/// <remarks>
/// The colour can be set explicitly by consumers via the property initialiser.
/// If unspecified, the colour is by default initialised to:
/// <list type="bullet">
/// <item><see cref="APIUser.Colour">message.Sender.Colour</see>, if non-empty,</item>
/// <item>a random colour from <see cref="default_colours"/> if the above is empty.</item>
/// </list>
/// </remarks>
public Color4 UsernameColour { get; init; }
public ChatLine(Message message)
@ -81,7 +89,8 @@ namespace osu.Game.Overlays.Chat
RelativeSizeAxes = Axes.X;
AutoSizeAxes = Axes.Y;
// If we have custom value, this value will be override.
// initialise using sane defaults.
// consumers can use the initialiser of `UsernameColour` to override this if they wish to.
UsernameColour = !string.IsNullOrEmpty(message.Sender.Colour)
? Color4Extensions.FromHex(message.Sender.Colour)
: default_colours[message.SenderId % default_colours.Length];