Merge spectator list classes into one skinnable

bdach · bdach · commit abf4b7b491e8 · 2025-01-17T11:16:35.000+01:00
diff --git a/osu.Game.Rulesets.Catch/Skinning/Legacy/CatchLegacySkinTransformer.cs b/osu.Game.Rulesets.Catch/Skinning/Legacy/CatchLegacySkinTransformer.cs
@@ -48,7 +48,7 @@ public CatchLegacySkinTransformer(ISkin skin)
                             return new DefaultSkinComponentsContainer(container =>
                             {
                                 var keyCounter = container.OfType<LegacyKeyCounterDisplay>().FirstOrDefault();
-                                var spectatorList = container.OfType<SkinnableSpectatorList>().FirstOrDefault();
+                                var spectatorList = container.OfType<SpectatorList>().FirstOrDefault();
 
                                 if (keyCounter != null)
                                 {
@@ -69,7 +69,7 @@ public CatchLegacySkinTransformer(ISkin skin)
                                 Children = new Drawable[]
                                 {
                                     new LegacyKeyCounterDisplay(),
-                                    new SkinnableSpectatorList(),
+                                    new SpectatorList(),
                                 }
                             };
                     }
diff --git a/osu.Game.Rulesets.Mania/Skinning/Argon/ManiaArgonSkinTransformer.cs b/osu.Game.Rulesets.Mania/Skinning/Argon/ManiaArgonSkinTransformer.cs
@@ -41,7 +41,7 @@ public ManiaArgonSkinTransformer(ISkin skin, IBeatmap beatmap)
                             return new DefaultSkinComponentsContainer(container =>
                             {
                                 var combo = container.ChildrenOfType<ArgonManiaComboCounter>().FirstOrDefault();
-                                var spectatorList = container.OfType<SkinnableSpectatorList>().FirstOrDefault();
+                                var spectatorList = container.OfType<SpectatorList>().FirstOrDefault();
 
                                 if (combo != null)
                                 {
@@ -56,7 +56,7 @@ public ManiaArgonSkinTransformer(ISkin skin, IBeatmap beatmap)
                             })
                             {
                                 new ArgonManiaComboCounter(),
-                                new SkinnableSpectatorList
+                                new SpectatorList
                                 {
                                     Anchor = Anchor.BottomLeft,
                                     Origin = Anchor.BottomLeft,
diff --git a/osu.Game.Rulesets.Mania/Skinning/Legacy/ManiaLegacySkinTransformer.cs b/osu.Game.Rulesets.Mania/Skinning/Legacy/ManiaLegacySkinTransformer.cs
@@ -97,7 +97,7 @@ public override Drawable GetDrawableComponent(ISkinComponentLookup lookup)
                             return new DefaultSkinComponentsContainer(container =>
                             {
                                 var combo = container.ChildrenOfType<LegacyManiaComboCounter>().FirstOrDefault();
-                                var spectatorList = container.OfType<SkinnableSpectatorList>().FirstOrDefault();
+                                var spectatorList = container.OfType<SpectatorList>().FirstOrDefault();
 
                                 if (combo != null)
                                 {
@@ -115,7 +115,7 @@ public override Drawable GetDrawableComponent(ISkinComponentLookup lookup)
                             })
                             {
                                 new LegacyManiaComboCounter(),
-                                new SkinnableSpectatorList(),
+                                new SpectatorList(),
                             };
                     }
 
diff --git a/osu.Game.Rulesets.Osu/Skinning/Legacy/OsuLegacySkinTransformer.cs b/osu.Game.Rulesets.Osu/Skinning/Legacy/OsuLegacySkinTransformer.cs
@@ -71,7 +71,7 @@ public OsuLegacySkinTransformer(ISkin skin)
                                 }
 
                                 var combo = container.OfType<LegacyDefaultComboCounter>().FirstOrDefault();
-                                var spectatorList = container.OfType<SkinnableSpectatorList>().FirstOrDefault();
+                                var spectatorList = container.OfType<SpectatorList>().FirstOrDefault();
 
                                 Vector2 pos = new Vector2();
 
@@ -96,7 +96,7 @@ public OsuLegacySkinTransformer(ISkin skin)
                                 {
                                     new LegacyDefaultComboCounter(),
                                     new LegacyKeyCounterDisplay(),
-                                    new SkinnableSpectatorList(),
+                                    new SpectatorList(),
                                 }
                             };
                     }
diff --git a/osu.Game.Tests/Resources/Archives/modified-argon-20250116.osk b/osu.Game.Tests/Resources/Archives/modified-argon-20250116.osk
diff --git a/osu.Game.Tests/Visual/Gameplay/TestSceneSpectatorList.cs b/osu.Game.Tests/Visual/Gameplay/TestSceneSpectatorList.cs
@@ -6,53 +6,72 @@
 using osu.Framework.Bindables;
 using osu.Framework.Graphics;
 using osu.Framework.Utils;
+using osu.Game.Beatmaps;
 using osu.Game.Graphics;
 using osu.Game.Online.Spectator;
+using osu.Game.Rulesets.Osu;
+using osu.Game.Rulesets.Osu.Scoring;
 using osu.Game.Screens.Play;
 using osu.Game.Screens.Play.HUD;
+using osu.Game.Tests.Visual.Spectator;
 
 namespace osu.Game.Tests.Visual.Gameplay
 {
     [TestFixture]
     public partial class TestSceneSpectatorList : OsuTestScene
     {
-        private readonly BindableList<SpectatorUser> spectators = new BindableList<SpectatorUser>();
-        private readonly Bindable<LocalUserPlayingState> localUserPlayingState = new Bindable<LocalUserPlayingState>();
-
         private int counter;
 
         [Test]
         public void TestBasics()
         {
             SpectatorList list = null!;
-            AddStep("create spectator list", () => Child = list = new SpectatorList
+            Bindable<LocalUserPlayingState> playingState = new Bindable<LocalUserPlayingState>();
+            GameplayState gameplayState = new GameplayState(new Beatmap(), new OsuRuleset(), healthProcessor: new OsuHealthProcessor(0), localUserPlayingState: playingState);
+            TestSpectatorClient client = new TestSpectatorClient();
+
+            AddStep("create spectator list", () =>
             {
-                Anchor = Anchor.Centre,
-                Origin = Anchor.Centre,
-                Spectators = { BindTarget = spectators },
-                UserPlayingState = { BindTarget = localUserPlayingState }
+                Children = new Drawable[]
+                {
+                    client,
+                    new DependencyProvidingContainer
+                    {
+                        RelativeSizeAxes = Axes.Both,
+                        CachedDependencies =
+                        [
+                            (typeof(GameplayState), gameplayState),
+                            (typeof(SpectatorClient), client)
+                        ],
+                        Child = list = new SpectatorList
+                        {
+                            Anchor = Anchor.Centre,
+                            Origin = Anchor.Centre,
+                        }
+                    }
+                };
             });
 
-            AddStep("start playing", () => localUserPlayingState.Value = LocalUserPlayingState.Playing);
+            AddStep("start playing", () => playingState.Value = LocalUserPlayingState.Playing);
 
             AddRepeatStep("add a user", () =>
             {
                 int id = Interlocked.Increment(ref counter);
-                spectators.Add(new SpectatorUser
+                ((ISpectatorClient)client).UserStartedWatching([new SpectatorUser
                 {
                     OnlineID = id,
                     Username = $"User {id}"
-                });
+                }]);
             }, 10);
 
-            AddRepeatStep("remove random user", () => spectators.RemoveAt(RNG.Next(0, spectators.Count)), 5);
+            AddRepeatStep("remove random user", () => ((ISpectatorClient)client).UserEndedWatching(client.WatchingUsers[RNG.Next(client.WatchingUsers.Count)].OnlineID), 5);
 
             AddStep("change font to venera", () => list.Font.Value = Typeface.Venera);
             AddStep("change font to torus", () => list.Font.Value = Typeface.Torus);
             AddStep("change header colour", () => list.HeaderColour.Value = new Colour4(RNG.NextSingle(), RNG.NextSingle(), RNG.NextSingle(), 1));
 
-            AddStep("enter break", () => localUserPlayingState.Value = LocalUserPlayingState.Break);
-            AddStep("stop playing", () => localUserPlayingState.Value = LocalUserPlayingState.NotPlaying);
+            AddStep("enter break", () => playingState.Value = LocalUserPlayingState.Break);
+            AddStep("stop playing", () => playingState.Value = LocalUserPlayingState.NotPlaying);
         }
     }
 }
diff --git a/osu.Game/Screens/Play/HUD/SpectatorList.cs b/osu.Game/Screens/Play/HUD/SpectatorList.cs
@@ -24,7 +24,7 @@
 
 namespace osu.Game.Screens.Play.HUD
 {
-    public partial class SpectatorList : CompositeDrawable
+    public partial class SpectatorList : CompositeDrawable, ISerialisableDrawable
     {
         private const int max_spectators_displayed = 10;
 
@@ -44,7 +44,7 @@ public partial class SpectatorList : CompositeDrawable
         private DrawablePool<SpectatorListEntry> pool = null!;
 
         [BackgroundDependencyLoader]
-        private void load(OsuColour colours)
+        private void load(OsuColour colours, SpectatorClient client, GameplayState gameplayState)
         {
             AutoSizeAxes = Axes.Y;
 
@@ -73,6 +73,9 @@ private void load(OsuColour colours)
             };
 
             HeaderColour.Value = Header.Colour;
+
+            ((IBindableList<SpectatorUser>)Spectators).BindTo(client.WatchingUsers);
+            ((IBindable<LocalUserPlayingState>)UserPlayingState).BindTo(gameplayState.PlayingState);
         }
 
         protected override void LoadComplete()
@@ -236,17 +239,7 @@ private void updateEnabledState()
                     linkCompiler.Enabled.Value = UserPlayingState.Value != LocalUserPlayingState.Playing;
             }
         }
-    }
 
-    public partial class SkinnableSpectatorList : SpectatorList, ISerialisableDrawable
-    {
         public bool UsesFixedAnchor { get; set; }
-
-        [BackgroundDependencyLoader]
-        private void load(SpectatorClient client, GameplayState gameplayState)
-        {
-            ((IBindableList<SpectatorUser>)Spectators).BindTo(client.WatchingUsers);
-            ((IBindable<LocalUserPlayingState>)UserPlayingState).BindTo(gameplayState.PlayingState);
-        }
     }
 }
diff --git a/osu.Game/Skinning/ArgonSkin.cs b/osu.Game/Skinning/ArgonSkin.cs
@@ -112,7 +112,7 @@ public ArgonSkin(SkinInfo skin, IStorageResourceProvider resources)
                                 return new DefaultSkinComponentsContainer(container =>
                                 {
                                     var comboCounter = container.OfType<ArgonComboCounter>().FirstOrDefault();
-                                    var spectatorList = container.OfType<SkinnableSpectatorList>().FirstOrDefault();
+                                    var spectatorList = container.OfType<SpectatorList>().FirstOrDefault();
 
                                     Vector2 pos = new Vector2(36, -66);
 
@@ -135,7 +135,7 @@ public ArgonSkin(SkinInfo skin, IStorageResourceProvider resources)
                                             Origin = Anchor.BottomLeft,
                                             Scale = new Vector2(1.3f),
                                         },
-                                        new SkinnableSpectatorList
+                                        new SpectatorList
                                         {
                                             Anchor = Anchor.BottomLeft,
                                             Origin = Anchor.BottomLeft,
diff --git a/osu.Game/Skinning/LegacySkin.cs b/osu.Game/Skinning/LegacySkin.cs
@@ -367,7 +367,7 @@ protected override void ParseConfigurationStream(Stream stream)
                                 return new DefaultSkinComponentsContainer(container =>
                                 {
                                     var combo = container.OfType<LegacyDefaultComboCounter>().FirstOrDefault();
-                                    var spectatorList = container.OfType<SkinnableSpectatorList>().FirstOrDefault();
+                                    var spectatorList = container.OfType<SpectatorList>().FirstOrDefault();
 
                                     Vector2 pos = new Vector2();
 
@@ -389,7 +389,7 @@ protected override void ParseConfigurationStream(Stream stream)
                                 })
                                 {
                                     new LegacyDefaultComboCounter(),
-                                    new SkinnableSpectatorList(),
+                                    new SpectatorList(),
                                 };
                             }
 
diff --git a/osu.Game/Skinning/TrianglesSkin.cs b/osu.Game/Skinning/TrianglesSkin.cs
@@ -91,7 +91,7 @@ public TrianglesSkin(SkinInfo skin, IStorageResourceProvider resources)
                                 var ppCounter = container.OfType<PerformancePointsCounter>().FirstOrDefault();
                                 var songProgress = container.OfType<DefaultSongProgress>().FirstOrDefault();
                                 var keyCounter = container.OfType<DefaultKeyCounterDisplay>().FirstOrDefault();
-                                var spectatorList = container.OfType<SkinnableSpectatorList>().FirstOrDefault();
+                                var spectatorList = container.OfType<SpectatorList>().FirstOrDefault();
 
                                 if (score != null)
                                 {
@@ -177,7 +177,7 @@ public TrianglesSkin(SkinInfo skin, IStorageResourceProvider resources)
                                     new BarHitErrorMeter(),
                                     new BarHitErrorMeter(),
                                     new TrianglesPerformancePointsCounter(),
-                                    new SkinnableSpectatorList(),
+                                    new SpectatorList(),
                                 }
                             };
 

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public CatchLegacySkinTransformer(ISkin skin)`
`48`	`48`	`return new DefaultSkinComponentsContainer(container =>`
`49`	`49`	`{`
`50`	`50`	`var keyCounter = container.OfType<LegacyKeyCounterDisplay>().FirstOrDefault();`
`51`		`- var spectatorList = container.OfType<SkinnableSpectatorList>().FirstOrDefault();`
	`51`	`+ var spectatorList = container.OfType<SpectatorList>().FirstOrDefault();`
`52`	`52`
`53`	`53`	`if (keyCounter != null)`
`54`	`54`	`{`
`@@ -69,7 +69,7 @@ public CatchLegacySkinTransformer(ISkin skin)`
`69`	`69`	`Children = new Drawable[]`
`70`	`70`	`{`
`71`	`71`	`new LegacyKeyCounterDisplay(),`
`72`		`- new SkinnableSpectatorList(),`
	`72`	`+ new SpectatorList(),`
`73`	`73`	`}`
`74`	`74`	`};`
`75`	`75`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public ManiaArgonSkinTransformer(ISkin skin, IBeatmap beatmap)`
`41`	`41`	`return new DefaultSkinComponentsContainer(container =>`
`42`	`42`	`{`
`43`	`43`	`var combo = container.ChildrenOfType<ArgonManiaComboCounter>().FirstOrDefault();`
`44`		`- var spectatorList = container.OfType<SkinnableSpectatorList>().FirstOrDefault();`
	`44`	`+ var spectatorList = container.OfType<SpectatorList>().FirstOrDefault();`
`45`	`45`
`46`	`46`	`if (combo != null)`
`47`	`47`	`{`
`@@ -56,7 +56,7 @@ public ManiaArgonSkinTransformer(ISkin skin, IBeatmap beatmap)`
`56`	`56`	`})`
`57`	`57`	`{`
`58`	`58`	`new ArgonManiaComboCounter(),`
`59`		`- new SkinnableSpectatorList`
	`59`	`+ new SpectatorList`
`60`	`60`	`{`
`61`	`61`	`Anchor = Anchor.BottomLeft,`
`62`	`62`	`Origin = Anchor.BottomLeft,`
Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ public override Drawable GetDrawableComponent(ISkinComponentLookup lookup)`
`97`	`97`	`return new DefaultSkinComponentsContainer(container =>`
`98`	`98`	`{`
`99`	`99`	`var combo = container.ChildrenOfType<LegacyManiaComboCounter>().FirstOrDefault();`
`100`		`- var spectatorList = container.OfType<SkinnableSpectatorList>().FirstOrDefault();`
	`100`	`+ var spectatorList = container.OfType<SpectatorList>().FirstOrDefault();`
`101`	`101`
`102`	`102`	`if (combo != null)`
`103`	`103`	`{`
`@@ -115,7 +115,7 @@ public override Drawable GetDrawableComponent(ISkinComponentLookup lookup)`
`115`	`115`	`})`
`116`	`116`	`{`
`117`	`117`	`new LegacyManiaComboCounter(),`
`118`		`- new SkinnableSpectatorList(),`
	`118`	`+ new SpectatorList(),`
`119`	`119`	`};`
`120`	`120`	`}`
`121`	`121`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ public OsuLegacySkinTransformer(ISkin skin)`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`var combo = container.OfType<LegacyDefaultComboCounter>().FirstOrDefault();`
`74`		`- var spectatorList = container.OfType<SkinnableSpectatorList>().FirstOrDefault();`
	`74`	`+ var spectatorList = container.OfType<SpectatorList>().FirstOrDefault();`
`75`	`75`
`76`	`76`	`Vector2 pos = new Vector2();`
`77`	`77`
`@@ -96,7 +96,7 @@ public OsuLegacySkinTransformer(ISkin skin)`
`96`	`96`	`{`
`97`	`97`	`new LegacyDefaultComboCounter(),`
`98`	`98`	`new LegacyKeyCounterDisplay(),`
`99`		`- new SkinnableSpectatorList(),`
	`99`	`+ new SpectatorList(),`
`100`	`100`	`}`
`101`	`101`	`};`
`102`	`102`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`
`25`	`25`	`namespace osu.Game.Screens.Play.HUD`
`26`	`26`	`{`
`27`		`- public partial class SpectatorList : CompositeDrawable`
	`27`	`+ public partial class SpectatorList : CompositeDrawable, ISerialisableDrawable`
`28`	`28`	`{`
`29`	`29`	`private const int max_spectators_displayed = 10;`
`30`	`30`
`@@ -44,7 +44,7 @@ public partial class SpectatorList : CompositeDrawable`
`44`	`44`	`private DrawablePool<SpectatorListEntry> pool = null!;`
`45`	`45`
`46`	`46`	`[BackgroundDependencyLoader]`
`47`		`- private void load(OsuColour colours)`
	`47`	`+ private void load(OsuColour colours, SpectatorClient client, GameplayState gameplayState)`
`48`	`48`	`{`
`49`	`49`	`AutoSizeAxes = Axes.Y;`
`50`	`50`
`@@ -73,6 +73,9 @@ private void load(OsuColour colours)`
`73`	`73`	`};`
`74`	`74`
`75`	`75`	`HeaderColour.Value = Header.Colour;`
	`76`	`+`
	`77`	`+ ((IBindableList<SpectatorUser>)Spectators).BindTo(client.WatchingUsers);`
	`78`	`+ ((IBindable<LocalUserPlayingState>)UserPlayingState).BindTo(gameplayState.PlayingState);`
`76`	`79`	`}`
`77`	`80`
`78`	`81`	`protected override void LoadComplete()`
`@@ -236,17 +239,7 @@ private void updateEnabledState()`
`236`	`239`	`linkCompiler.Enabled.Value = UserPlayingState.Value != LocalUserPlayingState.Playing;`
`237`	`240`	`}`
`238`	`241`	`}`
`239`		`- }`
`240`	`242`
`241`		`- public partial class SkinnableSpectatorList : SpectatorList, ISerialisableDrawable`
`242`		`- {`
`243`	`243`	`public bool UsesFixedAnchor { get; set; }`
`244`		`-`
`245`		`- [BackgroundDependencyLoader]`
`246`		`- private void load(SpectatorClient client, GameplayState gameplayState)`
`247`		`- {`
`248`		`- ((IBindableList<SpectatorUser>)Spectators).BindTo(client.WatchingUsers);`
`249`		`- ((IBindable<LocalUserPlayingState>)UserPlayingState).BindTo(gameplayState.PlayingState);`
`250`		`- }`
`251`	`244`	`}`
`252`	`245`	`}`
Original file line number	Diff line number	Diff line change
`@@ -367,7 +367,7 @@ protected override void ParseConfigurationStream(Stream stream)`
`367`	`367`	`return new DefaultSkinComponentsContainer(container =>`
`368`	`368`	`{`
`369`	`369`	`var combo = container.OfType<LegacyDefaultComboCounter>().FirstOrDefault();`
`370`		`- var spectatorList = container.OfType<SkinnableSpectatorList>().FirstOrDefault();`
	`370`	`+ var spectatorList = container.OfType<SpectatorList>().FirstOrDefault();`
`371`	`371`
`372`	`372`	`Vector2 pos = new Vector2();`
`373`	`373`
`@@ -389,7 +389,7 @@ protected override void ParseConfigurationStream(Stream stream)`
`389`	`389`	`})`
`390`	`390`	`{`
`391`	`391`	`new LegacyDefaultComboCounter(),`
`392`		`- new SkinnableSpectatorList(),`
	`392`	`+ new SpectatorList(),`
`393`	`393`	`};`
`394`	`394`	`}`
`395`	`395`