Difference between revisions of "FadeOutGame - Game"
Jump to navigation
Jump to search
imported>Plplecuyer |
imported>Qazaaq (added category) |
||
| Line 1: | Line 1: | ||
'''Member of:''' [[Game Script]] | '''Member of:''' [[Game Script]] | ||
| Line 33: | Line 31: | ||
== See Also == | == See Also == | ||
*[[Game Script]] | *[[Game Script]] | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:User Interface]] | |||
Latest revision as of 20:05, 11 February 2018
Member of: Game Script
FadeOutGame uses the in-game Fader menu to fade the game to black, or vice versa.
Syntax[edit | edit source]
Function FadeOutGame(bool abFadingOut, bool abBlackFade, float afSecsBeforeFade, float afFadeDuration, \
bool abStayFaded=false) native globalParameters[edit | edit source]
- 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[edit | edit source]
None.
Examples[edit | edit source]
; 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)