GetCurrentLocation - ObjectReference

Revision as of 15:51, 21 October 2011 by imported>Plplecuyer
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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.

See Also