h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2025-01-28 06:03:08 +08:00
Code Issues Releases Wiki Activity

Add basic documentation

Browse Source
This commit is contained in:
Dean Herbert 2018-06-08 20:53:58 +09:00
parent 66d28aa9fc
commit 064e8190be
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
osu.Game/Beatmaps/Drawables/BeatmapSetDownloader.cs
View File

@ -8,6 +8,9 @@ using osu.Framework.Graphics;
namespace osu.Game.Beatmaps.Drawables namespace osu.Game.Beatmaps.Drawables
{ {
/// <summary>
/// A component to allow downloading of a beatmap set. Automatically handles state syncing between other instances.
/// </summary>
public class BeatmapSetDownloader : Component public class BeatmapSetDownloader : Component
{ {
private readonly BeatmapSetInfo set; private readonly BeatmapSetInfo set;
@ -15,6 +18,9 @@ namespace osu.Game.Beatmaps.Drawables
private BeatmapManager beatmaps; private BeatmapManager beatmaps;
/// <summary>
/// Whether the associated beatmap set has been downloading (by this instance or any other instance).
/// </summary>
public readonly BindableBool Downloaded = new BindableBool(); public readonly BindableBool Downloaded = new BindableBool();
public BeatmapSetDownloader(BeatmapSetInfo set, bool noVideo = false) public BeatmapSetDownloader(BeatmapSetInfo set, bool noVideo = false)
@ -47,6 +53,10 @@ namespace osu.Game.Beatmaps.Drawables
} }
} }
/// <summary>
/// Begin downloading the associated beatmap set.
/// </summary>
/// <returns>True if downloading began. False if an existing download is active or completed.</returns>
public bool Download() public bool Download()
{ {
if (Downloaded.Value) if (Downloaded.Value)