_effect_effects_seizureeffect_.seizureeffect.md

@ericrabil/phea.js

Globals / "effect/effects/SeizureEffect" / SeizureEffect

Class: SeizureEffect

This does what it says – it rapidly strobes between the configured colors.

Specifically DO NOT use this if you are sensitive to flashing lights.

Hierarchy

• Effect

  ↳ SeizureEffect

Index

Constructors

• constructor

Properties

• enabled
• finished
• frames
• now
• options

Methods

• getColor
• render

Constructors

constructor

+ new SeizureEffect(options: SeizureOptions): SeizureEffect

Defined in src/effect/effects/SeizureEffect.ts:24

Parameters:

Name	Type
options	SeizureOptions

Returns: SeizureEffect

Properties

enabled

• enabled: boolean = true

Overrides Effect.enabled

Defined in src/effect/effects/SeizureEffect.ts:58

---

finished

• finished: boolean = this.options.framesPerColor === 0 || this.options.colors.length === 0

Overrides Effect.finished

Defined in src/effect/effects/SeizureEffect.ts:59

---

frames

• frames: number = 0

Defined in src/effect/effects/SeizureEffect.ts:24

How many frames into a color we are

---

now

• Readonly now: number

Inherited from Effect.now

Defined in src/effect/Effect.ts:11

Singleton reference to Date.now() – you don't/shouldn't update this, it is handled for you. All effects will have the same reference to Date.now() in any given frame.

---

options

• options: SeizureOptions

Defined in src/effect/effects/SeizureEffect.ts:26

Methods

getColor

▸ getColor(): EffectColor

Overrides Effect.getColor

Defined in src/effect/effects/SeizureEffect.ts:40

Returns: EffectColor

---

render

▸ render(): void

Overrides Effect.render

Defined in src/effect/effects/SeizureEffect.ts:44

Returns: void