Class FlickerBehavior

A generalized behavior that encapsulates a flickering/glitching value (e.g. for broken lights, sparks, UI glitches). It calculates a multiplier (0.0 to 1.0) and passes it to the onUpdate callback.

Hierarchy (View Summary)

Behavior
- FlickerBehavior

Index

Constructors

Properties

isActive options target uuid inspector

Methods

onAttach onDetach update

Constructors

constructor

new FlickerBehavior(options: FlickerBehaviorOptions): FlickerBehavior
Creates a new FlickerBehavior.
Parameters
- options: FlickerBehaviorOptions
  Configuration options.
Returns FlickerBehavior
Overrides Behavior.constructor
- Defined in core/behaviors/FlickerBehavior.ts:98

Properties

isActive

isActive: boolean = true

options

options: Required<FlickerBehaviorOptions>

target

target: CameraInterfaceData | Object3D | undefined = undefined

The object this behavior is attached to. Set automatically.

`Readonly`uuid

uuid: string = ...

`Static` `Readonly`inspector

inspector: Record<string, InspectorField> = ...

Methods

onAttach

onAttach(target: CameraInterfaceData | Object3D): void
Called when the behavior is attached to an object.
Parameters
- target: CameraInterfaceData | Object3D
Returns void
Inherited from Behavior.onAttach
- Defined in core/behaviors/Behavior.ts:35

onDetach

onDetach(): void
Called when the behavior is detached from an object.

Returns void
Inherited from Behavior.onDetach
- Defined in core/behaviors/Behavior.ts:42

update

update(deltaTime: number): void
Called every frame to update the behavior logic.
Parameters
- deltaTime: number
  The time elapsed since the last frame in seconds.
Returns void
Overrides Behavior.update
- Defined in core/behaviors/FlickerBehavior.ts:112