Difference between revisions of "Osiris/API/FadeOutBlack"
From Divinity Engine Wiki
(Documented FadeOutBlack) |
m |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
* call '''FadeOutBlack'''(''(CHARACTERGUID)'''''_Character''', ''(REAL)'''''_Seconds''', ''(STRING)'''''_FadeID''') | * call '''FadeOutBlack'''(''(CHARACTERGUID)'''''_Character''', ''(REAL)'''''_Seconds''', ''(STRING)'''''_FadeID''') | ||
===== Description ===== | ===== Description ===== | ||
| − | Fades the screen | + | Fades the screen to black for the [[Osiris/API/CharacterGetReservedUserID|user]] that controls '''_Character'''. The fade will last for '''_Seconds''' seconds; the longer this time, the slower the fade operation. |
| + | |||
| + | When the fade operation has finished, a [[Osiris/API/FadeDone|FadeDone]] event will be thrown. | ||
| + | ===== Notes ===== | ||
* This call is a more intuitive version of the [[Osiris/API/FadeToBlack|FadeToBlack]] call. | * This call is a more intuitive version of the [[Osiris/API/FadeToBlack|FadeToBlack]] call. | ||
* New in DOS2 Patch 5. | * New in DOS2 Patch 5. | ||
| Line 12: | Line 15: | ||
* [[Osiris/API/FadeOutWhite|FadeOutWhite]] | * [[Osiris/API/FadeOutWhite|FadeOutWhite]] | ||
| − | [[Category:Osiris Calls]] | + | [[Category:Osiris Calls|FadeOutBlack]] |
Latest revision as of 16:21, 19 December 2017
Full Definition(s)
- call FadeOutBlack((CHARACTERGUID)_Character, (REAL)_Seconds, (STRING)_FadeID)
Description
Fades the screen to black for the user that controls _Character. The fade will last for _Seconds seconds; the longer this time, the slower the fade operation.
When the fade operation has finished, a FadeDone event will be thrown.
Notes
- This call is a more intuitive version of the FadeToBlack call.
- New in DOS2 Patch 5.
