ShowQuantityMenu

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Opens an instance of the Quantity Menu.

The function takes three arguments:

  • callbackScript - A UDF script that shall be invoked once the Quantity Menu is closed. The script is passed with a single argument - the selected quantity (see example script, below). If Cancel was selected, -1 is passed.
  • maxQuantity - The maximum selected quantity in the menu.
  • initQuantity - The initial selected quantity when the menu is opened.

Syntax

[help]
ShowQuantityMenu callbackScript:ref maxQuantity:int initQuantity:int

Example

ShowQuantityMenu QuantityMenuUDF 123
ShowQuantityMenu QuantityMenuUDF 1000 250 

Callback Script

A skeleton script for a callback:

scn	QuantityMenuUDF

int	iQuantity

begin Function {iQuantity}

(code)

end

Notes

  • To change the text shown by the quantity menu, the sHowMany string gamesetting can be modified by using SetStringSetting or other means.

See Also