Skip to content

Commit 4fa1ffb

Browse files
committed
JSDocs update.
1 parent 99fbf35 commit 4fa1ffb

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

src/gameobjects/BitmapData.js

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1417,11 +1417,16 @@ Phaser.BitmapData.prototype = {
14171417
* If a child has an `exists` property then it (and its children) will be only be drawn if exists is `true`.
14181418
*
14191419
* The children will be drawn at their `x` and `y` world space coordinates. If this is outside the bounds of the BitmapData
1420-
* they won't be drawn. You should resize the BitmapData in advance to match the overall bounds of the top-level Game Object.
1420+
* they won't be drawn. Depending on your requirements you may need to resize the BitmapData in advance to match the
1421+
* bounds of the top-level Game Object.
14211422
*
14221423
* When drawing it will take into account the child's world rotation, scale and alpha values.
14231424
*
14241425
* It's perfectly valid to pass in `game.world` as the parent object, and it will iterate through the entire display list.
1426+
*
1427+
* Note: If you are trying to grab your entire game at the start of a State then you should ensure that at least 1 full update
1428+
* has taken place before doing so, otherwise all of the objects will render with incorrect positions and scales. You can
1429+
* trigger an update yourself by calling `stage.updateTransform()` before calling `drawFull`.
14251430
*
14261431
* @method Phaser.BitmapData#drawFull
14271432
* @param {Phaser.World|Phaser.Group|Phaser.Sprite|Phaser.Image|Phaser.Text|Phaser.BitmapText} parent - The Game Object to draw onto this BitmapData and then recursively draw all of its children.

0 commit comments

Comments
 (0)