Background for Fallout 4
Member of the CommonArrayFunctions script
boolfunctionCheckActorAgainstFactionArray(ActorObjectToCheck, Faction[]ArrayToCheck, boolreturnValueIfArrayIsEmpty=false)Global

Description

Wiki Description

Loops through an array of Factions and checks if the specified actor in in any of them.

Documentation Comment

jduvall


Caveats


Parameters

ActorObjectToCheck

CK Wiki Description

The Actor whose factions we are looking for

Faction[]ArrayToCheck

CK Wiki Description

The Faction array we are looking in

boolreturnValueIfArrayIsEmpty=false

CK Wiki Description

If the array is empty, return this.

  • Default:False

Examples

if CommonArrayFunctions.CheckActorAgainstFactionArray(Dogmeat, HostileFactions)
   Debug.Trace("Dogmeat is in a hostile faction!")
endIf

Auto-Generated Example

Actor myActor__ObjectToCheck
Faction[] myFactionArray__ArrayToCheck
bool myBool__returnValueIfArrayIsEmpty

bool returnedValue = CommonArrayFunctions.CheckActorAgainstFactionArray(myActor__ObjectToCheck, myFactionArray__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.