The Framework
  • Introduction
    • What is The Framework
    • Core Objectives
    • Key Features
    • Architecture Overview
    • Benefits
    • Conclusion
  • Getting Started
    • Installation
  • Quick Setup
    • Unity Setup
    • Creating a Scene
    • Creating a Bootstrap
    • Creating a Canvas
  • API Reference
    • Scene Management
      • ICanvas
      • INavigationService
      • IDataService
      • IBootstrap
      • IAsyncScene
Powered by GitBook
On this page
  • Members
  • Methods
  1. API Reference
  2. Scene Management

INavigationService

Members

Methods

  • Initialise

    • Description: Initializes the navigation service.

    • Returns: A task representing the asynchronous operation.

  • ShowSceneAsync<T>(bool setActive)

    • Description: Shows a supplementary scene and returns a handle to its bootstrap instance.

    • Type Parameters:

      • T: The type of the bootstrap instance.

    • Parameters:

      • setActive: Indicates whether to set the loaded scene as active. Defaults to false.

    • Returns: A task representing the asynchronous operation. The result contains the bootstrap instance for the loaded scene.

  • GetSceneHandle<T>()

    • Description: Retrieves an existing bootstrap instance of a loaded scene.

    • Type Parameters:

      • T: The type of the bootstrap instance.

    • Returns: The bootstrap instance if it exists; otherwise, null.

  • UnloadAsync(IAsyncScene sceneHandle)

    • Description: Unloads a specified scene.

    • Parameters:

      • sceneHandle: The handle to the scene to unload.

    • Returns: A task representing the asynchronous unload operation.

PreviousICanvasNextIDataService

Last updated 6 months ago