GetCurrentLocation - ObjectReference
Revision as of 05:42, 12 December 2014 by imported>Terra Nova2 (Function returns none if the cell isn't part of any location.)
Member of: ObjectReference Script
Obtains this reference's current Location.
Syntax
Location Function GetCurrentLocation() nativeParameters
None.
Return Value
This reference's current Location.
Examples
; Is this object in the tomb?
if (TombLocationProperty == SwordProperty.GetCurrentLocation())
Debug.Trace("The sword is in the tomb (but not a child location)!")
endIfNotes
- If you want to know if the actor is in the location or any of its children, you need to use IsInLocation.
- For example, if you want to know if the actor is in SolitudeLocation or any of the city interiors, use IsInLocation(SolitudeLocation).
- If you want to compare two different actors' locations TO one another, you probably want to use IsSameLocation.
- This function will return NONE until the actor has interacted with a navmesh. Thus, it does not work on a dragon while in flight, or while perched on a building. They must land on the ground first.
- This function will return none and post an error to the log if the cell isn't part of any location. This mostly applies to exterior cells, as the majority of interiors, with the exception of Dagon's shrine, and the vampire dreamworlds, are part of a location.