Difference between revisions of "Osiris/API/FadeToBlack"
From Divinity Engine Wiki
(FadeToBlack documentation) |
m (Deprecated) |
||
| 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/ | + | * [[Osiris/API/FadeIn|FadeIn]] |
| + | * [[Osiris/API/FadeOutBlack|FadeOutBlack]] | ||
| + | * [[Osiris/API/FadeOutWhite|FadeOutWhite]] | ||
[[Category:Osiris Calls]] | [[Category:Osiris Calls]] | ||
Revision as of 18:09, 6 December 2017
 |
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 FadeDone event will be raised. If you faded from black, once the fade operation has finished a ClearFadeDone event will be raised
Notes
- This call has been superseded by the FadeOutBlack and FadeIn calls as of DOS2 Patch 5. It will keep working in DOS2 though.
- Only call this routine for one character per user.
