GetMenuItemListRefs

A function added by the JIP NVSE Plugin.

Description

Returns a Map Array containing, as values, the Inventory References associated with the UI ListBox items of the current active menu.

The keys of the map-array are the indices of their paired items in the un-filtered UI ListBox. These indices may be used for easy access to the UI Tile connected to the list item, for retrieving/modifying its properties. Example:

GetUIFloatAlt "ContainerMenu/NOGLOW_BRANCH/CM_ItemsRect/CM_Items_InventoryList/*:24/x"

Supported menus:

1002	Pip-Boy Inventory Menu
1008	Container Menu
1035	Repair Menu
1053	Barter Menu
1058	Repair Services Menu

The function takes 2 optional arguments:

• inclFiltered - If non-zero, all list items will be returned in the array, including those not shown. Otherwise, only list items that are shown and selectable will be returned.
• rightPanel - In menus where there are two panels (left and right), passing this argument as non-zero will return an array of the right-panel items.

Syntax

[help]

(menuItems:array_var) GetMenuItemListRefs inclFiltered:0/1 rightPanel:0/1

Example

let aMenuItems := GetMenuItemListRefs

let aMenuItems := GetMenuItemListRefs 1 1 

Notes

• For iterating over the returned Map Array, use a ForEach loop.