Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Scenes

Hierarchy

  • Scenes

Index

Methods

Methods

Static clear

  • clear(): void

Static create

Static load

  • load(path: string, additive?: boolean): Promise<Scene>

  • Loads a scene asynchronously. When loading is done, the scene

    Parameters

    • path: string

      The scene path, for example 'Assets/Startup.Scene'

    • Default value additive: boolean = false

      If false, replaces all current scenes with this one. If true, add this to the current scenes.

    Returns Promise<Scene>

Static loadById

  • loadById(id: string): Promise<Scene>

Static preLoad

  • preLoad(path: string): Promise<unknown>

  • Preloads a scene asynchronously. After preloading is done, you must call Scenes.load() when you want the scene to become usable.

    Parameters

    • path: string

      The scene path

    Returns Promise<unknown>

Static unload

  • unload(scene: Scene): void

Static unloadByPath

  • unloadByPath(path: string): void