Dim

Note: This feature is for ZScript only.

Screen

native static void Dim(Color col, double amount, int x, int y, int w, int h, ERenderStyle style = STYLE_Translucent)

Usage

Used to blend the screen in the specified bounding box to a color. If using a palette color is desired then Clear should be used instead. Coordinates are absolute and start from the top left of the screen with positive x values shifting to the right and positive y values shifting downward.

Warning: This can only be called from within functions that are specifically designed to draw UI elements (e.g. BaseStatusBar's Draw() or EventHandler's RenderOverlay()).

Parameters

• Color col

The color to fill the area of the box with

• double amount

The alpha value of the color. A value of 1 is fully opaque while a value of 0 is fully transparent

• int x

The x offset of the box

• int y

The y offset of the box

• int w

The width of the box

• int h

The height of the box

• ERenderStyle style

The renderstyle to apply to the blend. Defaults to STYLE_Translucent.

Examples

This fills the entire screen in black color:

Screen.Dim(0x000000, 1.0, 0, 0, Screen.GetWidth(), Screen.GetHeight());