NuiTextEdit( json, json, int, int )

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.

A editable text field.

// A editable text field.
json                     // Element
NuiTextEdit(
  json jPlaceholder,     // Bind:String
  json jValue,           // Bind:String
  int nMaxLength,        // UInt >= 1, <= 65535
  int bMultiline         // Bool
);

Returns

jons Element

Parameters

jPlaceholder

Can be either a JsonString or NuiBind (don't get it confused with NWN string).

Place holder is the initial string user will see (unless jValue is updated or they start typing). It comes in grayish, not white like jValue. So it can be used to give players hints on what is expected. If field is blank, it'll also revert to this value.

jValue

Can be either a JsonString or NuiBind (don't get it confused with NWN string).

The value to be updated to. Can be "" if you want to clear it.

nMaxLength

Max Length of text edit box. Note: this is a NWN int, NOT a JsonInt

bMultiline

Can be single or multi line. Note: this is a NWN "bool", NOT a JsonBool.

Description

A editable text field.

Remarks

• if bMultiLine is FALSE, then the enter/return character isn't recorded in the jValue bind.
• if bMultiLine is TRUE, then it can contain enter/return characters (Shows up as '\n')

Version

This function was added in 1.85.8193.31 of NWN:EE.

Example

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