- Found in:
- Vanilla
boolfunctionCheckLocationAgainstArray(LocationObjectToCheck, Location[]ArrayToCheck, boolreturnValueIfArrayIsEmpty=false, boolmatchIfChildLocation=false)Global
Description
Wiki Description
Checks to see if the specified location is in the array, or optionally is a child of one of the locations in the array.
Documentation Comment
kmk
Caveats
Parameters
boolreturnValueIfArrayIsEmpty=false
CK Wiki Description
If the array is empty, return this.
- Default:False
boolmatchIfChildLocation=false
CK Wiki Description
If true, will check each location to see if ObjectToCheck is a child of the location
- Default:False
Examples
if CommonArrayFunctions.CheckLocationAgainstArray(PlayerLocation, DiamondCityLocations, matchIfChildLocation = true)
Debug.Trace("Player is in a diamond city location! (or a child thereof)")
endIfAuto-Generated Example
Location myLocation__ObjectToCheck
Location[] myLocationArray__ArrayToCheck
bool myBool__returnValueIfArrayIsEmpty
bool myBool__matchIfChildLocation
bool returnedValue = CommonArrayFunctions.CheckLocationAgainstArray(myLocation__ObjectToCheck, myLocationArray__ArrayToCheck, myBool__returnValueIfArrayIsEmpty, myBool__matchIfChildLocation)Related Pages
Additional References
View this function’s page on the Fallout 4 Creation Kit Wiki