Pixi’VN
indexNamespacestransitionsFunctions

Function: splitOut()

pixi-vn on GitHub

> splitOut(alias, props?, priority?): string[] | undefined

Defined in: src/canvas/functions/canvas-transition.ts:1734

Remove a image from the canvas with a split effect: two mask panels retract apart toward the edges to progressively conceal the image. With direction: "outward", the visible region shrinks from the edges towards the split line. See splitIn and SplitInOutProps.

Parameters

alias

string

The unique alias of the image. You can use this alias to refer to this image

props?

SplitInOutProps = {}

The properties of the effect

priority?

UPDATE_PRIORITY

The priority of the effect

Returns

string[] | undefined

The ids of the tickers that are used in the effect.

On this page