SetFogAmount(int, int, object)

Sets the fog amount in the area.

void SetFogAmount(
    int nFogType,
    int nFogAmount,
    object oArea = OBJECT_INVALID
);

Parameters

nFogType

FOG_TYPE_* specifies whether the Sun, Moon, or both fog types are set.

nFogAmount

Specifies the density that the fog is being set to.

oArea

The area to set the fog amount in. (Default: OBJECT_INVALID - caller's area)


Description

Sets the fog amount in the area.

If no valid area (or object) is specified, it uses the area of caller.

If an object other than an area is specified, will use the area that the object is currently in.


Version

1.65

See Also

functions:  GetFogAmount | GetFogColor | SetFogColor
constants:  FOG_TYPE_* | FOG_COLOR_*
categories:  Area Functions

author: Mistress, editor: KooKoo