Class: RotateTo

Phaser.Cameras.Scene2D.Effects. RotateTo

A Camera Rotate effect.

This effect will rotate the Camera so that the its viewport finishes at the given angle in radians, over the duration and with the ease specified.

Camera rotation always takes place based on the Camera viewport. By default, rotation happens in the center of the viewport. You can adjust this with the originX and originY properties.

Rotation influences the rendering of all Game Objects visible by this Camera. However, it does not rotate the Camera viewport itself, which always remains an axis-aligned rectangle.

Only the camera is rotates. None of the objects it is displaying are impacted, i.e. their positions do not change.

The effect will dispatch several events on the Camera itself and you can also specify an onUpdate callback, which is invoked each frame for the duration of the effect if required.


new RotateTo(camera)

Parameters:
Name Type Description
camera Phaser.Cameras.Scene2D.Camera

The camera this effect is acting upon.

Since: 3.23.0
Source: src/cameras/2d/effects/RotateTo.js (Line 12)

Members


<readonly> camera :Phaser.Cameras.Scene2D.Camera

The Camera this effect belongs to.

Type:
Since: 3.23.0
Source: src/cameras/2d/effects/RotateTo.js (Line 44)

clockwise :boolean

The direction of the rotation.

Type:
  • boolean
Since: 3.23.0
Source: src/cameras/2d/effects/RotateTo.js (Line 160)

current :number

The constantly updated value based on the force.

Type:
  • number
Since: 3.23.0
Source: src/cameras/2d/effects/RotateTo.js (Line 85)

destination :number

The destination angle in radians to rotate the camera to.

Type:
  • number
Since: 3.23.0
Source: src/cameras/2d/effects/RotateTo.js (Line 94)

<readonly> duration :integer

The duration of the effect, in milliseconds.

Type:
  • integer
Since: 3.23.0
Default Value:
  • 0
Source: src/cameras/2d/effects/RotateTo.js (Line 65)

ease :function

The ease function to use during the Rotate.

Type:
  • function
Since: 3.23.0
Source: src/cameras/2d/effects/RotateTo.js (Line 103)

<readonly> isRunning :boolean

Is this effect actively running?

Type:
  • boolean
Since: 3.23.0
Default Value:
  • false
Source: src/cameras/2d/effects/RotateTo.js (Line 54)

progress :number

If this effect is running this holds the current percentage of the progress, a value between 0 and 1.

Type:
  • number
Since: 3.23.0
Source: src/cameras/2d/effects/RotateTo.js (Line 112)

shortestPath :boolean

The shortest direction to the target rotation.

Type:
  • boolean
Since: 3.23.0
Source: src/cameras/2d/effects/RotateTo.js (Line 169)

source :number

The starting angle to rotate the camera from.

Type:
  • number
Since: 3.23.0
Source: src/cameras/2d/effects/RotateTo.js (Line 76)

Methods


destroy()

Destroys this effect, releasing it from the Camera.

Since: 3.23.0
Source: src/cameras/2d/effects/RotateTo.js (Line 410)

effectComplete()

Called internally when the effect completes.

Since: 3.23.0
Source: src/cameras/2d/effects/RotateTo.js (Line 379)

reset()

Resets this camera effect. If it was previously running, it stops instantly without calling its onComplete callback or emitting an event.

Since: 3.23.0
Source: src/cameras/2d/effects/RotateTo.js (Line 395)

start(radians [, shortestPath] [, duration] [, ease] [, force] [, callback] [, context])

This effect will scroll the Camera so that the center of its viewport finishes at the given angle, over the duration and with the ease specified.

Parameters:
Name Type Argument Default Description
radians number

The destination angle in radians to rotate the Camera viewport to. If the angle is positive then the rotation is clockwise else anticlockwise

shortestPath boolean <optional>
false

If shortest path is set to true the camera will rotate in the quickest direction clockwise or anti-clockwise.

duration integer <optional>
1000

The duration of the effect in milliseconds.

ease string | function <optional>
'Linear'

The ease to use for the Rotate. Can be any of the Phaser Easing constants or a custom function.

force boolean <optional>
false

Force the rotation effect to start immediately, even if already running.

callback CameraRotateCallback <optional>

This callback will be invoked every frame for the duration of the effect. It is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is, the current camera scroll x coordinate and the current camera scroll y coordinate.

context any <optional>

The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.

Since: 3.23.0
Source: src/cameras/2d/effects/RotateTo.js (Line 179)
Fires:
Returns:

The Camera on which the effect was started.

Type
Phaser.Cameras.Scene2D.Camera

update(time, delta)

The main update loop for this effect. Called automatically by the Camera.

Parameters:
Name Type Description
time integer

The current timestamp as generated by the Request Animation Frame or SetTimeout.

delta number

The delta time, in ms, elapsed since the last frame.

Since: 3.23.0
Source: src/cameras/2d/effects/RotateTo.js (Line 299)