— — — — —
— — — — —
— — — — —
— — — — —
Sidebar
set_screen_effect_property
This is an old revision of the document!
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 and their possible values.
Signature:
set_screen_effect_property(property_name, property_value, duration)
| Argument | Description | Type | Required |
|---|---|---|---|
| property_name | Name of the property. | String | Yes |
| property_value | Value that will be assigned to the property. | Varies | Yes |
| 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 |
The following properties are available to change for the VHS/CRT monitor effect:
| 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 value (true or false). | Boolean |
| roll | Boolean value (true or false). | 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 |
The following properties are available to change for the retro effect:
| Property | Description | Type |
|---|---|---|
| scale_resolution | Boolean value (true or false). | Boolean |
| resolution_scale | Integer value from 1 to 32. Requires the “scale_resolution” property to be true, otherwise changing the resolution scale will have no effect. | Number |
| change_color_depth | Boolean value (true or false). | Boolean |
| color_depth | Integer value from 1 to 8. Requires the “change_color_depth” property to be true, otherwise changing the color depth will have no effect. | Number |
| dithering | Boolean value (true or false). | Boolean |
Example:
set_screen_effect_property("saturation", 0, 2, "vhs");
Results:
Use the Set Screen Effect Property function to…
Editor Node:
set_screen_effect_property.1739758348.txt.gz · Last modified: 2025/02/16 18:12 by justin
