NX IsInList

A function added by the NX NVSE plugin.

Description

Checks whether an item, which may be a base object, reference or dynamic reference, is contained in a specified form list, and returns one of five possible int values detailing how it was found.

Syntax

[help]

(int) NX_IsInList ToCheck:formlist For:form

Return Values

The return value is based on this order of priority:

• 1 : Item in list exactly.
• 2 : Base form of item in list.
• 3 : Item is a base form of another item in list.
• 4 : Base form of item is the same as base form of another item in list.
• 0 : None of the above

Example

ref rItem
if NX_IsInList SomeFormList rItem == 1
    ; reference rItem is in SomeFormList exactly
endif

Be cautious using this, as the function does not return a simple boolean:

if NX_IsInList SomeFormList rItem
    ; Condition evaluates True if return is 1, 2, 3 or 4
endif

Notes

• Like IsInList, this function may give unexpected results if one is unaware of its scope.

See Also

• IsInList (checks if the base form of a reference is in a list only)
• IsRefInList
• ListGetFormIndex