Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord
Namespace: Flip
Phaser.GameObjects.Components.Flip

Members

flipX: boolean
Focus
Focus

Description:

The horizontally flipped state of the Game Object.

A Game Object that is flipped horizontally will render inversed on the horizontal axis. Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.

Type:
boolean
Default: false
Since: 3.0.0
Focus
Focus
flipY: boolean
Focus
Focus

Description:

The vertically flipped state of the Game Object.

A Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down) Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.

Type:
boolean
Default: false
Since: 3.0.0
Focus
Focus

Methods

toggleFlipX()
Focus
Focus

Description:

Toggles the horizontal flipped state of this Game Object.

A Game Object that is flipped horizontally will render inversed on the horizontal axis. Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.

Returns:
Description:

This Game Object instance.

Examples:
Since: 3.0.0
Focus
Focus
toggleFlipY()
Focus
Focus

Description:

Toggles the vertical flipped state of this Game Object.

Returns:
Description:

This Game Object instance.

Examples:
Since: 3.0.0
Focus
Focus
setFlipX(value)
Focus
Focus

Description:

Sets the horizontal flipped state of this Game Object.

A Game Object that is flipped horizontally will render inversed on the horizontal axis. Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.

Parameters:

name type description
value boolean

The flipped state. false for no flip, or true to be flipped.

Returns:
Description:

This Game Object instance.

Examples:
Since: 3.0.0
Focus
Focus
setFlipY(value)
Focus
Focus

Description:

Sets the vertical flipped state of this Game Object.

Parameters:

name type description
value boolean

The flipped state. false for no flip, or true to be flipped.

Returns:
Description:

This Game Object instance.

Examples:
Since: 3.0.0
Focus
Focus
setFlip(x, y)
Focus
Focus

Description:

Sets the horizontal and vertical flipped state of this Game Object.

A Game Object that is flipped will render inversed on the flipped axis. Flipping always takes place from the middle of the texture and does not impact the scale value. If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.

Parameters:

name type description
x boolean

The horizontal flipped state. false for no flip, or true to be flipped.

y boolean

The horizontal flipped state. false for no flip, or true to be flipped.

Returns:
Description:

This Game Object instance.

Examples:
Since: 3.0.0
Focus
Focus
resetFlip()
Focus
Focus

Description:

Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.

Returns:
Description:

This Game Object instance.

Examples:
Since: 3.0.0
Focus
Focus