Difference between revisions of "Osiris/API/FadeOutWhite"

From Divinity Engine Wiki
Jump to: navigation, search
(Documented FadeOutWhite)
 
m
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
* call '''FadeOutWhite'''(''(CHARACTERGUID)'''''_Character''', ''(REAL)'''''_Seconds''', ''(STRING)'''''_FadeID''')
 
* call '''FadeOutWhite'''(''(CHARACTERGUID)'''''_Character''', ''(REAL)'''''_Seconds''', ''(STRING)'''''_FadeID''')
 
===== Description =====
 
===== Description =====
Fades the screen either to whitefor the [[Osiris/API/CharacterGetReservedUserID|user]] that controls '''_Character'''. The fade will last for '''_Seconds''' seconds; the longer this time, the slower the fade operation.
+
Fades the screen to white for the [[Osiris/API/CharacterGetReservedUserID|user]] that controls '''_Character'''. The fade will last for '''_Seconds''' seconds; the longer this time, the slower the fade operation.
 +
 
 +
When the fade operation has finished, a [[Osiris/API/FadeDone|FadeDone]] event will be thrown.
 
===== Notes =====
 
===== Notes =====
 
* This call is a more intuitive version of the [[Osiris/API/FadeToBlack|FadeToBlack]] call.
 
* This call is a more intuitive version of the [[Osiris/API/FadeToBlack|FadeToBlack]] call.
Line 13: Line 15:
 
* [[Osiris/API/FadeOutBlack|FadeOutBlack]]
 
* [[Osiris/API/FadeOutBlack|FadeOutBlack]]
  
[[Category:Osiris Calls]]
+
[[Category:Osiris Calls|FadeOutWhite]]

Latest revision as of 17:21, 19 December 2017

Full Definition(s)
  • call FadeOutWhite((CHARACTERGUID)_Character, (REAL)_Seconds, (STRING)_FadeID)
Description

Fades the screen to white for the user that controls _Character. The fade will last for _Seconds seconds; the longer this time, the slower the fade operation.

When the fade operation has finished, a FadeDone event will be thrown.

Notes
  • This call is a more intuitive version of the FadeToBlack call.
  • New in DOS2 Patch 5.
See Also