Differences

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

--- enable_screen_effect [2024/02/21 21:38] – created justin
+++ enable_screen_effect [2025/02/16 14:29] (current) – justin
@@ Line 1: / Line 1: @@
 ======Enable Screen Effect======
 ----
-Coming in v1.1!
+Enables either the VHS/CRT monitor effect or the retro effect over a duration of time (in seconds). The second parameter should be a [[string]] value of other "vhs" or "retro" (case-sensitive).
+====Signature:====
+<code python>
+enable_screen_effect(duration, screen_effect_id)
+</code>
+^Argument^Description^Type^Required^
+|duration|Duration of time over which the screen effect will be enabled. Defaults to 0 (instant).|[[Number]]|No|
+|screen_effect_id|ID of the screen effect to enable, either "vhs" or "retro". Defaults to "vhs" if omitted.|[[String]]|No|
+====Example:====
+<code bauxite>
+enable_screen_effect(2, "retro");
+</code>
+//Results:// The retro screen effect is faded in over a duration of 2 seconds.
+<WRAP center round tip 100%>
+Use the **Enable Screen Effect** function to...
+</WRAP>
+----
+<WRAP group>
+<WRAP half column>
+====Editor Node:====
+{{:enable_screen_effect_node.png?nolink|}}
+</WRAP>
+<WRAP half column>
+</WRAP>
+</WRAP>
+~~NOTOC~~

RPG in a BoxOfficial Documentation