Pixi’VN
indexNamespaceseffectsFunctions

Function: hopEffect()

pixi-vn on GitHub

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

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

Hop the canvas element: one deliberate displacement-and-return, optionally followed by smaller, decaying secondary hops.

Parameters

alias

string

The alias to identify the component.

options?

HopEffectProps = {}

Animation options.

priority?

UPDATE_PRIORITY

The priority of the PixiJS ticker.

Returns

Promise<string[] | undefined>

On this page