Skip to content

Commit 11d845a

Browse files
committed
Specifically state this is a render flag only phaserjs#4574
1 parent bb0da19 commit 11d845a

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

src/gameobjects/components/Flip.js

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@ var Flip = {
1616

1717
/**
1818
* The horizontally flipped state of the Game Object.
19+
*
1920
* A Game Object that is flipped horizontally will render inversed on the horizontal axis.
2021
* Flipping always takes place from the middle of the texture and does not impact the scale value.
22+
* If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.
2123
*
2224
* @name Phaser.GameObjects.Components.Flip#flipX
2325
* @type {boolean}
@@ -28,8 +30,10 @@ var Flip = {
2830

2931
/**
3032
* The vertically flipped state of the Game Object.
33+
*
3134
* A Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)
3235
* Flipping always takes place from the middle of the texture and does not impact the scale value.
36+
* If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.
3337
*
3438
* @name Phaser.GameObjects.Components.Flip#flipY
3539
* @type {boolean}
@@ -41,6 +45,10 @@ var Flip = {
4145
/**
4246
* Toggles the horizontal flipped state of this Game Object.
4347
*
48+
* A Game Object that is flipped horizontally will render inversed on the horizontal axis.
49+
* Flipping always takes place from the middle of the texture and does not impact the scale value.
50+
* If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.
51+
*
4452
* @method Phaser.GameObjects.Components.Flip#toggleFlipX
4553
* @since 3.0.0
4654
*
@@ -71,6 +79,10 @@ var Flip = {
7179
/**
7280
* Sets the horizontal flipped state of this Game Object.
7381
*
82+
* A Game Object that is flipped horizontally will render inversed on the horizontal axis.
83+
* Flipping always takes place from the middle of the texture and does not impact the scale value.
84+
* If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.
85+
*
7486
* @method Phaser.GameObjects.Components.Flip#setFlipX
7587
* @since 3.0.0
7688
*
@@ -105,6 +117,10 @@ var Flip = {
105117
/**
106118
* Sets the horizontal and vertical flipped state of this Game Object.
107119
*
120+
* A Game Object that is flipped will render inversed on the flipped axis.
121+
* Flipping always takes place from the middle of the texture and does not impact the scale value.
122+
* If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.
123+
*
108124
* @method Phaser.GameObjects.Components.Flip#setFlip
109125
* @since 3.0.0
110126
*

0 commit comments

Comments
 (0)