User Tools

Site Tools


enable_screen_effect

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
enable_screen_effect [2025/02/16 13:53] justinenable_screen_effect [2025/02/16 14:29] (current) justin
Line 1: Line 1:
 ======Enable Screen Effect====== ======Enable Screen Effect======
 ---- ----
-Enables either the VHS/CRT monitor effect or the retro effect over a duration of time (in seconds). The second parameter is optional and should be a string value of other "vhs" or "retro" (case-sensitive). If omitted, it will default to "vhs".+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:==== ====Signature:====
 <code python> <code python>
-enable_screen_effect(duration)+enable_screen_effect(duration, screen_effect_id)
 </code> </code>
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|duration| |[[Number]]|No| +|duration|Duration of time over which the screen effect will be enabled. Defaults to 0 (instant).|[[Number]]|No| 
-|screen_effect_id| |[[String]]|No|+|screen_effect_id|ID of the screen effect to enable, either "vhs" or "retro". Defaults to "vhs" if omitted.|[[String]]|No|
  
 ====Example:==== ====Example:====
 <code bauxite> <code bauxite>
 +enable_screen_effect(2, "retro");
 </code> </code>
-//Results://+//Results:// The retro screen effect is faded in over a duration of 2 seconds. 
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
enable_screen_effect.1739742794.txt.gz · Last modified: 2025/02/16 13:53 by justin