ReadonlycameraThe Camera this effect belongs to.
The direction of the rotation. Clockwise is positive.
The current camera angle during the rotation, in radians.
The destination angle to rotate the camera to, in radians.
ReadonlydurationThe duration of the effect, in milliseconds.
The ease function to use during the rotation.
ReadonlyisIs this effect actively running?
If this effect is running this holds the current progress, a value between 0 (start) and 1 (end).
The shortest direction to the target rotation.
The starting angle to rotate the camera from, in radians.
Destroys this effect, releasing it from the Camera.
Called internally when the effect completes.
Resets this camera effect. If it was previously running, it stops instantly without calling its onComplete callback or emitting an event.
Rotate the Camera to the given angle over the duration and with the ease specified.
The destination angle in radians to rotate the Camera view to.
OptionalshortestPath: booleanIf true, take the shortest distance to the destination. This adjusts the destination angle to be within one half turn of the start angle. Default false.
Optionalduration: numberThe duration of the effect in milliseconds. Default 1000.
Optionalease: string | FunctionThe ease to use. Can be any of the Phaser Easing constants or a custom function. Default 'Linear'.
Optionalforce: booleanForce the rotation effect to start immediately, even if already running. Default false.
Optionalcallback: CameraRotateCallbackThis callback will be invoked every frame for the duration of the effect. It is sent three arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is, and the current camera rotation.
Optionalcontext: anyThe context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.
The main update loop for this effect. Called automatically by the Camera.
The current timestamp as generated by the Request Animation Frame or SetTimeout.
The delta time, in ms, elapsed since the last frame.
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
originXandoriginYproperties.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
onUpdatecallback, which is invoked each frame for the duration of the effect if required.