Mod:Creation Kit/FadeOutGame - Game

Member of: Mod:Creation Kit/Game Script

FadeOutGame uses the in-game Fader menu to fade the game to black, or vice versa.

Syntax
Function FadeOutGame(bool abFadingOut, bool abBlackFade, float afSecsBeforeFade, float afFadeDuration, \ bool abStayFaded=false) native global

Parameters

 * abFadingOut: Fades game out if true. Fades game in if false
 * abBlackFade: Fade color is black if true, white if false
 * afSecsBeforeFade: Number of seconds to wait before starting the fade-out / -in
 * afFadeDuration: How long the fade takes (in seconds)
 * abStayFaded: If true, do not hide fader when FadeOut is complete. Keeps screen dark until a fade in call is made.
 * Default: False

Return Value
None.

Examples
Game.FadeOutGame(true, true, 1.0, 1.0, true)
 * Fade to a black screen over 1 second and leave up fader when done

Game.FadeOutGame(false, true, 2.0, 1.0)
 * Spend 2 seconds on a black screen before fading in to the game over 1 second and hide fader when done