diff --git a/osu.Game/Overlays/BeatmapListing/BeatmapListingFilterControl.cs b/osu.Game/Overlays/BeatmapListing/BeatmapListingFilterControl.cs
index b6a0846407..d80ef075e9 100644
--- a/osu.Game/Overlays/BeatmapListing/BeatmapListingFilterControl.cs
+++ b/osu.Game/Overlays/BeatmapListing/BeatmapListingFilterControl.cs
@@ -26,8 +26,6 @@ namespace osu.Game.Overlays.BeatmapListing
{
///
/// Fired when a search finishes.
- /// SearchFinished.Type = ResultsReturned when results returned. Contains only new items in the case of pagination.
- /// SearchFinished.Type = SupporterOnlyFilter when a non-supporter user applied supporter-only filters.
///
public Action SearchFinished;
@@ -216,7 +214,7 @@ namespace osu.Game.Overlays.BeatmapListing
lastResponse = response;
getSetsRequest = null;
- // check if an non-supporter user used supporter-only filters
+ // check if a non-supporter used supporter-only filters
if (!api.LocalUser.Value.IsSupporter)
{
List filters = new List();
@@ -229,7 +227,7 @@ namespace osu.Game.Overlays.BeatmapListing
if (filters.Any())
{
- SearchFinished?.Invoke(SearchResult.SupporterOnlyFilter(filters));
+ SearchFinished?.Invoke(SearchResult.SupporterOnlyFilters(filters));
return;
}
}
@@ -260,21 +258,40 @@ namespace osu.Game.Overlays.BeatmapListing
base.Dispose(isDisposing);
}
+ ///
+ /// Indicates the type of result of a user-requested beatmap search.
+ ///
public enum SearchResultType
{
- // returned with Results
+ ///
+ /// Actual results have been returned from API.
+ ///
ResultsReturned,
- // non-supporter user applied supporter-only filters
- SupporterOnlyFilter
+
+ ///
+ /// The user is not a supporter, but used supporter-only search filters.
+ ///
+ SupporterOnlyFilters
}
- // Results only valid when Type == ResultsReturned
- // Filters only valid when Type == SupporterOnlyFilter
+ ///
+ /// Describes the result of a user-requested beatmap search.
+ ///
public struct SearchResult
{
public SearchResultType Type { get; private set; }
+
+ ///
+ /// Contains the beatmap sets returned from API.
+ /// Valid for read if and only if is .
+ ///
public List Results { get; private set; }
- public List Filters { get; private set; }
+
+ ///
+ /// Contains the names of supporter-only filters requested by the user.
+ /// Valid for read if and only if is .
+ ///
+ public List SupporterOnlyFiltersUsed { get; private set; }
public static SearchResult ResultsReturned(List results) => new SearchResult
{
@@ -282,10 +299,10 @@ namespace osu.Game.Overlays.BeatmapListing
Results = results
};
- public static SearchResult SupporterOnlyFilter(List filters) => new SearchResult
+ public static SearchResult SupporterOnlyFilters(List filters) => new SearchResult
{
- Type = SearchResultType.SupporterOnlyFilter,
- Filters = filters
+ Type = SearchResultType.SupporterOnlyFilters,
+ SupporterOnlyFiltersUsed = filters
};
}
}
diff --git a/osu.Game/Overlays/BeatmapListingOverlay.cs b/osu.Game/Overlays/BeatmapListingOverlay.cs
index c2ba3d5bc0..5489f0277f 100644
--- a/osu.Game/Overlays/BeatmapListingOverlay.cs
+++ b/osu.Game/Overlays/BeatmapListingOverlay.cs
@@ -123,9 +123,9 @@ namespace osu.Game.Overlays
private void onSearchFinished(BeatmapListingFilterControl.SearchResult searchResult)
{
// non-supporter user used supporter-only filters
- if (searchResult.Type == BeatmapListingFilterControl.SearchResultType.SupporterOnlyFilter)
+ if (searchResult.Type == BeatmapListingFilterControl.SearchResultType.SupporterOnlyFilters)
{
- supporterRequiredContent.UpdateText(searchResult.Filters);
+ supporterRequiredContent.UpdateText(searchResult.SupporterOnlyFiltersUsed);
addContentToPlaceholder(supporterRequiredContent);
return;
}