Function: flashIn()

> flashIn(alias, component?, props?, priority?): Promise<string[] | undefined>

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

Show a image in the canvas with a flash effect, with a configurable solid-color overlay (not limited to a white flash). White reads as a camera/explosion-like flash, black as a blink/cut, and arbitrary colors work for damage/magic/memory/UI transitions. See FlashInOutProps.

If alias has no existing component, the new image appears immediately and the overlay fades in and back out over it. If alias already has a component, the current content fades up to color first, is swapped for the new content at the exact moment the screen is a solid color (so the content change itself is invisible), and the new content then fades back down from color to normal - see flashReplace.

ParametersCopy Anchor Link

aliasCopy Anchor Link

string

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

component?Copy Anchor Link

TComponent

The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the VideoSprite is added to the canvas. If imageUrl is an array, then the ImageContainer is added to the canvas. If you don't provide the component, then the alias is used as the url.

props?Copy Anchor Link

FlashInOutProps = {}

The properties of the effect

priority?Copy Anchor Link

UPDATE_PRIORITY

The priority of the effect

ReturnsCopy Anchor Link

Promise<string[] | undefined>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.