Method replace

GDJS/Runtime/scenestack.ts:246–274

* Start the scene in `options.sceneName`, replacing the one currently being played. * If `options.clear` is set to true, all running scenes are also removed from the stack of scenes. * * @param options Contains the scene name and optional external layout name to instantiate. * @p

(
      options: ReplaceSceneOptions | string,
      deprecatedClear?: boolean
    )

     * @param deprecatedClear Deprecated, use `options.clear` instead.
     */
    replace(
      options: ReplaceSceneOptions | string,
      deprecatedClear?: boolean
    ): gdjs.RuntimeScene | null {
      const clear =
        deprecatedClear || typeof options === 'string' ? false : options.clear;
      const newSceneName =
        typeof options === 'string' ? options : options.sceneName;

      this._throwIfDisposed();
      if (!!clear) {
        // Unload all the scenes
        while (this._stack.length !== 0) {
          let scene = this._stack.pop();
          if (scene) {
            this._unloadSceneAndPossiblyResources({ scene, newSceneName });
          }
        }
      } else {
        // Unload the current scene
        if (this._stack.length !== 0) {
          let scene = this._stack.pop();
          if (scene) {
            this._unloadSceneAndPossiblyResources({ scene, newSceneName });
          }
        }
      }
      return this.push(options);
    }

    /**
     * Return the current gdjs.RuntimeScene being played, or null if none is run.