document jaws.assets.displayProgress

ippa · Mar 5, 2013 · 52789fb · 52789fb
1 parent 2a3b9bb
commit 52789fb
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/assets.js b/src/assets.js
@@ -226,6 +226,14 @@ jaws.Assets = function Assets() {
       that.onfinish = null
     }
   }
+
+  /*
+   * This is called when assets are loaded, for example by using jaws.start().
+   * It's called once per finished asset with a single argument, percect (0-100) of the total assets finished.
+   *
+   * If you want to paint your own loading screen:
+   *   jaws.assets.displayProgress = function(percent_done) { /* your elite code */ }
+   */
   this.displayProgress = function(percent_done) {
     if(!jaws.context) return;