Difference between revisions of "GetNextArea"

From NWN Lexicon
Jump to: navigation, search
(Example: Prints the name of all areas in a module to log. - example provided to shadguy by milliorn)
m (Version: applied patch template)
 
Line 12: Line 12:
  
 
===Version===
 
===Version===
[https://www.beamdog.com/files/nwnee_release_notes.pdf 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.
+
{{patchnwnee|patch=1.74.8149|link=https://www.beamdog.com/files/nwnee_release_notes.pdf}}
 +
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===
 
===Example===

Latest revision as of 04:45, 19 September 2021

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 next area in the module.
object GetNextArea();

Description

Returns the next area in the module (after GetFirstArea), or OBJECT_INVALID if no more areas are loaded.

Remarks

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

Version

This function was added in 1.74.8149 of NWN:EE.

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: GetFirstArea()



 author: Shadguy