GetFogAmount

From NWN Lexicon
Jump to: navigation, search


GetFogAmount(int, object)

Used to determine amount of fog in an area.

int GetFogAmount(
    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 amount of. (Default: OBJECT_INVALID)


Description

Used to determine amount of fog in an area.

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.



Example

See SetFogAmount .

Version

1.65

See Also

functions: 

SetFogColor

constants: 

FOG_COLOR_*



author: bernosky, editor: Mistress, Kookoo, contributor: Axe Murderer