SetScreenTone routine
Changes the overall color of the screen.
Syntax
procedure setScreenTone(r, g, b, sat: byte; duration: cardinal; wait: boolean);
Description
This routine shades the entire map. The first four parameters represent percentages, and can be anywhere from 0-200. (Any value larger than 200 is treated as a 200). The r, g, and b parameters refer to the red, green and blue components of the shading. The sat parameter refers to the overall color saturation of the map. The transition will take place gradually, over a period of duration miliseconds. If true is passed to the wait parameter, the script's execution will pause until the transition is finished.
This routine only shades the map and the characters and events on it. Menus and message boxes aren't shaded.
NOTE: The Fade Out screen transition, as well as other script functions that may make use of fade-outs (such as the Inn routine) will fade from the current screen tone to black. The previous screen tone will be lost, and it is the designer's responsibility to restore it when the screen returns to normal.
NOTE: This routine is not yet fully implemented. The sat parameter currently does nothing, due to technical limitations. Saturation changes will be implemented during the planned graphics engine rewrite.
Related topics
This help file was created with the free trial version of HelpScribble.