Skip to content

Commit 367d976

Browse files
committed
Loader: documentation
- Corrected some documentation wrt. parallel downloading
1 parent b63f687 commit 367d976

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

src/loader/Loader.js

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
*
1111
* The loader uses a combination of tag loading (eg. Image elements) and XHR and provides progress and completion callbacks.
1212
*
13-
* Parallel loading is supported but must be enabled explicitly with {@link Phaser.Loader#enableParallel enableParallel}.
14-
* Load-before behavior of parallel resources is controlled by synchronization points as discussed in {@link Phaser.Loader#withSyncPoint withSyncPoint}.
13+
* Parallel loading (see {@link #enableParallel}) is supported and enabled by default.
14+
* Load-before behavior of parallel resources is controlled by synchronization points as discussed in {@link #withSyncPoint}.
1515
*
1616
* Texture Atlases can be created with tools such as [Texture Packer](https://www.codeandweb.com/texturepacker/phaser) and
1717
* [Shoebox](http://renderhjs.net/shoebox/)
@@ -141,13 +141,16 @@ Phaser.Loader = function (game) {
141141
this._warnedAboutXDomainRequest = false;
142142

143143
/**
144-
* If true then parallel downloading will be enabled.
144+
* If true (the default) then parallel downloading will be enabled.
145+
*
146+
* To disable all parallel downloads this must be set to false prior to any resource being loaded.
147+
*
145148
* @property {integer} enableParallel
146149
*/
147150
this.enableParallel = true;
148151

149152
/**
150-
* The number of concurrent assets to try and fetch at once.
153+
* The number of concurrent / parallel resources to try and fetch at once.
151154
*
152155
* Many current browsers limit 6 requests per domain; this is slightly conservative.
153156
*

0 commit comments

Comments
 (0)