h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2025-02-21 20:53:04 +08:00
Code Issues Releases Wiki Activity

Add some xmldocs

Browse Source
This commit is contained in:
smoogipoo 2021-04-09 18:29:02 +09:00
parent e73f3f52d7
commit 7cbc8f2695
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
osu.Game/Screens/Play/HUD/MultiplayerGameplayLeaderboard.cs
View File

@ -121,8 +121,21 @@ namespace osu.Game.Screens.Play.HUD
OnIncomingFrames(userId, bundle); OnIncomingFrames(userId, bundle);
}); });
/// <summary>
/// Invoked when new frames have arrived for a user.
/// </summary>
/// <remarks>
/// By default, this immediately sets the current frame to be displayed for the user.
/// </remarks>
/// <param name="userId">The user which the frames arrived for.</param>
/// <param name="bundle">The bundle of frames.</param>
protected virtual void OnIncomingFrames(int userId, FrameDataBundle bundle) => SetCurrentFrame(userId, bundle.Header); protected virtual void OnIncomingFrames(int userId, FrameDataBundle bundle) => SetCurrentFrame(userId, bundle.Header);
/// <summary>
/// Sets the current frame to be displayed for a user.
/// </summary>
/// <param name="userId">The user to set the frame of.</param>
/// <param name="header">The frame to set.</param>
protected void SetCurrentFrame(int userId, FrameHeader header) protected void SetCurrentFrame(int userId, FrameHeader header)
{ {
var trackedScore = userScores[userId]; var trackedScore = userScores[userId];