Osiris/API/FadeToBlack - Revision history

Tinkerer at 13:11, 13 September 2018

2018-09-13T13:11:31Z

← Older revision		Revision as of 13:11, 13 September 2018
Line 5:		Line 5:
	===== Notes =====		===== Notes =====
	* Only call this routine for one character per user.		* Only call this routine for one character per user.
			* Deprecated. Use the less confusing [[Osiris/API/FadeOutBlack\|FadeOutBlack]] and [[Osiris/API/FadeOutWhite\|FadeOutWhite]] calls instead.

	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterGetReservedUserID\|CharacterGetReservedUserID]]		* [[Osiris/API/CharacterGetReservedUserID\|CharacterGetReservedUserID]]
			* [[Osiris/API/ClearFadeDone\|ClearFadeDone]]
	* [[Osiris/API/FadeIn\|FadeIn]]		* [[Osiris/API/FadeIn\|FadeIn]]
	* [[Osiris/API/FadeDone\|FadeDone]]		* [[Osiris/API/FadeDone\|FadeDone]]
	* [[Osiris/API/~~ClearFadeDone~~\|~~ClearFadeDone~~]]		* [[Osiris/API/FadeOutBlack\|FadeOutBlack]]
			* [[Osiris/API/FadeOutWhite\|FadeOutWhite]]

	[[Category:Osiris Calls\|FadeToBlack]]		[[Category:Osiris Calls\|FadeToBlack]]

Tinkerer at 15:21, 19 December 2017

2017-12-19T15:21:20Z

← Older revision		Revision as of 15:21, 19 December 2017
Line 11:		Line 11:
	* [[Osiris/API/ClearFadeDone\|ClearFadeDone]]		* [[Osiris/API/ClearFadeDone\|ClearFadeDone]]

	[[Category:Osiris Calls]]		[[Category:Osiris Calls\|FadeToBlack]]

Tinkerer at 16:38, 6 December 2017

2017-12-06T16:38:22Z

← Older revision		Revision as of 16:38, 6 December 2017
Line 1:		Line 1:
	~~{{warning\|Deprecated. See ''Notes'' for alternatives.}}~~

	===== Full Definition(s) =====		===== Full Definition(s) =====
	* call '''FadeToBlack'''(''(CHARACTERGUID)'''''_Character''', ''(REAL)'''''_Seconds''', ''(INTEGER)'''''_ToBlack''', ''(STRING)'''''_FadeID''')		* call '''FadeToBlack'''(''(CHARACTERGUID)'''''_Character''', ''(REAL)'''''_Seconds''', ''(INTEGER)'''''_ToBlack''', ''(STRING)'''''_FadeID''')
Line 6:		Line 4:
	Fades the screen either from or to black for the user that controls '''_Character'''. The fade will last for '''_Seconds''' seconds; the longer this time, the slower the fade operation. '''Important''': for backwards compatibility, the '''_ToBlack''' parameter behaves opposite of what you would expect. Passing '''0''' as this value will fade a regular game screen '''to''' black, while passing '''1''' will fade '''from''' a blacked-out screen back to normal. If you faded '''to''' black, once the fade operation has finished a [[Osiris/API/FadeDone\|FadeDone]] event will be raised. If you faded '''from''' black, once the fade operation has finished a [[Osiris/API/ClearFadeDone\|ClearFadeDone]] event will be raised		Fades the screen either from or to black for the user that controls '''_Character'''. The fade will last for '''_Seconds''' seconds; the longer this time, the slower the fade operation. '''Important''': for backwards compatibility, the '''_ToBlack''' parameter behaves opposite of what you would expect. Passing '''0''' as this value will fade a regular game screen '''to''' black, while passing '''1''' will fade '''from''' a blacked-out screen back to normal. If you faded '''to''' black, once the fade operation has finished a [[Osiris/API/FadeDone\|FadeDone]] event will be raised. If you faded '''from''' black, once the fade operation has finished a [[Osiris/API/ClearFadeDone\|ClearFadeDone]] event will be raised
	===== Notes =====		===== Notes =====
	* This call has been superseded by the [[Osiris/API/FadeOutBlack\|FadeOutBlack]] and [[Osiris/API/FadeIn\|FadeIn]] calls as of DOS2 Patch 5. It will keep working in DOS2 though.
	* Only call this routine for one character per user.		* Only call this routine for one character per user.
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterGetReservedUserID\|CharacterGetReservedUserID]]		* [[Osiris/API/CharacterGetReservedUserID\|CharacterGetReservedUserID]]
			* [[Osiris/API/FadeIn\|FadeIn]]
			* [[Osiris/API/FadeDone\|FadeDone]]
	* [[Osiris/API/ClearFadeDone\|ClearFadeDone]]		* [[Osiris/API/ClearFadeDone\|ClearFadeDone]]
	* [[Osiris/API/FadeDone\|FadeDone]]
	* [[Osiris/API/FadeIn\|FadeIn]]
	* [[Osiris/API/FadeOutBlack\|FadeOutBlack]]
	* [[Osiris/API/FadeOutWhite\|FadeOutWhite]]

	[[Category:Osiris Calls]]		[[Category:Osiris Calls]]

Tinkerer: Deprecated

2017-12-06T16:09:09Z

Deprecated

← Older revision		Revision as of 16:09, 6 December 2017
Line 1:		Line 1:
			{{warning\|Deprecated. See ''Notes'' for alternatives.}}

	===== Full Definition(s) =====		===== Full Definition(s) =====
	* call '''FadeToBlack'''(''(CHARACTERGUID)'''''_Character''', ''(REAL)'''''_Seconds''', ''(INTEGER)'''''_ToBlack''', ''(STRING)'''''_FadeID''')		* call '''FadeToBlack'''(''(CHARACTERGUID)'''''_Character''', ''(REAL)'''''_Seconds''', ''(INTEGER)'''''_ToBlack''', ''(STRING)'''''_FadeID''')
Line 4:		Line 6:
	Fades the screen either from or to black for the user that controls '''_Character'''. The fade will last for '''_Seconds''' seconds; the longer this time, the slower the fade operation. '''Important''': for backwards compatibility, the '''_ToBlack''' parameter behaves opposite of what you would expect. Passing '''0''' as this value will fade a regular game screen '''to''' black, while passing '''1''' will fade '''from''' a blacked-out screen back to normal. If you faded '''to''' black, once the fade operation has finished a [[Osiris/API/FadeDone\|FadeDone]] event will be raised. If you faded '''from''' black, once the fade operation has finished a [[Osiris/API/ClearFadeDone\|ClearFadeDone]] event will be raised		Fades the screen either from or to black for the user that controls '''_Character'''. The fade will last for '''_Seconds''' seconds; the longer this time, the slower the fade operation. '''Important''': for backwards compatibility, the '''_ToBlack''' parameter behaves opposite of what you would expect. Passing '''0''' as this value will fade a regular game screen '''to''' black, while passing '''1''' will fade '''from''' a blacked-out screen back to normal. If you faded '''to''' black, once the fade operation has finished a [[Osiris/API/FadeDone\|FadeDone]] event will be raised. If you faded '''from''' black, once the fade operation has finished a [[Osiris/API/ClearFadeDone\|ClearFadeDone]] event will be raised
	===== Notes =====		===== Notes =====
			* This call has been superseded by the [[Osiris/API/FadeOutBlack\|FadeOutBlack]] and [[Osiris/API/FadeIn\|FadeIn]] calls as of DOS2 Patch 5. It will keep working in DOS2 though.
	* Only call this routine for one character per user.		* Only call this routine for one character per user.
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterGetReservedUserID\|CharacterGetReservedUserID]]		* [[Osiris/API/CharacterGetReservedUserID\|CharacterGetReservedUserID]]
			* [[Osiris/API/ClearFadeDone\|ClearFadeDone]]
	* [[Osiris/API/FadeDone\|FadeDone]]		* [[Osiris/API/FadeDone\|FadeDone]]
	* [[Osiris/API/~~ClearFadeDone~~\|~~ClearFadeDone~~]]		* [[Osiris/API/FadeIn\|FadeIn]]
			* [[Osiris/API/FadeOutBlack\|FadeOutBlack]]
			* [[Osiris/API/FadeOutWhite\|FadeOutWhite]]

	[[Category:Osiris Calls]]		[[Category:Osiris Calls]]

Tinkerer: FadeToBlack documentation

2017-09-09T16:56:09Z

FadeToBlack documentation

New page

===== Full Definition(s) =====
* call '''FadeToBlack'''(''(CHARACTERGUID)'''''_Character''', ''(REAL)'''''_Seconds''', ''(INTEGER)'''''_ToBlack''', ''(STRING)'''''_FadeID''')
===== Description =====
Fades the screen either from or to black for the user that controls '''_Character'''. The fade will last for '''_Seconds''' seconds; the longer this time, the slower the fade operation. '''Important''': for backwards compatibility, the '''_ToBlack''' parameter behaves opposite of what you would expect. Passing '''0''' as this value will fade a regular game screen '''to''' black, while passing '''1''' will fade '''from''' a blacked-out screen back to normal. If you faded '''to''' black, once the fade operation has finished a [[Osiris/API/FadeDone|FadeDone]] event will be raised. If you faded '''from''' black, once the fade operation has finished a [[Osiris/API/ClearFadeDone|ClearFadeDone]] event will be raised
===== Notes =====
* Only call this routine for one character per user.
===== See Also =====
* [[Osiris/API/CharacterGetReservedUserID|CharacterGetReservedUserID]]
* [[Osiris/API/FadeDone|FadeDone]]
* [[Osiris/API/ClearFadeDone|ClearFadeDone]]

[[Category:Osiris Calls]]