mirror of
https://github.com/ppy/osu
synced 2024-12-13 10:28:17 +00:00
366 lines
12 KiB
C#
366 lines
12 KiB
C#
// 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 System;
|
|
using System.Collections.Generic;
|
|
using System.Linq;
|
|
using System.Threading;
|
|
using osu.Framework.Allocation;
|
|
using osu.Framework.Extensions.Color4Extensions;
|
|
using osu.Framework.Graphics;
|
|
using osu.Framework.Graphics.Colour;
|
|
using osu.Framework.Graphics.Containers;
|
|
using osu.Framework.Threading;
|
|
using osu.Game.Graphics.Containers;
|
|
using osu.Game.Graphics.UserInterface;
|
|
using osu.Game.Online.API;
|
|
using osu.Game.Online.Placeholders;
|
|
using osuTK;
|
|
using osuTK.Graphics;
|
|
|
|
namespace osu.Game.Online.Leaderboards
|
|
{
|
|
public abstract class Leaderboard<TScope, TScoreInfo> : Container, IOnlineComponent
|
|
{
|
|
private const double fade_duration = 300;
|
|
|
|
private readonly OsuScrollContainer scrollContainer;
|
|
private readonly Container placeholderContainer;
|
|
|
|
private FillFlowContainer<LeaderboardScore> scrollFlow;
|
|
|
|
private readonly LoadingAnimation loading;
|
|
|
|
private ScheduledDelegate showScoresDelegate;
|
|
private CancellationTokenSource showScoresCancellationSource;
|
|
|
|
private bool scoresLoadedOnce;
|
|
|
|
private readonly Container content;
|
|
|
|
protected override Container<Drawable> Content => content;
|
|
|
|
private IEnumerable<TScoreInfo> scores;
|
|
|
|
public IEnumerable<TScoreInfo> Scores
|
|
{
|
|
get => scores;
|
|
set
|
|
{
|
|
scores = value;
|
|
|
|
scoresLoadedOnce = true;
|
|
|
|
scrollFlow?.FadeOut(fade_duration, Easing.OutQuint).Expire();
|
|
scrollFlow = null;
|
|
|
|
loading.Hide();
|
|
|
|
showScoresDelegate?.Cancel();
|
|
showScoresCancellationSource?.Cancel();
|
|
|
|
if (scores == null || !scores.Any())
|
|
return;
|
|
|
|
// ensure placeholder is hidden when displaying scores
|
|
PlaceholderState = PlaceholderState.Successful;
|
|
|
|
var scoreFlow = CreateScoreFlow();
|
|
scoreFlow.ChildrenEnumerable = scores.Select((s, index) => CreateDrawableScore(s, index + 1));
|
|
|
|
// schedule because we may not be loaded yet (LoadComponentAsync complains).
|
|
showScoresDelegate = Schedule(() => LoadComponentAsync(scoreFlow, _ =>
|
|
{
|
|
scrollContainer.Add(scrollFlow = scoreFlow);
|
|
|
|
int i = 0;
|
|
|
|
foreach (var s in scrollFlow.Children)
|
|
{
|
|
using (s.BeginDelayedSequence(i++ * 50, true))
|
|
s.Show();
|
|
}
|
|
|
|
scrollContainer.ScrollTo(0f, false);
|
|
}, (showScoresCancellationSource = new CancellationTokenSource()).Token));
|
|
}
|
|
}
|
|
|
|
protected virtual FillFlowContainer<LeaderboardScore> CreateScoreFlow()
|
|
=> new FillFlowContainer<LeaderboardScore>
|
|
{
|
|
RelativeSizeAxes = Axes.X,
|
|
AutoSizeAxes = Axes.Y,
|
|
Spacing = new Vector2(0f, 5f),
|
|
Padding = new MarginPadding { Top = 10, Bottom = 5 },
|
|
};
|
|
|
|
private TScope scope;
|
|
|
|
public TScope Scope
|
|
{
|
|
get => scope;
|
|
set
|
|
{
|
|
if (EqualityComparer<TScope>.Default.Equals(value, scope))
|
|
return;
|
|
|
|
scope = value;
|
|
UpdateScores();
|
|
}
|
|
}
|
|
|
|
private PlaceholderState placeholderState;
|
|
|
|
/// <summary>
|
|
/// Update the placeholder visibility.
|
|
/// Setting this to anything other than PlaceholderState.Successful will cancel all existing retrieval requests and hide scores.
|
|
/// </summary>
|
|
protected PlaceholderState PlaceholderState
|
|
{
|
|
get => placeholderState;
|
|
set
|
|
{
|
|
if (value != PlaceholderState.Successful)
|
|
{
|
|
Reset();
|
|
}
|
|
|
|
if (value == placeholderState)
|
|
return;
|
|
|
|
switch (placeholderState = value)
|
|
{
|
|
case PlaceholderState.NetworkFailure:
|
|
replacePlaceholder(new RetrievalFailurePlaceholder
|
|
{
|
|
OnRetry = UpdateScores,
|
|
});
|
|
break;
|
|
|
|
case PlaceholderState.NoneSelected:
|
|
replacePlaceholder(new MessagePlaceholder(@"Please select a beatmap!"));
|
|
break;
|
|
|
|
case PlaceholderState.Unavailable:
|
|
replacePlaceholder(new MessagePlaceholder(@"Leaderboards are not available for this beatmap!"));
|
|
break;
|
|
|
|
case PlaceholderState.NoScores:
|
|
replacePlaceholder(new MessagePlaceholder(@"No records yet!"));
|
|
break;
|
|
|
|
case PlaceholderState.NotLoggedIn:
|
|
replacePlaceholder(new LoginPlaceholder(@"Please sign in to view online leaderboards!"));
|
|
break;
|
|
|
|
case PlaceholderState.NotSupporter:
|
|
replacePlaceholder(new MessagePlaceholder(@"Please invest in an osu!supporter tag to view this leaderboard!"));
|
|
break;
|
|
|
|
default:
|
|
replacePlaceholder(null);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
protected Leaderboard()
|
|
{
|
|
InternalChildren = new Drawable[]
|
|
{
|
|
new GridContainer
|
|
{
|
|
RelativeSizeAxes = Axes.Both,
|
|
RowDimensions = new[]
|
|
{
|
|
new Dimension(),
|
|
new Dimension(GridSizeMode.AutoSize),
|
|
},
|
|
Content = new[]
|
|
{
|
|
new Drawable[]
|
|
{
|
|
scrollContainer = new OsuScrollContainer
|
|
{
|
|
RelativeSizeAxes = Axes.Both,
|
|
ScrollbarVisible = false,
|
|
}
|
|
},
|
|
new Drawable[]
|
|
{
|
|
content = new Container
|
|
{
|
|
AutoSizeAxes = Axes.Y,
|
|
RelativeSizeAxes = Axes.X,
|
|
},
|
|
}
|
|
},
|
|
},
|
|
loading = new LoadingAnimation(),
|
|
placeholderContainer = new Container
|
|
{
|
|
RelativeSizeAxes = Axes.Both
|
|
},
|
|
};
|
|
}
|
|
|
|
protected virtual void Reset()
|
|
{
|
|
getScoresRequest?.Cancel();
|
|
getScoresRequest = null;
|
|
Scores = null;
|
|
}
|
|
|
|
private IAPIProvider api;
|
|
|
|
private ScheduledDelegate pendingUpdateScores;
|
|
|
|
[BackgroundDependencyLoader(true)]
|
|
private void load(IAPIProvider api)
|
|
{
|
|
this.api = api;
|
|
api?.Register(this);
|
|
}
|
|
|
|
protected override void Dispose(bool isDisposing)
|
|
{
|
|
base.Dispose(isDisposing);
|
|
api?.Unregister(this);
|
|
}
|
|
|
|
public void RefreshScores() => UpdateScores();
|
|
|
|
private APIRequest getScoresRequest;
|
|
|
|
protected abstract bool IsOnlineScope { get; }
|
|
|
|
public void APIStateChanged(IAPIProvider api, APIState state)
|
|
{
|
|
switch (state)
|
|
{
|
|
case APIState.Online:
|
|
case APIState.Offline:
|
|
if (IsOnlineScope)
|
|
UpdateScores();
|
|
|
|
break;
|
|
}
|
|
}
|
|
|
|
protected void UpdateScores()
|
|
{
|
|
// don't display any scores or placeholder until the first Scores_Set has been called.
|
|
// this avoids scope changes flickering a "no scores" placeholder before initialisation of song select is finished.
|
|
if (!scoresLoadedOnce) return;
|
|
|
|
getScoresRequest?.Cancel();
|
|
getScoresRequest = null;
|
|
|
|
pendingUpdateScores?.Cancel();
|
|
pendingUpdateScores = Schedule(() =>
|
|
{
|
|
PlaceholderState = PlaceholderState.Retrieving;
|
|
loading.Show();
|
|
|
|
getScoresRequest = FetchScores(scores => Schedule(() =>
|
|
{
|
|
Scores = scores;
|
|
PlaceholderState = Scores.Any() ? PlaceholderState.Successful : PlaceholderState.NoScores;
|
|
}));
|
|
|
|
if (getScoresRequest == null)
|
|
return;
|
|
|
|
getScoresRequest.Failure += e => Schedule(() =>
|
|
{
|
|
if (e is OperationCanceledException)
|
|
return;
|
|
|
|
PlaceholderState = PlaceholderState.NetworkFailure;
|
|
});
|
|
|
|
api.Queue(getScoresRequest);
|
|
});
|
|
}
|
|
|
|
/// <summary>
|
|
/// Performs a fetch/refresh of scores to be displayed.
|
|
/// </summary>
|
|
/// <param name="scoresCallback">A callback which should be called when fetching is completed. Scheduling is not required.</param>
|
|
/// <returns>An <see cref="APIRequest"/> responsible for the fetch operation. This will be queued and performed automatically.</returns>
|
|
protected abstract APIRequest FetchScores(Action<IEnumerable<TScoreInfo>> scoresCallback);
|
|
|
|
private Placeholder currentPlaceholder;
|
|
|
|
private void replacePlaceholder(Placeholder placeholder)
|
|
{
|
|
if (placeholder != null && placeholder.Equals(currentPlaceholder))
|
|
return;
|
|
|
|
currentPlaceholder?.FadeOut(150, Easing.OutQuint).Expire();
|
|
|
|
if (placeholder == null)
|
|
{
|
|
currentPlaceholder = null;
|
|
return;
|
|
}
|
|
|
|
placeholderContainer.Child = placeholder;
|
|
|
|
placeholder.ScaleTo(0.8f).Then().ScaleTo(1, fade_duration * 3, Easing.OutQuint);
|
|
placeholder.FadeInFromZero(fade_duration, Easing.OutQuint);
|
|
|
|
currentPlaceholder = placeholder;
|
|
}
|
|
|
|
protected virtual bool FadeBottom => true;
|
|
protected virtual bool FadeTop => false;
|
|
|
|
protected override void UpdateAfterChildren()
|
|
{
|
|
base.UpdateAfterChildren();
|
|
|
|
var fadeBottom = scrollContainer.Current + scrollContainer.DrawHeight;
|
|
var fadeTop = scrollContainer.Current + LeaderboardScore.HEIGHT;
|
|
|
|
if (!scrollContainer.IsScrolledToEnd())
|
|
fadeBottom -= LeaderboardScore.HEIGHT;
|
|
|
|
if (scrollFlow == null)
|
|
return;
|
|
|
|
foreach (var c in scrollFlow.Children)
|
|
{
|
|
var topY = c.ToSpaceOfOtherDrawable(Vector2.Zero, scrollFlow).Y;
|
|
var bottomY = topY + LeaderboardScore.HEIGHT;
|
|
|
|
bool requireTopFade = FadeTop && topY <= fadeTop;
|
|
bool requireBottomFade = FadeBottom && bottomY >= fadeBottom;
|
|
|
|
if (!requireTopFade && !requireBottomFade)
|
|
c.Colour = Color4.White;
|
|
else if (topY > fadeBottom + LeaderboardScore.HEIGHT || bottomY < fadeTop - LeaderboardScore.HEIGHT)
|
|
c.Colour = Color4.Transparent;
|
|
else
|
|
{
|
|
if (bottomY - fadeBottom > 0 && FadeBottom)
|
|
{
|
|
c.Colour = ColourInfo.GradientVertical(
|
|
Color4.White.Opacity(Math.Min(1 - (topY - fadeBottom) / LeaderboardScore.HEIGHT, 1)),
|
|
Color4.White.Opacity(Math.Min(1 - (bottomY - fadeBottom) / LeaderboardScore.HEIGHT, 1)));
|
|
}
|
|
else if (FadeTop)
|
|
{
|
|
c.Colour = ColourInfo.GradientVertical(
|
|
Color4.White.Opacity(Math.Min(1 - (fadeTop - topY) / LeaderboardScore.HEIGHT, 1)),
|
|
Color4.White.Opacity(Math.Min(1 - (fadeTop - bottomY) / LeaderboardScore.HEIGHT, 1)));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
protected abstract LeaderboardScore CreateDrawableScore(TScoreInfo model, int index);
|
|
}
|
|
}
|