SetObjectUiDiscoveryMask(object, int)

From NWN Lexicon
Jump to navigationJump to 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.

Sets the discoverability mask on oObject.

void SetObjectUiDiscoveryMask(
    object oObject,
    int nMask = OBJECT_UI_DISCOVERY_DEFAULT
);


Parameters

oObject
The object to apply the discoverability mask to.
nMask
The discoverability mask to apply to oObject.


Description

Sets the discoverability mask on oObject. This allows toggling areahilite (TAB key by default) and mouseover discovery in the area view.

nMask is a mask of OBJECT_UI_DISCOVERY_MODE_*

Will currently only work on Creatures, Doors (Hilite only), Items and Useable Placeables. Does not affect inventory items.


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.86.8193.35 of NWN:EE.


Example

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


See Also

constants:  OBJECT_UI_DISCOVERY_MODE_* Constants
functions: GetObjectUiDiscoveryMask()

 author: Shadguy