User Tools

Site Tools


set_screen_effect_property

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
set_screen_effect_property [2025/02/16 14:59] justinset_screen_effect_property [2025/02/16 18:17] (current) justin
Line 1: Line 1:
 ======Set Screen Effect Property====== ======Set Screen Effect Property======
 ---- ----
-Modifies a property for either the VHS/CRT monitor effect or the retro effect. See below for a list of properties that can be changed for each screen effect.+Modifies a property for either the VHS/CRT monitor effect or the retro effect. See below for a list of properties that can be changed for each screen effect and their possible values.
  
 ====Signature:==== ====Signature:====
Line 9: Line 9:
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|property_name| |[[String]]|Yes| +|property_name|Name of the property.|[[String]]|Yes| 
-|property_value| |Varies|Yes| +|property_value|Value that will be assigned to the property.|Varies|Yes| 
-|duration| |[[Number]]|No|+|duration|Duration over which the property will be changed (in seconds).|[[Number]]|No|
 |screen_effect_id|ID of the screen effect to change the property for, either "vhs" or "retro". Defaults to "vhs" if omitted.|[[String]]|No| |screen_effect_id|ID of the screen effect to change the property for, either "vhs" or "retro". Defaults to "vhs" if omitted.|[[String]]|No|
  
Line 48: Line 48:
 ====Example:==== ====Example:====
 <code bauxite> <code bauxite>
 +set_screen_effect_property("saturation", 0, 1, "vhs");
 </code> </code>
-//Results://+//Results:// The saturation amount of the VHS/CRT monitor effect is changed to 0 over a duration of 1 second, resulting in the screen being greyscale.
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
set_screen_effect_property.1739746795.txt.gz · Last modified: 2025/02/16 14:59 by justin