From f12044b03e97da4bbb883dd026c267f796345fe6 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Tue, 22 Feb 2022 15:31:08 +0900
Subject: [PATCH] Add mention of `PlaylistItem.Beatmap` being a placeholder in
 many cases

---
 osu.Game/Online/Rooms/PlaylistItem.cs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/osu.Game/Online/Rooms/PlaylistItem.cs b/osu.Game/Online/Rooms/PlaylistItem.cs
index 33718f050b..f696362cbb 100644
--- a/osu.Game/Online/Rooms/PlaylistItem.cs
+++ b/osu.Game/Online/Rooms/PlaylistItem.cs
@@ -62,6 +62,10 @@ namespace osu.Game.Online.Rooms
         [JsonProperty("beatmap_id")]
         private int onlineBeatmapId => Beatmap.OnlineID;
 
+        /// <summary>
+        /// A beatmap representing this playlist item.
+        /// In many cases, this will *not* contain any usable information apart from OnlineID.
+        /// </summary>
         [JsonIgnore]
         public IBeatmapInfo Beatmap { get; set; } = null!;