Class ShakeEffect

A screen shake effect for the camera.

Hierarchy (View Summary)

AbstractCameraEffect
- ShakeEffect

Index

Constructors

Properties

isFinished offset targetOffset type

Methods

Constructors

constructor

new ShakeEffect(intensity?: number, duration?: number): ShakeEffect
Creates a new ShakeEffect.
Parameters
- intensity: number = 0.5
  The maximum intensity of the shake.
- duration: number = 0.5
  The duration of the shake in seconds.
Returns ShakeEffect
Overrides AbstractCameraEffect.constructor
- Defined in core/cameras/effects/ShakeEffect.ts:22

Properties

isFinished

isFinished: boolean = false

Whether the effect has finished its duration and should be removed.

`Readonly`offset

offset: Vector3D = ...

The current position offset generated by this effect.

`Readonly`targetOffset

targetOffset: Vector3D = ...

The current target offset generated by this effect.

`Readonly`type

type: CameraEffectType = CameraEffectType.SHAKE

The unique type identifier of the effect.

Methods

update

update(deltaTime: number): void
Updates the effect state.
Parameters
- deltaTime: number
  Time elapsed since the last frame in seconds.
Returns void
Overrides AbstractCameraEffect.update
- Defined in core/cameras/effects/ShakeEffect.ts:29