Difference between revisions of "IsInList"
Jump to navigation
Jump to search
imported>Geckbot m (Robot: Automated text replacement (-\[\[Category:(.*?)\(GECK 1.0\)\]\] +Category:\1(GECK 1.1))) |
imported>Odessa (Clarified common mistake) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
|origin = GECK1 | |origin = GECK1 | ||
|summary = | |summary = Returns True (1) if the calling reference's <b>base object</b> is contained in the specified [[FormList]]. | ||
|name = IsInList | |name = IsInList | ||
|returnVal = 0, 1 | |returnVal = 0, 1 | ||
| Line 14: | Line 14: | ||
}} | }} | ||
==Notes== | ==Notes== | ||
*Use [[ListGetFormIndex]] to | *Will return False (0) if the calling reference is contained in the list exactly (reference is itself in form list and not it's 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== | ==See Also== | ||
*[[IsRefInList]] | |||
*[[IsWeaponInList]] | |||
*[[ListGetFormIndex]] | |||
*[[ListAddForm]] | *[[ListAddForm]] | ||
*[[ListAddReference]] | *[[ListAddReference]] | ||
| Line 24: | Line 29: | ||
*[[ListReplaceNthForm]] | *[[ListReplaceNthForm]] | ||
*[[ListGetNthForm]] | *[[ListGetNthForm]] | ||
*[[ListGetCount]] | *[[ListGetCount]] | ||
*[[AddFormToFormList]] | *[[AddFormToFormList]] | ||
[[Category:List Functions]] | [[Category:List Functions]] | ||
Latest revision as of 17:29, 1 July 2014
< [[::Category:Functions|Category:Functions]]
A function included in the GECK version 1.1.0.36.
Description
Returns True (1) if the calling reference's base object is contained in the specified FormList.
Syntax
(0, 1:int) [Object].IsInList FormListID:ref
Example
SamAdamsBeerRef.IsInList AlcoholicDrinks
Notes
- Will return False (0) if the calling reference is contained in the list exactly (reference is itself in form list and not it's 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.