GetFirstArea()

From NWN Lexicon
Jump to: navigation, search
Nwnee logo.jpg 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.
Returns the first area in the module.
object GetFirstArea();

Description

Returns the first area in the module.

Remarks

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

Version

1.74.8149 - Note that the description of this function was omitted from the PDF release notes. The function is described in a readme in the lang/<language>/docs directory delivered with Neverwinter Nights Enhanced Edition, and in the toolset script editor.

Example

//Prints the name of all areas in a module to log.
void main() 
{
    object oArea = GetFirstArea();
    while (GetIsObjectValid(oArea))
    {
        WriteTimestampedLogEntry(GetName(oArea));
        oArea = GetNextArea();
    }
}

See Also

functions: GetNextArea()



 author: Shadguy