GetIsAreaNatural
From NWN Lexicon
Contents |
[edit] GetIsAreaNatural(object)
Returns whether an area is natural or not
int GetIsAreaNatural( object oArea );
[edit] Parameters
oArea
Area to test whether is natural
[edit] Description
Returns AREA_NATURAL if the area oArea is natural, AREA_ARTIFICIAL otherwise.
Returns AREA_INVALID, on an error.
[edit] Remarks
The natural / artificial status of the area is set in the area's properties under the advanced tab.
AREA_NATURAL is declared as 1 in nwscript.nss, and AREA_ARTIFICIAL as 0. So you could also say that the function returns TRUE if the area is natural, and FALSE otherwise.
[edit] Version
1.32
[edit] See Also
| functions: | |
| constants: |
author: Lilac Soul, editor: Mistress
