_effect_effects_staticeffect_.staticeffect.md

@ericrabil/phea.js

Globals / "effect/effects/StaticEffect" / StaticEffect

Class: StaticEffect

Returns a single color, forever. This can be mutated externally to make it not a single color, but doesn't offer much customization.

Hierarchy

• Effect

  ↳ StaticEffect

Index

Constructors

• constructor

Properties

• color
• enabled
• finished
• now

Methods

• getColor
• render

Constructors

constructor

+ new StaticEffect(color: EffectColor): StaticEffect

Defined in src/effect/effects/StaticEffect.ts:7

Parameters:

Name	Type
color	EffectColor

Returns: StaticEffect

Properties

color

• color: EffectColor

Defined in src/effect/effects/StaticEffect.ts:8

---

enabled

• enabled: boolean = false

Overrides Effect.enabled

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

---

finished

• finished: boolean = false

Overrides Effect.finished

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

---

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.

Methods

getColor

▸ getColor(): EffectColor

Overrides Effect.getColor

Defined in src/effect/effects/StaticEffect.ts:12

Returns: EffectColor

---

render

▸ render(): void

Overrides Effect.render

Defined in src/effect/effects/StaticEffect.ts:16

Returns: void