Screen helpers · interface

MountedSplash

Explained in Recording and clips.

interface MountedSplash
import type { MountedSplash } from '@driftengine/core';

Methods

present

present(): void

Tell the badge a frame reached the screen. Cheap, and ignored after the first one.

release

release(): void

Take it down now, whatever the clock says. Idempotent.

holdUntil

holdUntil(until: PromiseLike<unknown>, capMs?: number): boolean

Keep it up until until settles as well, under capMs. False once it has left.

ParameterTypeDescription
untilPromiseLike<unknown>
capMs?number