scene loading

Author: mrDIMAS

src/_posts/2026-03-31-fyrox-game-engine-1.0.0.md

@@ -192,6 +192,76 @@ Animation blending state machine editor was improved as well, it is not only the
 new animation or renaming one is now performed via new input box control. This is much more intuitive than the old 
 approach.
 
+# Scene Loading
+
+Scene and UI loading was refactored to be more flexible, `AsyncSceneLoader` was removed and now scene loading is performed
+via async tasks. There are three new helper methods in `PluginContext`: `load_scene`, `load_ui`, `load_scene_or_ui`.
+
+The easiest way to load a scene or UI (and the most compact one) is just one line:
+
+```rust
+impl Plugin for MyGame {
+    fn init(&mut self, scene_path: Option<&str>, mut ctx: PluginContext) -> GameResult {
+        ctx.load_scene_or_ui(scene_path.unwrap_or("data/path/to/scene.rgs"));
+        Ok(())
+    }
+}
+```
+
+This method is used by default in all new projects generated by the project manager. This method automatically adds
+the loaded scene or UI to the engine internals.
+
+In some cases you may want more control of how the scene is processed before adding it to the engine. A typical example
+of scene loading with full control of the process is something like this now:
+
+
+```rust
+#[derive(Visit, Clone, Reflect, Debug)]
+struct MyGame {
+    main_scene: Handle<Scene>,
+}
+
+impl MyGame {
+    fn load_scene(&mut self, path: &str, ctx: &mut PluginContext) {
+        // You may want to remove the previous scene first.
+        if self.main_scene.is_some() {
+            ctx.scenes.remove(self.main_scene)
+        }
+
+        // Step 1. Kick off scene loading in a separate thread. This method could
+        // be located in any place of your code.
+        ctx.load_scene(
+            path,
+            false,
+            |result, game: &mut MyGame, ctx: &mut PluginContext| {
+                game.on_scene_loading_result(result, ctx)
+            },
+        );
+    }
+
+    fn on_scene_loading_result(
+        &mut self,
+        result: SceneLoaderResult,
+        ctx: &mut PluginContext,
+    ) -> GameResult {
+        // Step 2.
+        // Remember the new scene as main.
+        // This method is called once a scene was fully loaded.
+        self.main_scene = ctx.scenes.add(result?.payload);
+        Ok(())
+    }
+}
+
+impl Plugin for MyGame {
+    fn init(&mut self, scene_path: Option<&str>, mut ctx: PluginContext) -> GameResult {
+        self.load_scene(scene_path.unwrap_or("path/to/your/scene.rgs"), &mut ctx);
+        Ok(())
+    }
+}
+```
+
+It is quite verbose, but it is only needed if you need to do something special during scene loading.
+
 # Book
 
 [The book](https://fyrox-book.github.io/) was updated for 1.0.0, it now has all screenshots up-to-date,