IsInList

From GECK
Jump to: navigation, search


A function included in the GECK for Fallout 3.

Description

Returns True (1) if the calling reference's base object is contained in the specified FormList.

Syntax

[help]
(0, 1:int) [Object].IsInList FormListID:ref

Example

SamAdamsBeerRef.IsInList AlcoholicDrinks 

Notes

  • Will return False (0) if the form list contains the object's reference itself, rather than its base form.
  • Use ListGetFormIndex (FOSE/NVSE) if you need to check if a reference is contained itself in a form list.
  • Or use IsRefInList(NVSE) to match either base objects or references.

See Also