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



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

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

Punch the canvas element: a single fast impulse (position, rotation, or scale) with a strong
attack and a short, slightly overshooting recovery back to rest - unlike every other effect here,
this is a one-shot impact, not a repeated oscillation.

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

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

Animation options.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker.

## Returns [#returns]

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