Filter
A Smoothed Key Camera Control.
This allows you to control the movement and zoom of a camera using the defined keys. Unlike the Fixed Camera Control you can also provide physics values for acceleration, drag and maxSpeed for smoothing effects.
var controlConfig = {
camera: this.cameras.main,
left: cursors.left,
right: cursors.right,
up: cursors.up,
down: cursors.down,
zoomIn: this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.Q),
zoomOut: this.input.keyboard.addKey(Phaser.Input.Keyboard.KeyCodes.E),
zoomSpeed: 0.02,
acceleration: 0.06,
drag: 0.0005,
maxSpeed: 1.0
};
You must call the update method of this controller every frame.
Constructor:
new SmoothedKeyControl(config)
Parameters:
| name | type | description |
|---|---|---|
| config | Phaser.Types.Cameras.Controls.SmoothedKeyControlConfig |
The Smoothed Key Control configuration object. |
Members
Description:
The horizontal acceleration the camera will move.
Type:
Description:
The vertical acceleration the camera will move.
Type:
Description:
A flag controlling if the Controls will update the Camera or not.
Type:
Description:
The Camera that this Control will update.
Description:
The Key to be pressed that will move the Camera down.
Description:
The horizontal drag applied to the camera when it is moving.
Type:
Description:
The vertical drag applied to the camera when it is moving.
Type:
Description:
The Key to be pressed that will move the Camera left.
Description:
The maximum horizontal speed the camera will move.
Type:
Description:
The maximum vertical speed the camera will move.
Type:
Description:
The largest zoom value the camera will reach when zoomed in.
Type:
Description:
The smallest zoom value the camera will reach when zoomed out.
Type:
Description:
The Key to be pressed that will move the Camera right.
Description:
The Key to be pressed that will move the Camera up.
Description:
The Key to be pressed that will zoom the Camera in.
Description:
The Key to be pressed that will zoom the Camera out.
Description:
The speed at which the camera will zoom if the zoomIn or zoomOut keys are pressed.
Type:
Methods
Description:
Destroys this Key Control.
Description:
Binds this Key Control to a camera.
Parameters:
| name | type | description |
|---|---|---|
| camera | Phaser.Cameras.Scene2D.Camera |
The camera to bind this Key Control to. |
Returns:
Description:
This Key Control instance.
Description:
Starts the Key Control running, providing it has been linked to a camera.
Returns:
Description:
This Key Control instance.
Description:
Stops this Key Control from running. Call start to start it again.
Returns:
Description:
This Key Control instance.
Description:
Applies the results of pressing the control keys to the Camera.
You must call this every step, it is not called automatically.
Parameters:
| name | type | description |
|---|---|---|
| delta | number |
The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate. |