V5 DocsAthenaClient.screen.screenEffect ​
Functions ​
isEffectActive ​
Usage
AthenaClient.screen.screenEffect.isEffectActive(screenEffect): any
Check whether the specific screen effect is running.
Parameters ​
| Name | Type | Description |
|---|---|---|
screenEffect | SCREEN_EFFECTS | The 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 ​
| Name | Type | Default value | Description |
|---|---|---|---|
screenEffect | SCREEN_EFFECTS | undefined | The ScreenEffect to start playing. |
duration | number | 0 | The duration of the effect in milliseconds or zero to use the default length. |
looped | boolean | false | If 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 ​
| Name | Type | Description |
|---|---|---|
screenEffect | SCREEN_EFFECTS | The ScreenEffect to stop playing. |
Returns ​
void