set_screen_effect_property
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| set_screen_effect_property [2024/02/25 19:12] – justin | set_screen_effect_property [2025/02/16 18:17] (current) – justin | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ======Set Screen Effect Property====== | ======Set Screen Effect Property====== | ||
| ---- | ---- | ||
| - | (WIP) | + | 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 " | ||
| - | The following | + | The following |
| ^Property^Description^Type^ | ^Property^Description^Type^ | ||
| |scanlines_opacity|Decimal value from 0 to 1.|[[Number]]| | |scanlines_opacity|Decimal value from 0 to 1.|[[Number]]| | ||
| Line 19: | Line 20: | ||
| |grille_opacity|Decimal value from 0 to 1.|[[Number]]| | |grille_opacity|Decimal value from 0 to 1.|[[Number]]| | ||
| |resolution|Value should be an [[array]] containing two values, width and height.|[[Array]]| | |resolution|Value should be an [[array]] containing two values, width and height.|[[Array]]| | ||
| - | |pixelate| |[[Boolean]]| | + | |pixelate|[[Boolean]] value (true or false).|[[Boolean]]| |
| - | |roll| |[[Boolean]]| | + | |roll|[[Boolean]] value (true or false).|[[Boolean]]| |
| |roll_speed|Decimal value from -100 to 100.|[[Number]]| | |roll_speed|Decimal value from -100 to 100.|[[Number]]| | ||
| |roll_size|Decimal value from 0 to 100.|[[Number]]| | |roll_size|Decimal value from 0 to 100.|[[Number]]| | ||
| Line 31: | Line 32: | ||
| |brightness|Decimal value from 0 to 10.|[[Number]]| | |brightness|Decimal value from 0 to 10.|[[Number]]| | ||
| |discolor|Must be true in order for saturation and contrast to be changed.|[[Boolean]]| | |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]]| | + | |saturation|Decimal value from -10 to 10. Requires the "discolor" |
| - | |contrast|Decimal value from 0 to 10. Requires the discolor property to be true otherwise changing the contrast will have no effect.|[[Number]]| | + | |contrast|Decimal value from 0 to 10. Requires the "discolor" |
| |warp_amount|Decimal value from 0 to 5.|[[Number]]| | |warp_amount|Decimal value from 0 to 5.|[[Number]]| | ||
| |vignette_intensity|Decimal value from 0 to 1.|[[Number]]| | |vignette_intensity|Decimal value from 0 to 1.|[[Number]]| | ||
| |vignette_opacity|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 " | ||
| + | |change_color_depth|[[Boolean]] value (true or false).|[[Boolean]]| | ||
| + | |color_depth|Integer value from 1 to 8. Requires the " | ||
| + | |dithering|[[Boolean]] value (true or false).|[[Boolean]]| | ||
| ====Example: | ====Example: | ||
| <code bauxite> | <code bauxite> | ||
| + | set_screen_effect_property(" | ||
| </ | </ | ||
| - | // | + | // |
| <WRAP center round tip 100%> | <WRAP center round tip 100%> | ||
set_screen_effect_property.1708917143.txt.gz · Last modified: 2024/02/25 19:12 by justin
Page Tools
