SetTextInputExtendedProps

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Sets various extended properties of the currently active Text Input Menu.

The function takes up to five arguments:

  • offsetX - Override the horizontal (x) origin of the text input window to the specified value. If zero, use the default origin (center of the screen).
  • offsetY - Override the vertical (y) origin of the text input window to the specified value. If zero, use the default origin (center of the screen).
  • minLength (optional) - The minimum number of characters the input text must contain before the OK button may be pressed; defaults to 1.
  • maxLength (optional) - The maximum number of characters the input text may contain, after which further input is ignored. If omitted, or if zero, defaults to 32,767.
  • switches (optional) - A bit-mask of switches, as specified below; defaults to 0.
1	Digits only (including point)
2	Pressing 'Enter' closes menu (instead of new line)

Syntax

[help]
SetTextInputExtendedProps offsetX:float offsetY:float minLength:int maxLength:int switches:int

Example

SetTextInputExtendedProps 300 200

Position the text input window at x(300), y(200).

SetTextInputExtendedProps 0 0 1 10 3

Use default screen position; set minimum length to 1, maximum length to 10; allow digits only, pressing 'Enter' closes window.

See Also