Differences

This shows you the differences between two versions of the page.

--- fade_out [2017/04/13 15:11] – external edit 127.0.0.1
+++ fade_out [2021/04/21 18:30] (current) – justin
@@ Line 2: / Line 2: @@
 ----
-Fade to black over the specified duration (in seconds).
+Fades to black over the specified duration of time (in seconds). [[fade_in|Fade In]] would typically be called at some point after this function to fade the screen back into view.
+====Signature:====
 <code python>
-fade_out(1)
+fade_out(duration)
 </code>
 ^Argument^Description^Type^Required^
-|1|Description.|[[String]]|Yes|
+|duration|Length of fade (in seconds).|[[Number]]|Yes|
 ====Example:====
-<code python>
+<code bauxite>
-fade_out(1)
+fade_out(1);
 </code>
-//Results://
+//Results:// The screen fades to black over a duration of one second.
 <WRAP center round tip 100%>
-Use the **Fade Out** function to ...
+Use the **Fade Out** and **Fade In** functions to transition between segments of a cutscene or as a way to hide visual modifications to the scene (e.g. removing a character or object).
 </WRAP>

RPG in a BoxOfficial Documentation