This is an old revision of the document!

Set Screen Effect Property

(WIP)

set_screen_effect_property(property_name, property_value, duration)

Argument	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		Number
scanlines_width		Number
grille_opacity		Number
resolution	Value should be an array containing two values, width and height.	Array
pixelate		Boolean
roll		Boolean
roll_speed		Number
roll_size		Number
roll_variation		Number
distort_intensity		Number
noise_opacity		Number
noise_speed		Number
noise_intensity		Number
aberration		Number
brightness		Number
discolor		Boolean
saturation	Requires the “discolor” property to be true, otherwise changing the saturation will have no effect.	Number
contrast	Requires the “discolor” property to be true otherwise changing the contrast will have no effect.	Number
warp_amount		Number
vignette_intensity		Number
vignette_opacity		Number

Results:

Use the Set Screen Effect Property function to…

RPG in a Box
Official Documentation