voidfunctionFadeOutGame(boolabFadingOut, boolabBlackFade, floatafSecsBeforeFade, floatafFadeDuration)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
Caveats
CK Wiki - Notes
- This function may not work properly; the black/white screen is instantly removed after the fade-in. It is recommended to ImageSpaceModifier.ApplyCrossFade(...) an ImageSpace Modifier instead.
Parameters
boolabFadingOut
CK Wiki Description
Fades game out if true. Fades game in if false
boolabBlackFade
CK Wiki Description
Fade color is black if true, white if false
floatafSecsBeforeFade
CK Wiki Description
Number of seconds to wait before starting the fade-out / -in
floatafFadeDuration
CK Wiki Description
How long the fade takes (in seconds)
Examples
; Spend 2 seconds on a black screen before fading in to the game over 1 second.
Game.FadeOutGame(false, true, 2.0, 1.0)Auto-Generated Example
bool myBool__abFadingOut
bool myBool__abBlackFade
float myFloat__afSecsBeforeFade
float myFloat__afFadeDuration
Game.FadeOutGame(myBool__abFadingOut, myBool__abBlackFade, myFloat__afSecsBeforeFade, myFloat__afFadeDuration)