Osiris/API/ClearFadeDone: Difference between revisions

From Divinity Engine Wiki
Jump to navigation Jump to search
(ClearFadeDone event)
 
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
* event '''ClearFadeDone'''(''(INTEGER)'''''_UserID''', ''(STRING)'''''_FadeID''')
* event '''ClearFadeDone'''(''(INTEGER)'''''_UserID''', ''(STRING)'''''_FadeID''')
===== Description =====
===== Description =====
Thrown when a fade-from-black or fade-from-white operation finished.
This is the legacy name of the functionally equivalent [[Osiris/API/FadeInDone|FadeInDone]].
===== Parameters =====
===== Parameters =====
* '''_UserID''': Do '''''not''''' rely on this parameter. Theoretically, it should contain the ID of the user for which the fade was done. In practice, this value is unreliable.
See [[Osiris/API/FadeInDone|FadeInDone]].
* '''_Event''': The name of the event specified to [[Osiris/API/FadeToBlack|FadeToBlack]] or [[Osiris/API/FadeToWhite|FadeToWhite]].
===== Notes =====
===== Notes =====
* See [[Osiris/API/FadeDone|FadeDone]]
* Deprecated in DOS2 Patch 5, but still fully functional.
===== See Also =====
===== See Also =====
* [[Osiris/API/FadeToBlack|FadeToBlack]]
* [[Osiris/API/FadeInDone|FadeInDone]]
* [[Osiris/API/FadeToWhite|FadeToWhite]]
   
   
[[Category:Osiris Events]]
[[Category:Osiris Events|ClearFadeDone]]

Latest revision as of 14:10, 19 December 2017

Full Definition(s)
  • event ClearFadeDone((INTEGER)_UserID, (STRING)_FadeID)
Description

This is the legacy name of the functionally equivalent FadeInDone.

Parameters

See FadeInDone.

Notes
  • Deprecated in DOS2 Patch 5, but still fully functional.
See Also