GetMenuItemFilter

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Returns a code indicating the current item-filter option selected in the specified menu. If useMenuTarget is non-zero, the function returns the filter selected for the target reference (right side). Otherwise, it returns the filter selected for the player (left side).

Filter codes:

0	None
1	Weapons
2	Apparel
3	Aid
4	Misc
5	Ammo

Syntax

[help]
(filterCode:int) GetMenuItemFilter menuCode:int useMenuTarget:0/1

Example

GetMenuItemFilter 1002

This will return the item-filter selected in the pip-boy's inventory screen.

GetMenuItemFilter 1008 1

This will return the item-filter selected for the target actor/container in the container menu.

Notes

  • This function is usable only with the inventory, container and barter menus (1002, 1008 and 1053, respectively).

See Also