_effect_effects_transitioneffect_.transitioneffect.md

@ericrabil/phea.js

Globals / "effect/effects/TransitionEffect" / TransitionEffect

Class: TransitionEffect

Smoothly transitions between configured frames

Hierarchy

• Effect

  ↳ TransitionEffect

Index

Constructors

• constructor

Properties

• dead
• enabled
• frames
• now
• options

Accessors

• finished

Methods

• getColor
• render

Constructors

constructor

+ new TransitionEffect(frames: TransitionFrame[], options?: TransitionOptions): TransitionEffect

Defined in src/effect/effects/TransitionEffect.ts:25

Parameters:

Name	Type	Default value
frames	TransitionFrame[]	-
options	TransitionOptions	{}

Returns: TransitionEffect

Properties

dead

• dead: boolean = false

Defined in src/effect/effects/TransitionEffect.ts:77

---

enabled

• enabled: boolean = true

Overrides Effect.enabled

Defined in src/effect/effects/TransitionEffect.ts:76

---

frames

• frames: TransitionFrame[]

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

---

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

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

Accessors

finished

• get finished(): boolean

Overrides Effect.finished

Defined in src/effect/effects/TransitionEffect.ts:122

Returns true if there are no more frames to render, or if it is flagged as dead

Returns: boolean

Methods

getColor

▸ getColor(): EffectColor

Overrides Effect.getColor

Defined in src/effect/effects/TransitionEffect.ts:42

Returns: EffectColor

---

render

▸ render(): void

Overrides Effect.render

Defined in src/effect/effects/TransitionEffect.ts:46

Returns: void