docs: Add Component, GameObject, TransformComponent and Scene API documentation
- Add Component class documentation with lifecycle methods - Add GameObject class documentation with component system - Add TransformComponent documentation with transform methods - Add Scene class documentation with GameObject management - Add SceneManager singleton documentation with scene loading - Update components.md overview with all component classes - Update main.md navigation with Scene module
This commit is contained in:
34
docs/api/scene/scene-manager/load-scene-async.md
Normal file
34
docs/api/scene/scene-manager/load-scene-async.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# LoadSceneAsync
|
||||
|
||||
Load a scene from a file asynchronously.
|
||||
|
||||
## Syntax
|
||||
|
||||
```cpp
|
||||
void LoadSceneAsync(const std::string& filePath, std::function<void(Scene*)> callback);
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
- `filePath` - The path to the scene file.
|
||||
- `callback` - Callback function called when loading is complete, receives the loaded Scene.
|
||||
|
||||
## Remarks
|
||||
|
||||
Loads a scene from the specified file path asynchronously. The callback is invoked when loading is complete with a pointer to the loaded scene.
|
||||
|
||||
## See Also
|
||||
|
||||
- [LoadScene](load-scene)
|
||||
|
||||
## Examples
|
||||
|
||||
```cpp
|
||||
void Example() {
|
||||
SceneManager& manager = SceneManager::Get();
|
||||
manager.LoadSceneAsync("assets/scenes/level1.scene", [](Scene* scene) {
|
||||
XC_LOG_INFO("Scene loaded: {}", scene->GetName());
|
||||
manager.SetActiveScene(scene);
|
||||
});
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user