Updated Tilemap.destroy documentation to clarify layer removal (issue phaserjs#740)

photonstorm · photonstorm · commit 1ef617ca82c4 · 2014-04-28T01:39:45.000+01:00
diff --git a/src/tilemap/Tilemap.js b/src/tilemap/Tilemap.js
@@ -1580,7 +1580,8 @@ Phaser.Tilemap.prototype = {
     },
 
     /**
-    * Removes all layers from this tile map and nulls the game reference.
+    * Removes all layer data from this tile map and nulls the game reference.
+    * Note: You are responsible for destroying any TilemapLayer objects you generated yourself, as Tilemap doesn't keep a reference to them.
     *
     * @method Phaser.Tilemap#destroy
     */

Original file line number	Diff line number	Diff line change
`@@ -1580,7 +1580,8 @@ Phaser.Tilemap.prototype = {`
`1580`	`1580`	`},`
`1581`	`1581`
`1582`	`1582`	`/**`
`1583`		`- * Removes all layers from this tile map and nulls the game reference.`
	`1583`	`+ * Removes all layer data from this tile map and nulls the game reference.`
	`1584`	`+ * Note: You are responsible for destroying any TilemapLayer objects you generated yourself, as Tilemap doesn't keep a reference to them.`
`1584`	`1585`	`*`
`1585`	`1586`	`* @method Phaser.Tilemap#destroy`
`1586`	`1587`	`*/`