Function: punchEffect()

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

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

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.

ParametersCopy Anchor Link

aliasCopy Anchor Link

string

The alias to identify the component.

options?Copy Anchor Link

PunchEffectProps = {}

Animation options.

priority?Copy Anchor Link

UPDATE_PRIORITY

The priority of the PixiJS ticker.

ReturnsCopy Anchor Link

Promise<string[] | undefined>