Refactor SceneComposition O(n) -> O(1) Lookup Time

valkyrienyanko · valkyrienyanko · commit fe0e4c1d5d79 · 2026-03-28T14:23:56.000-05:00
diff --git a/Template/Framework/Composition/SceneComposition.cs b/Template/Framework/Composition/SceneComposition.cs
@@ -16,20 +16,40 @@ public static T InstantiateAndConfigure<T>(PackedScene scene, GameServices servi
         ArgumentNullException.ThrowIfNull(services);
 
         T node = scene.Instantiate<T>();
-        ConfigureNodeTree(node, services);
+        ConfigureNode(node, services);
         return node;
     }
 
     public static void ConfigureNodeTree(Node root, GameServices services)
     {
-        if (root is ISceneDependencyReceiver receiver)
+        ConfigureNode(root, services);
+    }
+
+    public static void ConfigureNode(Node node, GameServices services)
+    {
+        ArgumentNullException.ThrowIfNull(node);
+        ArgumentNullException.ThrowIfNull(services);
+
+        if (node is ISceneDependencyReceiver receiver)
         {
             receiver.Configure(services);
         }
+    }
+
+    public static void ConfigureNodeFromGame(Node node)
+    {
+        ArgumentNullException.ThrowIfNull(node);
+
+        if (node is not ISceneDependencyReceiver receiver)
+        {
+            return;
+        }
 
-        foreach (Node child in root.GetChildren())
+        if (!Game.TryGetServices(out GameServices services))
         {
-            ConfigureNodeTree(child, services);
+            return;
         }
+
+        receiver.Configure(services);
     }
 }
diff --git a/Template/Framework/Console/GameConsole.cs b/Template/Framework/Console/GameConsole.cs
@@ -34,6 +34,11 @@ public void Configure(GameServices services)
 
     public bool Visible => _mainContainer.Visible;
 
+    public override void _EnterTree()
+    {
+        SceneComposition.ConfigureNodeFromGame(this);
+    }
+
     public override void _Ready()
     {
         if (!_isConfigured)
diff --git a/Template/Framework/Debugging/GameFramework.cs b/Template/Framework/Debugging/GameFramework.cs
@@ -17,6 +17,18 @@ internal static void Initialize(GameServices services)
         _services = services;
     }
 
+    internal static bool TryGetServices(out GameServices services)
+    {
+        if (_services is null)
+        {
+            services = null!;
+            return false;
+        }
+
+        services = _services;
+        return true;
+    }
+
     internal static void Reset()
     {
         _services = null;
diff --git a/Template/Framework/ModLoader/ModLoader.cs b/Template/Framework/ModLoader/ModLoader.cs
@@ -33,6 +33,11 @@ public void Configure(GameServices services)
         _isConfigured = true;
     }
 
+    public override void _EnterTree()
+    {
+        SceneComposition.ConfigureNodeFromGame(this);
+    }
+
     // Godot Overrides
     public override void _Ready()
     {
diff --git a/Template/Framework/Netcode/Examples/TopDown2/World.cs b/Template/Framework/Netcode/Examples/TopDown2/World.cs
@@ -1,31 +1,17 @@
 using Godot;
-using System;
 
 namespace __TEMPLATE__.Netcode.Examples.TopDown2;
 
-public partial class World : Node, ISceneDependencyReceiver
+public partial class World : Node
 {
     private const int Port = 25565;
     private const string Ip = "127.0.0.1";
 
     private Net<GameClient, GameServer> _net = null!;
-    private ILoggerService _loggerService = null!;
-    private IApplicationLifetime _applicationLifetime = null!;
-    private bool _isConfigured;
-
-    public void Configure(GameServices services)
-    {
-        _loggerService = services.Logger;
-        _applicationLifetime = services.ApplicationLifetime;
-        _isConfigured = true;
-    }
 
     public override void _Ready()
     {
-        if (!_isConfigured)
-            throw new InvalidOperationException($"{nameof(World)} was not configured before _Ready.");
-
-        _net = new Net<GameClient, GameServer>(_loggerService, _applicationLifetime);
+        _net = new Net<GameClient, GameServer>(Game.Logger, Game.Application);
         _net.StartServer(Port);
         _net.StartClient(Ip, Port);
     }
diff --git a/Template/Framework/Netcode/NetControlPanelLow.cs b/Template/Framework/Netcode/NetControlPanelLow.cs
@@ -41,6 +41,11 @@ public void Configure(GameServices services)
         _isConfigured = true;
     }
 
+    public override void _EnterTree()
+    {
+        SceneComposition.ConfigureNodeFromGame(this);
+    }
+
     public override void _Ready()
     {
         if (!_isConfigured)
diff --git a/Template/Framework/Scenes/MainMenuNavFramework.cs b/Template/Framework/Scenes/MainMenuNavFramework.cs
@@ -26,6 +26,11 @@ public void Configure(GameServices services)
         _isConfigured = true;
     }
 
+    public override void _EnterTree()
+    {
+        SceneComposition.ConfigureNodeFromGame(this);
+    }
+
     // Godot Overrides
     public override void _Ready()
     {
diff --git a/Template/Framework/Scenes/MenuUI/Credits/Credits.cs b/Template/Framework/Scenes/MenuUI/Credits/Credits.cs
@@ -43,6 +43,11 @@ public void Configure(GameServices services)
         _isConfigured = true;
     }
 
+    public override void _EnterTree()
+    {
+        SceneComposition.ConfigureNodeFromGame(this);
+    }
+
     // Godot Overrides
     public override void _Ready()
     {
diff --git a/Template/Framework/Scenes/Options/Options.cs b/Template/Framework/Scenes/Options/Options.cs
@@ -39,6 +39,11 @@ public void Configure(OptionsManager optionsManager, SceneManager sceneManager,
         _isConfigured = true;
     }
 
+    public override void _EnterTree()
+    {
+        SceneComposition.ConfigureNodeFromGame(this);
+    }
+
     // Godot Overrides
     public override void _Ready()
     {
diff --git a/Template/Framework/Scenes/PopupMenu/PopupMenu.cs b/Template/Framework/Scenes/PopupMenu/PopupMenu.cs
@@ -52,6 +52,11 @@ public void Configure(GameServices services)
         _isConfigured = true;
     }
 
+    public override void _EnterTree()
+    {
+        SceneComposition.ConfigureNodeFromGame(this);
+    }
+
     // Godot Overrides
     public override void _Ready()
     {
diff --git a/Template/Framework/Testing/Scenes/SceneStartupSmokeTests.cs b/Template/Framework/Testing/Scenes/SceneStartupSmokeTests.cs
diff --git a/Template/Framework/Testing/Scenes/SceneStartupSmokeTests.cs.uid b/Template/Framework/Testing/Scenes/SceneStartupSmokeTests.cs.uid
diff --git a/Template/MainScenes/3D/FPS/Scripts/Player.cs b/Template/MainScenes/3D/FPS/Scripts/Player.cs
@@ -1,35 +1,25 @@
 using __TEMPLATE__;
 using Godot;
 using GodotUtils;
-using System;
 using PopupMenu = __TEMPLATE__.Ui.PopupMenu;
 
 namespace __TEMPLATE__.FPS;
 
-public partial class Player : CharacterBody3D, ISceneDependencyReceiver
+public partial class Player : CharacterBody3D
 {
     [Export] private Camera3D _camera = null!;
     [Export] private PopupMenu _popupMenu = null!;
     [Export] private PlayerMovementConfig _movementConfig = null!;
 
     private readonly ComponentList _components = new();
-    private IOptionsService _optionsService = null!;
-    private bool _isConfigured;
-
-    public void Configure(GameServices services)
-    {
-        _optionsService = services.Options;
-        _isConfigured = true;
-    }
 
     public override void _Ready()
     {
-        if (!_isConfigured)
-            throw new InvalidOperationException($"{nameof(Player)} was not configured before _Ready.");
+        IOptionsService optionsService = Game.Options;
 
-        FpsOptions.Register(_optionsService);
+        FpsOptions.Register(optionsService);
 
-        PlayerRotation rotationComponent = new(this, _camera, _optionsService);
+        PlayerRotation rotationComponent = new(this, _camera, optionsService);
 
         _components.Add(rotationComponent);
         _components.Add(new PlayerMovement(this, _movementConfig, rotationComponent));

Original file line number	Diff line number	Diff line change
`@@ -16,20 +16,40 @@ public static T InstantiateAndConfigure<T>(PackedScene scene, GameServices servi`
`16`	`16`	`ArgumentNullException.ThrowIfNull(services);`
`17`	`17`
`18`	`18`	`T node = scene.Instantiate<T>();`
`19`		`- ConfigureNodeTree(node, services);`
	`19`	`+ ConfigureNode(node, services);`
`20`	`20`	`return node;`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`public static void ConfigureNodeTree(Node root, GameServices services)`
`24`	`24`	`{`
`25`		`- if (root is ISceneDependencyReceiver receiver)`
	`25`	`+ ConfigureNode(root, services);`
	`26`	`+ }`
	`27`	`+`
	`28`	`+ public static void ConfigureNode(Node node, GameServices services)`
	`29`	`+ {`
	`30`	`+ ArgumentNullException.ThrowIfNull(node);`
	`31`	`+ ArgumentNullException.ThrowIfNull(services);`
	`32`	`+`
	`33`	`+ if (node is ISceneDependencyReceiver receiver)`
`26`	`34`	`{`
`27`	`35`	`receiver.Configure(services);`
`28`	`36`	`}`
	`37`	`+ }`
	`38`	`+`
	`39`	`+ public static void ConfigureNodeFromGame(Node node)`
	`40`	`+ {`
	`41`	`+ ArgumentNullException.ThrowIfNull(node);`
	`42`	`+`
	`43`	`+ if (node is not ISceneDependencyReceiver receiver)`
	`44`	`+ {`
	`45`	`+ return;`
	`46`	`+ }`
`29`	`47`
`30`		`- foreach (Node child in root.GetChildren())`
	`48`	`+ if (!Game.TryGetServices(out GameServices services))`
`31`	`49`	`{`
`32`		`- ConfigureNodeTree(child, services);`
	`50`	`+ return;`
`33`	`51`	`}`
	`52`	`+`
	`53`	`+ receiver.Configure(services);`
`34`	`54`	`}`
`35`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,11 @@ public void Configure(GameServices services)`
`33`	`33`	`_isConfigured = true;`
`34`	`34`	`}`
`35`	`35`
	`36`	`+ public override void _EnterTree()`
	`37`	`+ {`
	`38`	`+ SceneComposition.ConfigureNodeFromGame(this);`
	`39`	`+ }`
	`40`	`+`
`36`	`41`	`// Godot Overrides`
`37`	`42`	`public override void _Ready()`
`38`	`43`	`{`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,11 @@ public void Configure(GameServices services)`
`41`	`41`	`_isConfigured = true;`
`42`	`42`	`}`
`43`	`43`
	`44`	`+ public override void _EnterTree()`
	`45`	`+ {`
	`46`	`+ SceneComposition.ConfigureNodeFromGame(this);`
	`47`	`+ }`
	`48`	`+`
`44`	`49`	`public override void _Ready()`
`45`	`50`	`{`
`46`	`51`	`if (!_isConfigured)`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,11 @@ public void Configure(GameServices services)`
`26`	`26`	`_isConfigured = true;`
`27`	`27`	`}`
`28`	`28`
	`29`	`+ public override void _EnterTree()`
	`30`	`+ {`
	`31`	`+ SceneComposition.ConfigureNodeFromGame(this);`
	`32`	`+ }`
	`33`	`+`
`29`	`34`	`// Godot Overrides`
`30`	`35`	`public override void _Ready()`
`31`	`36`	`{`
Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,11 @@ public void Configure(GameServices services)`
`43`	`43`	`_isConfigured = true;`
`44`	`44`	`}`
`45`	`45`
	`46`	`+ public override void _EnterTree()`
	`47`	`+ {`
	`48`	`+ SceneComposition.ConfigureNodeFromGame(this);`
	`49`	`+ }`
	`50`	`+`
`46`	`51`	`// Godot Overrides`
`47`	`52`	`public override void _Ready()`
`48`	`53`	`{`
Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,11 @@ public void Configure(OptionsManager optionsManager, SceneManager sceneManager,`
`39`	`39`	`_isConfigured = true;`
`40`	`40`	`}`
`41`	`41`
	`42`	`+ public override void _EnterTree()`
	`43`	`+ {`
	`44`	`+ SceneComposition.ConfigureNodeFromGame(this);`
	`45`	`+ }`
	`46`	`+`
`42`	`47`	`// Godot Overrides`
`43`	`48`	`public override void _Ready()`
`44`	`49`	`{`
Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,11 @@ public void Configure(GameServices services)`
`52`	`52`	`_isConfigured = true;`
`53`	`53`	`}`
`54`	`54`
	`55`	`+ public override void _EnterTree()`
	`56`	`+ {`
	`57`	`+ SceneComposition.ConfigureNodeFromGame(this);`
	`58`	`+ }`
	`59`	`+`
`55`	`60`	`// Godot Overrides`
`56`	`61`	`public override void _Ready()`
`57`	`62`	`{`