Difference between revisions of "IsInList"
Jump to navigation
Jump to search
imported>Cipscis m (→Notes: This hasn't been tested, but makes perfect sense to me) |
imported>Odessa (Clarified common mistake) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
==' | {{Function | ||
|origin = GECK1 | |||
|summary = Returns True (1) if the calling reference's <b>base object</b> is contained in the specified [[FormList]]. | |||
|name = IsInList | |||
|returnVal = 0, 1 | |||
|returnType = int | |||
|referenceType = [Object] | |||
|arguments = | |||
{{FunctionArgument | |||
|Name = FormListID | |||
|Type = 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. | |||
==See Also== | |||
*[[IsRefInList]] | |||
*[[IsWeaponInList]] | |||
*[[ListGetFormIndex]] | |||
*[[ListAddForm]] | |||
*[[ListAddReference]] | |||
*[[ListRemoveForm]] | |||
*[[ListRemoveNthForm]] | |||
*[[ListReplaceForm]] | |||
*[[ListReplaceNthForm]] | |||
*[[ListGetNthForm]] | |||
* | *[[ListGetCount]] | ||
*[[AddFormToFormList]] | |||
[[ | |||
[[Category:List Functions]] | |||
[[Category:List Functions (GECK 1.1)]] | |||
[[Category:Condition Functions]] | |||
[[Category:Condition Functions (GECK 1.1)]] | |||
[[Category:Functions]] | [[Category:Functions]] | ||
[[Category: | [[Category:Functions (GECK 1.1)]] | ||
Latest revision as of 18: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.