Class FlashEffect

A flash effect for the camera (simulated via target offset or potentially other means). Note: A real flash might need renderer support, but here we can simulate a 'jolt'.

Hierarchy (View Summary)

AbstractCameraEffect
- FlashEffect

Index

Constructors

constructor

new FlashEffect(intensity?: number, duration?: number): FlashEffect
Creates a new FlashEffect.
Parameters
- intensity: number = 1.0
  The intensity of the flash.
- duration: number = 0.2
  The duration of the flash in seconds.
Returns FlashEffect
Overrides AbstractCameraEffect.constructor
- Defined in core/cameras/effects/FlashEffect.ts:23

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.FLASH

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/FlashEffect.ts:30

Class FlashEffect

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlashEffect

Properties

isFinished

`Readonly`offset

`Readonly`targetOffset

`Readonly`type

Methods

update

Parameters

Returns void

Settings

On This Page

Class FlashEffect

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlashEffect

Properties

isFinished

Readonlyoffset

ReadonlytargetOffset

Readonlytype

Methods

update

Parameters

Returns void

Settings

On This Page

`Readonly`offset

`Readonly`targetOffset

`Readonly`type