Class ScreenTransition

Full-screen transition effects that overlay the entire game. Use for scene changes, level transitions, cutscene entry/exit.

Index

Constructors

Methods

fadeThrough irisWipe pixelate

Constructors

constructor

new ScreenTransition(): ScreenTransition
Returns ScreenTransition

Methods

`Static`fadeThrough

fadeThrough(
    scene: Scene,
    callback: () => void | Promise<void>,
    duration?: number,
    color?: number,
): Promise<void>
Fade to black, execute a callback (e.g., scene switch), then fade back in.
Parameters
- scene: Scene
- callback: () => void | Promise<void>
- duration: number = 400
- color: number = 0x000000
Returns Promise<void>
- Defined in packages/clik-engine/src/scenes/ScreenTransition.ts:12

`Static`irisWipe

irisWipe(
    scene: Scene,
    callback: () => void | Promise<void>,
    duration?: number,
): Promise<void>
Diamond/iris wipe effect — circle shrinks to center then expands.
Parameters
- scene: Scene
- callback: () => void | Promise<void>
- duration: number = 800
Returns Promise<void>
- Defined in packages/clik-engine/src/scenes/ScreenTransition.ts:49

`Static`pixelate

pixelate(
    scene: Scene,
    callback: () => void | Promise<void>,
    duration?: number,
    maxPixelSize?: number,
): Promise<void>
Pixelate transition — game pixelates, callback fires, then de-pixelates. Requires WebGL.
Parameters
- scene: Scene
- callback: () => void | Promise<void>
- duration: number = 600
- maxPixelSize: number = 16
Returns Promise<void>
- Defined in packages/clik-engine/src/scenes/ScreenTransition.ts:124