GetAreaNoRestFlag(object)

From NWN Lexicon
Jump to navigationJump to search

Gets if there is no resting in the given area.

int GetAreaNoRestFlag(
    object oArea = OBJECT_INVALID
);

Parameters

oArea
The area to be affected (default: OBJECT_INVALID).

Description

Gets the NoRest area flag.

Returns TRUE if resting is not allowed in the area.

Passing in OBJECT_INVALID to parameter oArea will result in operating on the area of the caller.


Remarks

This can be set in the toolset and edited live, the flag will change the button GUI clientside and the button can still be checked with GUI events.


Version

This function was added in 88.8193.36-11 of NWN:EE.


Example


See Also

functions: 

SetAreaNoRestFlag