Background for Fallout 4

Location


Inheritance Tree

No indexed scripts extend this script.

Structs
Properties
Events
Functions
voidfunctionAddLinkedLocation(LocationakLoc, KeywordakKeyword)Native

Adds a link between this location and the given one under the given keyword.

Location[]functionGetAllLinkedLocations(KeywordakKeyword)Native

Returns an array of all locations linked to this one under the given keyword.

floatfunctionGetKeywordData(KeywordakKeyword)Native

Obtains the data attached to the specified keyword on this location.

intfunctionGetRefTypeAliveCount(LocationRefTypeakRefType)Native

Obtains the number of alive enabled references matching the specified reference type in this location.

intfunctionGetRefTypeDeadCount(LocationRefTypeakRefType)Native

Obtains the number of dead enabled references matching the specified reference type in this location.

boolfunctionHasCommonParent(LocationakOther, KeywordakFilter=NONE)Native

Returns if this location and the other have a common parent (filtering with a keyword, if provided). If the locations are identical, the function will return false.

boolfunctionHasEverBeenCleared()Native

Returns if this location has ever been cleared.

boolfunctionHasRefType(LocationRefTypeakRefType)Native

Returns if this location has any unreserved refs with the specified LocationRefType.

boolfunctionIsCleared()Native

Returns if this location is flagged as cleared or not.

boolfunctionIsChild(LocationakOther)Native

Returns true if the other location is a child of this one. If they are the same location, the function returns false.

boolfunctionIsLinkedLocation(LocationakLocation, KeywordakKeyword)Native

Checks for a link between this location and the given one under the given keyword.

boolfunctionIsLoaded()Native

Returns if this location is loaded or not.

boolfunctionIsSameLocation(LocationakOtherLocation, KeywordakKeyword=NONE)

Returns true if the calling location is the same as the supplied location. Or, if an optional keyword is supplied it also returns true if the locations share a parent with that keyword, or one of the locations has the keyword and is a parent of the other.

voidfunctionModifyKeywordData(KeywordakKeyword, floatafData)

Modifies the data attached to the specified keyword on this location by adding the passed-in data to the current value, but as a single function call so it is thread-safe.

voidfunctionRemoveLinkedLocation(LocationakLoc, KeywordakKeyword)Native

Removes the link between this location and the given one under the given keyword.

voidfunctionReset()Native

Flags all encounter zones and interior cells associated with this location for forced reset.

voidfunctionSetKeywordData(KeywordakKeyword, floatafData)Native

Sets the data attached to the specified keyword on this location.

voidfunctionSetCleared(boolabCleared=true)Native

Flags or unflags this location as cleared.

LocationfunctionGetParent()Native

Returns the parent location

voidfunctionSetParent(LocationakLocation)Native
EncounterZonefunctionGetEncounterZone(boolrecursive=false)Native

Returns the locations EncounterZone, if recursive it goes up a parent until it finds an EncounterZone

voidfunctionSetEncounterZone(EncounterZoneez)Native

Sets this locations encounter zone

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