Added lots more info to the jsdocs and tidied up the code for phaserjs#2056

photonstorm · photonstorm · commit 96de58cc5ff8 · 2015-09-19T11:50:26.000+01:00
diff --git a/README.md b/README.md
@@ -266,6 +266,7 @@ If you are an exceptional JavaScript developer and would like to join the Phaser
 * Tiled 0.13.0 added support for layer data compression when exporting as JSON. This means that any .tmx stored using base64 encoding will start exporting layer data as a base64 encoded string rather than a native array. This update adds in automatic support for this as long as the data isn't compressed. For IE9 support you'll need to use the new polyfill found in the resources folder (thanks @noidexe #2084)
 * You can now load single layer Pyxel Edit TileMaps as an atlas (thanks @joshpmcghee #2050)
 * Canvas.getSmoothingPrefix will return the vendor prefixed smoothing enabled value from the context if set, otherwise null.
+* The Random Number Generator can now get and set its state via rnd.state. This allows you to do things like saving the state of the generator to a string that can be part of a save-game file and load it back in again (thanks @luckylooke #2056 #1900)
 
 ### Updates
 
@@ -283,6 +284,7 @@ If you are an exceptional JavaScript developer and would like to join the Phaser
 * DeviceButton was setting a `duration` property on itself, which went against the read only getter of duration (thanks @winstonwolff)
 * Added Node.js v4 stable to Travis config (thanks @phillipalexander #2070)
 * Optimised Canvas.getSmoothingEnabled, Canvas.setSmoothingEnabled and Canvas.setImageRenderingCrisp.
+* The Physics Editor Exporter (found in the resources folder of the repo) has had an option to prefix shape names and optimize JSON output added to it (thanks @Garbanas #2093)
 
 ### Bug Fixes
 
@@ -293,6 +295,7 @@ If you are an exceptional JavaScript developer and would like to join the Phaser
 * Game.update could call `updateLogic` multiple times in a single frame when catching up with slow device frame rates. This would cause Tweens to advance at twice the speed they should have done (thanks @mkristo)
 * Added useCapture flags to removeEventListener in MSPointer class (thanks @pmcmonagle #2055)
 * Under setTimeOut (or when `forceSetTimeOut` was true) the Time was incorrectly setting `Time.timeExpected` causing game updates to lag (thanks @satan6 #2087)
+* Fixes edge case when TilingSprite is removed before render (thanks @pnstickne #2097 #2092)
 
 ### Pixi Updates
 
diff --git a/src/math/RandomDataGenerator.js b/src/math/RandomDataGenerator.js
@@ -18,7 +18,7 @@
 *
 * @class Phaser.RandomDataGenerator
 * @constructor
-* @param {any[]|String} [seeds] - An array of values to use as the seed or a generator state (from {#state}).
+* @param {any[]|string} [seeds] - An array of values to use as the seed, or a generator state (from {#state}).
 */
 Phaser.RandomDataGenerator = function (seeds) {
 
@@ -48,9 +48,12 @@ Phaser.RandomDataGenerator = function (seeds) {
     */
     this.s2 = 0;
 
-    if((typeof seeds === 'string' || seeds instanceof String) && seeds.match(/^!rnd/)){
+    if (typeof seeds === 'string')
+    {
         this.state(seeds);
-    }else{
+    }
+    else
+    {
         this.sow(seeds);
     }
 
@@ -305,21 +308,34 @@ Phaser.RandomDataGenerator.prototype = {
     },
 
     /**
-    * Sets or gets state of the generator
+    * Gets or Sets the state of the generator. This allows you to retain the values
+    * that the generator is using between games, i.e. in a game save file.
+    * 
+    * To seed this generator with a previously saved state you can pass it as the 
+    * `seed` value in your game config, or call this method directly after Phaser has booted.
+    *
+    * Call this method with no parameters to return the current state.
+    * 
+    * If providing a state it should match the same format that this method
+    * returns, which is a string with a header `!rnd` followed by the `c`,
+    * `s0`, `s1` and `s2` values respectively, each comma-delimited. 
     *
     * @method Phaser.RandomDataGenerator#state
-    * @param {String} [state] Generator state to be set.
-    * @return {String} Actual generator state.
+    * @param {string} [state] - Generator state to be set.
+    * @return {string} The current state of the generator.
     */
     state: function (state) {
 
-        if(state){
+        if (typeof state === 'string' && seeds.match(/^!rnd/))
+        {
             state = state.split(',');
+
             this.c = parseFloat(state[1]);
             this.s0 = parseFloat(state[2]);
             this.s1 = parseFloat(state[3]);
             this.s2 = parseFloat(state[4]);
         }
+
         return ['!rnd', this.c, this.s0, this.s1, this.s2].join(',');
 
     }
