GetFogColor(int, object)

Gets the fog color in the area specified.

int GetFogColor(
    int nFogType,
    object oArea = OBJECT_INVALID
);

Parameters

nFogType

Specifies whether the Sun, or Moon fog type is returned. Valid values for nFogType are FOG_TYPE_SUN or FOG_TYPE_MOON.

oArea

The area to get the fog color of. (Default: OBJECT_INVALID)


Description

Gets the fog color in the area specified.

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

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:  SetFogColor | GetFogAmount | SetFogAmount
constants:  FOG_TYPE_* | FOG_COLOR_*
categories:  Area Functions


author: bernosky, editor: Mistress, KooKoo