# Function: shockwaveEffect() (/pixi-vn/index/namespaces/effects/functions/shockwaveEffect)



\> **shockwaveEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:566](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L566)

Shockwave the canvas element: a single radial ripple distortion travels outward from an origin
point and fades ([ShockwaveFilter](https://pixijs.io/filters/docs/ShockwaveFilter.html)) -
a one-shot impact, not a repeated oscillation.

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`ShockwaveEffectProps`](/pixi-vn/index/interfaces/ShockwaveEffectProps) = `{}`

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>