ShaderHue (CMS): Difference between revisions

From The Official Visionaire Studio: Adventure Game Engine Wiki
Created page with "{| class="ts" style="width:100%" |- ! style="text-align:left" | Name !! style="text-align:left" | Type |- | shaderHue(hue, delay) || Execution |} Allows the user to adjust t..."
 
No edit summary
Line 7: Line 7:




Allows the user to adjust the screens hue value over a specified amount of time. ''The [[Shader_(CMS)|shader toolkit]] is needed for this function to work''.
Allows the user to adjust the hue value of the screen over a specified amount of time. ''The [[Shader_(CMS)|shader toolkit]] is required for this function to work''.





Revision as of 17:29, 30 September 2014

Name Type
shaderHue(hue, 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
hue 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).