- Found in:
- Vanilla
boolfunctionCheckObjectReferenceAgainstArray(ObjectReferenceObjectToCheck, ObjectReference[]ArrayToCheck, boolreturnValueIfArrayIsEmpty=false)Global
Description
Wiki Description
Checks to see if the passed in reference is in the array. (Basically a wrapper around a simple find, with some None checks)
Documentation Comment
jduvall
Parameters
ObjectReferenceObjectToCheck
CK Wiki Description
The ObjectReference we are looking for
ObjectReference[]ArrayToCheck
CK Wiki Description
The ObjectReference Array we are looking in
boolreturnValueIfArrayIsEmpty=false
CK Wiki Description
If the array is empty, return this.
- Default:False
Examples
if CommonArrayFunctions.CheckObjectReferenceAgainstArray(ShinyThing, InterestingObjects)
Debug.Trace("Shiny thing is interesting!")
endifAuto-Generated Example
ObjectReference myObjectReference__ObjectToCheck
ObjectReference[] myObjectReferenceArray__ArrayToCheck
bool myBool__returnValueIfArrayIsEmpty
bool returnedValue = CommonArrayFunctions.CheckObjectReferenceAgainstArray(myObjectReference__ObjectToCheck, myObjectReferenceArray__ArrayToCheck, myBool__returnValueIfArrayIsEmpty)Related Pages
Additional References
View this function’s page on the Fallout 4 Creation Kit Wiki