NuiCreateFromResRef(object, string, string)

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.

Create a NUI window from the given resref(.jui) for the given player.

int NuiCreateFromResRef(
    object oPlayer,
    string sResRef,
    string sWindowId = ""
);


Parameters

oPlayer
The player to create a nui window for
sResRef
The .jui resref of the window to open
sWindowId
a short alphanumeric window id


Description

Create a NUI window from the given resref(.jui) for the given player.


Remarks

  • The resref needs to be available on the client, not the server.
  • The token is a integer for ease of handling only. You are not supposed to do anything with it, except store/pass it.
  • The window ID needs to be alphanumeric and short. Only one window (per client) with the same ID can exist at a time.

Re-creating a window with the same id of one already open will immediately close the old one.

  • See nw_inc_nui.nss for full documentation.

Returns the window token on success (>0), or 0 on error.


Version

This function was added in 1.85.8193.31 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

functions:

NUI Functions