Background for Fallout 4
Member of the CommonArrayFunctions script
boolfunctionCheckObjectReferenceAgainstReferenceAliasArray(ObjectReferenceObjectToCheck, ReferenceAlias[]ArrayToCheck, boolreturnValueIfArrayIsEmpty=false)Global

Description

Wiki Description

Loops through an array of ReferenceAliases and checks if any of them have the specified ObjectReference in them.

Documentation Comment

jduvall


Caveats


Parameters

ObjectReferenceObjectToCheck

CK Wiki Description

The ObjectReference we are looking for

ReferenceAlias[]ArrayToCheck

CK Wiki Description

The ReferenceAlias Array we are looking in

boolreturnValueIfArrayIsEmpty=false

CK Wiki Description

If the array is empty, return this.

  • Default:false

Examples

if CommonArrayFunctions.CheckObjectReferenceAgainstReferenceAliasArray(ShinyThing, QuestObjectAliases)
   Debug.Trace("Shiny thing is a quest object!")
endif

Auto-Generated Example

ObjectReference myObjectReference__ObjectToCheck
ReferenceAlias[] myReferenceAliasArray__ArrayToCheck
bool myBool__returnValueIfArrayIsEmpty

bool returnedValue = CommonArrayFunctions.CheckObjectReferenceAgainstReferenceAliasArray(myObjectReference__ObjectToCheck, myReferenceAliasArray__ArrayToCheck, myBool__returnValueIfArrayIsEmpty)

Related Pages


Additional References

View this function’s page on the Fallout 4 Creation Kit Wiki

Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.