Osiris/API/FadeDone - Revision history

Tinkerer at 14:11, 19 December 2017

2017-12-19T14:11:35Z

← Older revision		Revision as of 14:11, 19 December 2017
Line 10:		Line 10:
	* [[Osiris/API/FadeOutDone\|FadeOutDone]]		* [[Osiris/API/FadeOutDone\|FadeOutDone]]

	[[Category:Osiris Events]]		[[Category:Osiris Events\|FadeDone]]

Tinkerer at 11:11, 8 December 2017

2017-12-08T11:11:21Z

← Older revision		Revision as of 11:11, 8 December 2017
Line 6:		Line 6:
	See [[Osiris/API/FadeOutDone\|FadeOutDone]].		See [[Osiris/API/FadeOutDone\|FadeOutDone]].
	===== Notes =====		===== Notes =====
			* Deprecated in DOS2 Patch 5, but still fully functional.
	===== See Also =====		===== See Also =====
	* [[Osiris/API/FadeOutDone\|FadeOutDone]]		* [[Osiris/API/FadeOutDone\|FadeOutDone]]

	[[Category:Osiris Events]]		[[Category:Osiris Events]]

Tinkerer: Refer to FadeOutDone

2017-12-08T11:07:13Z

Refer to FadeOutDone

@@ Line 2: / Line 2: @@
 * event '''FadeDone'''(''(INTEGER)'''''_UserID''', ''(STRING)'''''_FadeID''')
 ===== 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 =====
-* '''_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]].
 ===== Notes =====
 ===== See Also =====
-* [[Osiris/API/FadeToBlack|FadeToBlack]]
+* [[Osiris/API/FadeOutDone|FadeOutDone]]
 [[Category:Osiris Events]]

Tinkerer: FadeDone event

2017-09-09T17:05:55Z

FadeDone event

New page

===== Full Definition(s) =====
* event '''FadeDone'''(''(INTEGER)'''''_UserID''', ''(STRING)'''''_FadeID''')
===== Description =====
Thrown when a fade-to-black or fade-to-white operation finished.
===== 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.
* '''_Event''': The name of the event specified to [[Osiris/API/FadeToBlack|FadeToBlack]] or [[Osiris/API/FadeToWhite|FadeToWhite]].
===== 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:
<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 =====
* [[Osiris/API/FadeToBlack|FadeToBlack]]
* [[Osiris/API/FadeToWhite|FadeToWhite]]

[[Category:Osiris Events]]