Skip to content
On this page

AthenaClient.screen.screenEffect

Functions

isEffectActive

Usage

AthenaClient.screen.screenEffect.isEffectActive(screenEffect): any

Check whether the specific screen effect is running.

Parameters

NameTypeDescription
screenEffectSCREEN_EFFECTSThe ScreenEffect to check.

Returns

any

true if the screen effect is active; otherwise false

Defined in

client/screen/screenEffect.ts:9


startEffect

Usage

AthenaClient.screen.screenEffect.startEffect(screenEffect, duration?, looped?): void

Starts applying the specified effect to the screen.

Parameters

NameTypeDefault valueDescription
screenEffectSCREEN_EFFECTSundefinedThe ScreenEffect to start playing.
durationnumber0The duration of the effect in milliseconds or zero to use the default length.
loopedbooleanfalseIf true the effect won't stop until stopEffect(ScreenEffect) is called.

Returns

void

Defined in

client/screen/screenEffect.ts:19


stopAllEffects

Usage

AthenaClient.screen.screenEffect.stopAllEffects(): void

Stops all currently running effects.

Returns

void

Defined in

client/screen/screenEffect.ts:34


stopEffect

Usage

AthenaClient.screen.screenEffect.stopEffect(screenEffect): void

Stops applying the specified effect to the screen.

Parameters

NameTypeDescription
screenEffectSCREEN_EFFECTSThe ScreenEffect to stop playing.

Returns

void

Defined in

client/screen/screenEffect.ts:27

Created by Stuyk | Est. 2020