Osiris/API/FadeDone: Difference between revisions

From Divinity Engine Wiki
Jump to navigation Jump to search
(FadeDone event)
 
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
* event '''FadeDone'''(''(INTEGER)'''''_UserID''', ''(STRING)'''''_FadeID''')
* event '''FadeDone'''(''(INTEGER)'''''_UserID''', ''(STRING)'''''_FadeID''')
===== Description =====
===== Description =====
Thrown when a fade-to-black or fade-to-white operation finished.
This is the legacy name of the functionally equivalent [[Osiris/API/FadeOutDone|FadeOutDone]].
===== 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/FadeOutDone|FadeOutDone]].
* '''_Event''': The name of the event specified to [[Osiris/API/FadeToBlack|FadeToBlack]] or [[Osiris/API/FadeToWhite|FadeToWhite]].
===== Notes =====
===== Notes =====
* Since you cannot rely on the '''_UserID''' parameter, when potentially fading for multiple users at the same time and wanting to catch this event, you have to create a separate '''_FadeDone''' event for every user. One way of doing this is as follows:
* Deprecated in DOS2 Patch 5, but still fully functional.
<pre>
PROC
PROC_MYPREFIX_FadeToBlackForChar((CHARACTERGUID)_Char, (STRING)_BaseEventName)
AND
GetUUID(_Char, _UserIDString)
AND
StringConcatenate(_BaseEventName, _UserIDString, _FadeEvent)
THEN
DB_MYPREFIX_FadeEvent(_Char, _FadeEvent);
FadeToBlack(_Char, 3.0, 0, _FadeEvent);
 
IF
FadeDone(_, _FadeEvent)
AND
DB_MYPREFIX_FadeEvent(_Char, _FadeEvent)
THEN
NOT DB_MYPREFIX_FadeEvent(_Char, _FadeEvent);
// Do what you want to do when the fade is finished
</pre>
===== See Also =====
===== See Also =====
* [[Osiris/API/FadeToBlack|FadeToBlack]]
* [[Osiris/API/FadeOutDone|FadeOutDone]]
* [[Osiris/API/FadeToWhite|FadeToWhite]]
   
   
[[Category:Osiris Events]]
[[Category:Osiris Events|FadeDone]]

Latest revision as of 14:11, 19 December 2017

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

This is the legacy name of the functionally equivalent FadeOutDone.

Parameters

See FadeOutDone.

Notes
  • Deprecated in DOS2 Patch 5, but still fully functional.
See Also
Retrieved from "https://docs.larian.game/index.php?title=Osiris/API/FadeDone&oldid=4895"