Background for Starfield
Member of the Game script
voidfunctionFadeOutGame(boolabFadingOut, boolabBlackFade, floatafSecsBeforeFade, floatafFadeDuration, boolabStayFaded=false)NativeGlobal

Description

Wiki Description

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

Documentation Comment

Fades out the game to black, or vice versa


Parameters

  1. boolabFadingOut

    CK Wiki Description

    Fades game out if true. Fades game in if false

  2. boolabBlackFade

    CK Wiki Description

    Fade color is black if true, white if false

  3. floatafSecsBeforeFade

    CK Wiki Description

    Number of seconds to wait before starting the fade-out / -in

  4. floatafFadeDuration

    CK Wiki Description

    How long the fade takes (in seconds)

  5. boolabStayFaded=false

    CK Wiki Description

    If true, do not hide fader when FadeOut is complete. Keeps screen dark until a fade in call is made.

    • Default:False

Examples

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

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

Auto-Generated Example

bool myBool__abFadingOut
bool myBool__abBlackFade
float myFloat__afSecsBeforeFade
float myFloat__afFadeDuration
bool myBool__abStayFaded

Game.FadeOutGame(myBool__abFadingOut, myBool__abBlackFade, myFloat__afSecsBeforeFade, myFloat__afFadeDuration, myBool__abStayFaded)

Related Pages


Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki

Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.