GetAreaLightDirection(int, object)

Note: This article documents Neverwinter Nights: Enhanced Edition new content or changes/updates/fixes to 1.69 functions. These are all listed under the category and patches pages.

Gets the light direction of origin in the area specified.

vector GetAreaLightDirection(
    int nLightType,
    object oArea=OBJECT_INVALID,
);

Parameters

nLightType

The light type returned. Valid values are the AREA_LIGHT_DIRECTION_* constants.

oArea

The area to query for light direction.

Description

Gets the light direction of origin in the area specified.

* nLightType specifies whether the Moon or Sun light direction is returned.  Valid values for nColorType are the AREA_LIGHT_DIRECTION_* values.

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.

Remarks

This section of the article is a stub. You can help the NWN Lexicon by expanding it.

Version

This function was added in 1.86.8193.35 of NWN:EE.

Example

This article is in need of examples. You can help the NWN Lexicon by showing how to use this code effectively.

See Also

constants:	AREA_LIGHT_DIRECTION_* Constants
functions:	GetAreaLightColor() SetAreaLightColor() SetAreaLightDirection()

---

 author: Shadguy