Function: shakeEffect()

> shakeEffect(alias, options?, priority?): Promise<string[] | undefined>

Defined in: src/canvas/functions/canvas-effect.ts:13

Shake the canvas element. If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.

Parameters

alias

string

The alias to identify the component.

options?

ShakeEffectProps = {}

Animation options, matching the options of animate function.

priority?

UPDATE_PRIORITY

The priority of the PixiJS ticker. This parameter sets the ticker's priority.

Returns

Promise<string[] | undefined>