- Found in:
- Vanilla
boolfunctionCheckFormAgainstArray(FormFormToCheck, Form[]ArrayToCheck, boolreturnValueIfArrayIsEmpty=false)Global
Description
Wiki Description
Checks to see if the passed in form is in the array. (Basically wrapping a find call with a couple of additional checks to handle None)
Documentation Comment
dbrigner
Parameters
FormFormToCheck
CK Wiki Description
The Form to look for
Form[]ArrayToCheck
CK Wiki Description
The Form array we are looking in
boolreturnValueIfArrayIsEmpty=false
CK Wiki Description
If the array is empty, return this.
- Default:false
Examples
if CommonArrayFunctions.CheckFormAgainstArray(Car, FuelEfficientCars)
Debug.Trace("The car is fuel efficient!")
endIfAuto-Generated Example
Form myForm__FormToCheck
Form[] myFormArray__ArrayToCheck
bool myBool__returnValueIfArrayIsEmpty
bool returnedValue = CommonArrayFunctions.CheckFormAgainstArray(myForm__FormToCheck, myFormArray__ArrayToCheck, myBool__returnValueIfArrayIsEmpty)Related Pages
Additional References
View this function’s page on the Fallout 4 Creation Kit Wiki