Fade
constFade:object
Defined in: client/api.d.ts:637
Controls the game’s full-screen scene fader.
Type Declaration
Section titled “Type Declaration”in(
durationSeconds,blockInput?):boolean
Fades from black back into the game scene.
Parameters
Section titled “Parameters”durationSeconds
Section titled “durationSeconds”number
Fade duration in seconds; negative values are clamped to zero.
blockInput?
Section titled “blockInput?”boolean
Whether the game should block player input during the transition.
Returns
Section titled “Returns”boolean
True when the fade was started; false when the game fader is unavailable.
out(
durationSeconds,blockInput?):boolean
Fades the game scene to black.
Parameters
Section titled “Parameters”durationSeconds
Section titled “durationSeconds”number
Fade duration in seconds; negative values are clamped to zero.
blockInput?
Section titled “blockInput?”boolean
Whether the game should block player input during the transition.
Returns
Section titled “Returns”boolean
True when the fade was started; false when the game fader is unavailable.