GetCurrentLocation - ObjectReference

Member of: ObjectReference Script

Obtains this reference's current Location.

Syntax

Location Function GetCurrentLocation() native

Parameters

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)!")
endIf

Notes

• 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.
• The vast majority of wilderness cells do not have a location, to which this function will return none if the Cell has no location assigned to it and print an error to the log.

See Also

• ObjectReference Script
• GetEditorLocation - ObjectReference
• IsInLocation
• IsSameLocation