Variable SceneUtilsConst

Type Declaration

• comboShake: function

  • comboShake(
        scene: Scene,
        combo: number,
        config?: {
            baseDuration?: number;
            baseIntensity?: number;
            maxCombo?: number;
        },
    ): void

    Camera shake scaled by combo count.

    Parameters

    • scene: Scene
    • combo: number
    • Optionalconfig: { baseDuration?: number; baseIntensity?: number; maxCombo?: number }

    Returns void

• countdown: function

  • countdown(scene: Scene, seconds: number, x?: number, y?: number): Promise<void>

    Countdown timer displayed on screen. Returns a promise that resolves when countdown reaches 0.

    Parameters

    • scene: Scene
    • seconds: number
    • Optionalx: number
    • Optionaly: number

    Returns Promise<void>

• hitStop: function

  • hitStop(scene: Scene, durationMs?: number): void

    Freeze the scene for a duration (hit-stop / hit-lag effect). Uses setTimeout (real time) instead of scene.time.delayedCall because the latter respects timeScale and would never fire when timeScale is 0.

    Parameters

    • scene: Scene
    • durationMs: number = 50

    Returns void

• screenFlash: function

  • screenFlash(scene: Scene, color?: number, duration?: number): Promise<void>

    Flash the screen a color (damage, power-up, etc.)

    Parameters

    • scene: Scene
    • color: number = 0xffffff
    • duration: number = 100

    Returns Promise<void>

• screenFlashColor: function

  • screenFlashColor(
        scene: Scene,
        config?: { alpha?: number; color?: number; duration?: number },
    ): Promise<void>

    Screen flash with custom color and alpha.

    Parameters

    • scene: Scene
    • Optionalconfig: { alpha?: number; color?: number; duration?: number }

    Returns Promise<void>

• slowMotion: function

  • slowMotion(scene: Scene, scale?: number, durationMs?: number): void

    Slow motion effect.

    Parameters

    • scene: Scene
    • scale: number = 0.3
    • durationMs: number = 1000

    Returns void

• wait: function

  • wait(scene: Scene, ms: number): Promise<void>

    Wait for a duration (ms) — use in async scene methods.

    Parameters

    • scene: Scene
    • ms: number

    Returns Promise<void>

• wipe: function

  • wipe(
        scene: Scene,
        direction?: "left" | "right",
        duration?: number,
        color?: number,
    ): Promise<void>

    Simple screen wipe (black rectangle slides across).

    Parameters

    • scene: Scene
    • direction: "left" | "right" = 'left'
    • duration: number = 400
    • color: number = 0x000000

    Returns Promise<void>