Difference between revisions of "OpenTextInput"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>CSbot
(Automated import of articles)
 
imported>QQuix
(Updated: menuType was missing from the parm list)
 
Line 1: Line 1:
{{BotAddedPage|CSbot|DragoonWraith}}
{{Function
{{Function
  | origin = OBSE
  | origin = OBSE
  | summary = Opens a text input menu if one is not currently in use. MenuType is 0 for a messagebox, 1 for a book, or 2 for a scroll. The MaxLength parameter specifies how many characters to allow the user to enter. For messageboxes, the prompt string will be displayed before the cursor and cannot be erased. It may also contain buttons, with the button text separated from the prompt text with pipe '|' characters as in [[MessageBoxEX]]. For books and scrolls, the prompt string serves as the default text visible as soon as the menu is opened and may be edited by the user.
  | summary = Opens a text input menu if one is not currently in use.  
 
MenuType is  
:*0 for a messagebox,  
:*1 for a book, or  
:*2 for a scroll.  
 
The MaxLength parameter specifies how many characters to allow the user to enter.  
 
For messageboxes, the prompt string will be displayed before the cursor and cannot be erased. It may also contain buttons, with the button text separated from the prompt text with pipe '|' characters as in [[MessageBoxEX]].  
 
For books and scrolls, the prompt string serves as the default text visible as soon as the menu is opened and may be edited by the user.
  | name = OpenTextInput
  | name = OpenTextInput
  | arguments =  
  | arguments =  
Line 10: Line 20:
   }}{{FunctionArgument
   }}{{FunctionArgument
   | name = var1
   | name = var1
  | type = varies
   | optional = y
   | optional = y
   }}{{FunctionArgument
   }}{{FunctionArgument
   | name = var2
   | name = var2
  | type = varies
   | optional = y
   | optional = y
   }}{{FunctionArgument
   }}{{FunctionArgument
   | name = ... var20
   | name = ... var20
   | type = varies
  | optional = y
  }}{{FunctionArgument
  | name = menuType
   | type = int
   | optional = y
   | optional = y
   }}{{FunctionArgument
   }}{{FunctionArgument

Latest revision as of 07:29, 16 August 2013

< [[::Category:Functions|Category:Functions]]

A function added by the Oblivion Script Extender.

Syntax:

(void) OpenTextInput promptString:string var1 var2 ... var20 menuType:int maxLength:short

Opens a text input menu if one is not currently in use.

MenuType is

  • 0 for a messagebox,
  • 1 for a book, or
  • 2 for a scroll.

The MaxLength parameter specifies how many characters to allow the user to enter.

For messageboxes, the prompt string will be displayed before the cursor and cannot be erased. It may also contain buttons, with the button text separated from the prompt text with pipe '