Fade

Type Declaration

• in: function

  • in(durationSeconds: number, blockInput?: boolean): boolean

    Fades from black back into the game scene.

    Parameters

    • durationSeconds: number

      Fade duration in seconds; negative values are clamped to zero.

    • OptionalblockInput: boolean

      Whether the game should block player input during the transition.

    Returns boolean

    True when the fade was started; false when the game fader is unavailable.

• out: function

  • out(durationSeconds: number, blockInput?: boolean): boolean

    Fades the game scene to black.

    Parameters

    • durationSeconds: number

      Fade duration in seconds; negative values are clamped to zero.

    • OptionalblockInput: boolean

      Whether the game should block player input during the transition.

    Returns boolean

    True when the fade was started; false when the game fader is unavailable.