Add clairifying note to fix phaserjs#3193

mikewesthad · mikewesthad · commit 63123250d177 · 2018-01-26T15:34:03.000-06:00
diff --git a/src/gameobjects/tilemap/Tilemap.js b/src/gameobjects/tilemap/Tilemap.js
@@ -214,6 +214,8 @@ var Tilemap = new Class({
      * Turns the StaticTilemapLayer associated with the given layer into a DynamicTilemapLayer. If
      * no layer specified, the map's current layer is used. This is useful if you want to manipulate
      * a map at the start of a scene, but then make it non-manipulable and optimize it for speed.
+     * Note: the DynamicTilemapLayer passed in is destroyed, so make sure to store the value
+     * returned from this method if you want to manipulate the new StaticTilemapLayer.
      *
      * @param {string|integer|DynamicTilemapLayer} [layer] - The name of the layer from Tiled, the
      * index of the layer in the map, or a StaticTilemapLayer.

Original file line number	Diff line number	Diff line change
`@@ -214,6 +214,8 @@ var Tilemap = new Class({`
`214`	`214`	`* Turns the StaticTilemapLayer associated with the given layer into a DynamicTilemapLayer. If`
`215`	`215`	`* no layer specified, the map's current layer is used. This is useful if you want to manipulate`
`216`	`216`	`* a map at the start of a scene, but then make it non-manipulable and optimize it for speed.`
	`217`	`+ * Note: the DynamicTilemapLayer passed in is destroyed, so make sure to store the value`
	`218`	`+ * returned from this method if you want to manipulate the new StaticTilemapLayer.`
`217`	`219`	`*`
`218`	`220`	`* @param {string\|integer\|DynamicTilemapLayer} [layer] - The name of the layer from Tiled, the`
`219`	`221`	`* index of the layer in the map, or a StaticTilemapLayer.`