ShaderHue (CMS)

From The Official Visionaire Studio: Adventure Game Engine Wiki
Name Type
shaderHue(value, delay) Execution


Allows the user to adjust the hue value of the screen over a specified amount of time. The shader toolkit is required for this function to work.


Examples

Enable

Set hue amount

shaderHue(0.1, 3000) -- adjust the hue value of the screen over 3 seconds
shaderHue(0.1, 0) -- adjust the hue value of the screen instantly

Disable

Restore hue back to default value

shaderHue(0, 3000) -- adjust the hue value of the screen back to default over 3 seconds
shaderHue(0, 0) -- adjust the hue value of the screen back to default instantly


Syntax Breakdown

Name Type Description
value float (decimal) Define the hue value of the screen; recommended value somewhere between 0 & 1.
delay integer (number) The amount of time to adjust the hue value of the screen over; in milliseconds (ms).