ShaderLightness (CMS)

From The Official Visionaire Studio: Adventure Game Engine Wiki
Revision as of 21:33, 7 November 2014 by AFRLme (talk)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Name Type
shaderLightness(value, delay) Execution


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


Examples

Enable

Adjust screen lightness value

shaderLightness(0.1, 3000) -- adjust screen lightness over 3000 milliseconds
shaderLightness(0.1, 0) -- adjust screen lightness instantly

Disable

Restore default screen lightness value

shaderLightness(0, 3000) -- restore screen lightness over 3000 milliseconds
shaderLightness(0, 0) -- restore screen lightness value back to default instantly


Syntax Breakdown

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


Resources

Name Description
shaderLightness.zip A working .ved file, complete with resources. Check out the readme.txt file for instructions.