[DOCS] Updated tests and docs for sceneRegistry loadScene* functions (playcanvas#2009)

yaustar · Steven Yau · willeastcott · web-flow · commit 5f404459538c · 2020-05-12T09:48:57.000+01:00
* Removed app.loadScene* callbacks from docs

* Updated code sample in documentation getSceneUrl

* Removed loadScene from public API

* Added callbacks for the SceneRegistry load* functions

* Updated tests to use SceneRegistry instead of deprecated app function

* Update test to use pc.SceneRegistry

* Load Scene is public again, removed unused callbacks

* Removed callbacks.loadScene from private API

* Better param docs for callbacks.

* Remove new line

* Fix callback types

Co-authored-by: Steven Yau &lt;syau@snaphcat.com&gt;
Co-authored-by: Will Eastcott &lt;will@playcanvas.com&gt;
diff --git a/src/callbacks.js b/src/callbacks.js
@@ -52,20 +52,20 @@
 
 /**
  * @callback pc.callbacks.LoadHierarchy
- * @description Callback used by {@link pc.Application#loadSceneHierarchy}.
+ * @description Callback used by {@link pc.SceneRegistry#loadSceneHierarchy}.
  * @param {string|null} err - The error message in the case where the loading or parsing fails.
  * @param {pc.Entity} [entity] - The loaded root entity if no errors were encountered.
  */
 
 /**
  * @callback pc.callbacks.LoadSettings
- * @description Callback used by {@link pc.Application#loadSceneSettings}.
+ * @description Callback used by {@link pc.SceneRegistry#loadSceneSettings}.
  * @param {string|null} err - The error message in the case where the loading or parsing fails.
  */
 
 /**
  * @callback pc.callbacks.LoadScene
- * @description Callback used by {@link pc.Application#loadScene}.
+ * @description Callback used by {@link pc.SceneRegistry#loadScene}.
  * @param {string|null} err - The error message in the case where the loading or parsing fails.
  * @param {pc.Entity} [entity] - The loaded root entity if no errors were encountered.
  */
diff --git a/src/framework/scene-registry.js b/src/framework/scene-registry.js
@@ -129,11 +129,12 @@ Object.assign(pc, function () {
      * @description Load a scene file, create and initialize the Entity hierarchy
      * and add the hierarchy to the application root Entity.
      * @param {string} url - The URL of the scene file. Usually this will be "scene_id.json".
-     * @param {Function} callback - The function to call after loading, passed (err, entity) where err is null if no errors occurred.
+     * @param {pc.callbacks.LoadHierarchy} callback - The function to call after loading,
+     * passed (err, entity) where err is null if no errors occurred.
      * @example
      *
-     * var url = app.getSceneUrl("Scene Name");
-     * app.loadSceneHierarchy(url, function (err, entity) {
+     * var url = app.scenes.getSceneUrl("Scene Name");
+     * app.scenes.loadSceneHierarchy(url, function (err, entity) {
      *     if (!err) {
      *         var e = app.root.find("My New Entity");
      *     } else {
@@ -188,7 +189,8 @@ Object.assign(pc, function () {
      * @name pc.SceneRegistry#loadSceneSettings
      * @description Load a scene file and apply the scene settings to the current scene.
      * @param {string} url - The URL of the scene file. This can be looked up using app.getSceneUrl.
-     * @param {Function} callback - The function called after the settings are applied. Passed (err) where err is null if no error occurred.
+     * @param {pc.callbacks.LoadSettings} callback - The function called after the settings
+     * are applied. Passed (err) where err is null if no error occurred.
      * @example
      *
      * var url = app.getSceneUrl("Scene Name");
@@ -226,9 +228,12 @@ Object.assign(pc, function () {
     /**
      * @function
      * @name  pc.SceneRegistry#loadScene
-     * @description Load the scene hierarchy and scene settings. This is an internal method used by the pc.Application.
-     * @param  {string}   url -      The URL of the scene file.
-     * @param  {Function} callback - The function called after the settings are applied. Passed (err, scene) where err is null if no error occurred and scene is the pc.Scene.
+     * @description Load the scene hierarchy and scene settings. This is an internal method used
+     * by the pc.Application.
+     * @param {string} url - The URL of the scene file.
+     * @param {pc.callbacks.LoadScene} callback - The function called after the settings are
+     * applied. Passed (err, scene) where err is null if no error occurred and scene is the
+     * {@link pc.Scene}.
      */
     SceneRegistry.prototype.loadScene =  function (url, callback) {
         var self = this;
diff --git a/tests/framework/components/script/test_script_component.js b/tests/framework/components/script/test_script_component.js
@@ -275,7 +275,7 @@ describe("pc.ScriptComponent", function () {
                 console.error(err);
             }
 
-            app.loadScene('base/tests/framework/components/script/scene1.json', function () {
+            app.scenes.loadScene('base/tests/framework/components/script/scene1.json', function () {
                 app.start();
                 done();
             });
@@ -1878,7 +1878,7 @@ describe("pc.ScriptComponent", function () {
         app.root.children[0].destroy();
 
         window.initializeCalls.length = 0;
-        app.loadScene('base/tests/framework/components/script/scene2.json', function () {
+        app.scenes.loadScene('base/tests/framework/components/script/scene2.json', function () {
             var e = app.root.findByName('A');
             var other = app.root.findByName('B');
 
