IsInLocation - ObjectReference | Fallout 4

Found in:

Vanilla
F4SE

boolfunctionIsInLocation(LocationakLocation)

Description

Wiki Description

Checks to see if this object is in the specified location, or a child of the specified location.

Documentation Comment

Convenience function to check if I'm in a location or any of its children

Caveats

Parameters

LocationakLocation

CK Wiki Description

The Location to check.

Examples

; Is the box in the house location?
if Box.IsInLocation(House)
  Debug.Trace("Box is in the house!")
endIf; Is the box in the house location?
if Box.IsInLocation(House)
  Debug.Trace("Box is in the house!")
endIf

Auto-Generated Example

Location myLocation__akLocation

bool returnedValue = myObjectReference__toCallFunctionOn.IsInLocation(myLocation__akLocation)

ObjectReference
ObjectReference.GetCurrentLocation()
Location.IsChild(...)

Additional References

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