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
Next revisionBoth sides next revision
set_screen_effect_property [2024/02/22 00:07] justinset_screen_effect_property [2024/02/25 19:12] justin
Line 1: Line 1:
 ======Set Screen Effect Property====== ======Set Screen Effect Property======
 ---- ----
-Coming in v1.1! 
- 
 (WIP) (WIP)
  
 ====Signature:==== ====Signature:====
 <code python> <code python>
-function()+set_screen_effect_property(property_name, property_value, duration)
 </code> </code>
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-| | | | |+|property_name| |[[String]]|Yes| 
 +|property_value| |Varies|Yes| 
 +|duration| |[[Number]]|No| 
 + 
 +The following property names are available to change: 
 +^Property^Description^Type^ 
 +|scanlines_opacity|Decimal value from 0 to 1.|[[Number]]| 
 +|scanlines_width|Decimal value from 0 to 0.5.|[[Number]]| 
 +|grille_opacity|Decimal value from 0 to 1.|[[Number]]| 
 +|resolution|Value should be an [[array]] containing two values, width and height.|[[Array]]| 
 +|pixelate| |[[Boolean]]| 
 +|roll| |[[Boolean]]| 
 +|roll_speed|Decimal value from -100 to 100.|[[Number]]| 
 +|roll_size|Decimal value from 0 to 100.|[[Number]]| 
 +|roll_variation|Decimal value from 0.1 to 5.|[[Number]]| 
 +|distort_intensity|Decimal value from 0 to 0.2.|[[Number]]| 
 +|noise_opacity|Decimal value from 0 to 1.|[[Number]]| 
 +|noise_speed|Decimal value from 0 to 100.|[[Number]]| 
 +|noise_intensity|Decimal value from 0 to 1.|[[Number]]| 
 +|aberration|Decimal value from -1 to 1.|[[Number]]| 
 +|brightness|Decimal value from 0 to 10.|[[Number]]| 
 +|discolor|Must be true in order for saturation and contrast to be changed.|[[Boolean]]| 
 +|saturation|Decimal value from -10 to 10. Requires the discolor property to be true, otherwise changing the saturation will have no effect.|[[Number]]| 
 +|contrast|Decimal value from 0 to 10. Requires the discolor property to be true otherwise changing the contrast will have no effect.|[[Number]]| 
 +|warp_amount|Decimal value from 0 to 5.|[[Number]]| 
 +|vignette_intensity|Decimal value from 0 to 1.|[[Number]]| 
 +|vignette_opacity|Decimal value from 0 to 1.|[[Number]]|
  
 ====Example:==== ====Example:====
 <code bauxite> <code bauxite>
-function();+
 </code> </code>
 //Results:// //Results://
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
-Use the **Function** function to...+Use the **Set Screen Effect Property** function to...
 </WRAP> </WRAP>
  
Line 28: Line 52:
 <WRAP half column> <WRAP half column>
 ====Editor Node:==== ====Editor Node:====
-{{:function_node.png?nolink|}}+{{:set_screen_effect_property_node.png?nolink|}}
 </WRAP> </WRAP>
  
set_screen_effect_property.txt · Last modified: 2024/02/25 19:13 by justin