- Found in:
- Vanilla
boolfunctionCheckLocationAgainstLocationAliasArray(LocationObjectToCheck, LocationAlias[]ArrayToCheck, boolreturnValueIfArrayIsEmpty=false, boolmatchIfChildLocation=false)Global
Description
Wiki Description
Loops through an array of location aliases and checks if the specified location in in any of them. (Or a child of one of them if matchIfChildLocation)
Documentation Comment
kmk
Parameters
LocationObjectToCheck
CK Wiki Description
The Location we are looking for
LocationAlias[]ArrayToCheck
CK Wiki Description
The LocationAlias array we are looking in
boolreturnValueIfArrayIsEmpty=false
CK Wiki Description
If the array is empty, return this.
- Default:False
boolmatchIfChildLocation=false
CK Wiki Description
If true, the location will match if it is a child of a location in an alias.
- Default:False
Examples
if CommonArrayFunctions.CheckLocationAgainstLocationAliasArray(PlayerLocation, QuestLocationAliases)
Debug.Trace("The player is in one of the quest locations! (But not a child location)")
endIfAuto-Generated Example
Location myLocation__ObjectToCheck
LocationAlias[] myLocationAliasArray__ArrayToCheck
bool myBool__returnValueIfArrayIsEmpty
bool myBool__matchIfChildLocation
bool returnedValue = CommonArrayFunctions.CheckLocationAgainstLocationAliasArray(myLocation__ObjectToCheck, myLocationAliasArray__ArrayToCheck, myBool__returnValueIfArrayIsEmpty, myBool__matchIfChildLocation)Related Pages
Additional References
View this function’s page on the Fallout 4 Creation Kit Wiki