_effect_effects_loopeffect_.loopeffect.md

@ericrabil/phea.js

Globals / "effect/effects/LoopEffect" / LoopEffect

Class: LoopEffect

Smooth transitions between each color

Hierarchy

• Effect

  ↳ LoopEffect

Index

Constructors

• constructor

Properties

• currentColor
• currentIndex
• enabled
• finished
• frame
• nextColor
• now
• options
• resultColor

Methods

• getColor
• render

Constructors

constructor

+ new LoopEffect(options: LoopOptions): LoopEffect

Defined in src/effect/effects/LoopEffect.ts:13

Parameters:

Name	Type
options	LoopOptions

Returns: LoopEffect

Properties

currentColor

• currentColor: EffectColor = this.options.colors[0]

Defined in src/effect/effects/LoopEffect.ts:21

---

currentIndex

• currentIndex: number = 0

Defined in src/effect/effects/LoopEffect.ts:20

---

enabled

• enabled: boolean = true

Overrides Effect.enabled

Defined in src/effect/effects/LoopEffect.ts:50

---

finished

• finished: boolean = false

Overrides Effect.finished

Defined in src/effect/effects/LoopEffect.ts:51

---

frame

• frame: number = 0

Defined in src/effect/effects/LoopEffect.ts:18

---

nextColor

• nextColor: EffectColor = this.options.colors[1]

Defined in src/effect/effects/LoopEffect.ts:22

---

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: LoopOptions

Defined in src/effect/effects/LoopEffect.ts:14

---

resultColor

• resultColor: EffectColor

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

Methods

getColor

▸ getColor(): EffectColor

Overrides Effect.getColor

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

Returns: EffectColor

---

render

▸ render(): void

Overrides Effect.render

Defined in src/effect/effects/LoopEffect.ts:30

Returns: void