GetDistance - ObjectReference
Revision as of 15:49, 15 January 2014 by imported>Plplecuyer
Member of: ObjectReference Script
Calculates the distance between this object and the passed in one.
Syntax
float Function GetDistance(ObjectReference akOther) nativeParameters
- akOther: The object to find the distance to.
Return Value
The distance between this object and the other one. (Objects should be in the same interior, or same worldspace, otherwise this will be a very large number)
Examples
; Find out how far away the player is from the chest (assuming they are in the same interior or worldspace)
Debug.Trace("Player is " + Game.GetPlayer().GetDistance(Chest) + " units away from the chest")Notes
- If you are wanting to know when something is closer or farther then a specified distance from another one, you should instead use RegisterForDistanceLessThanEvent or RegisterForDistanceGreaterThanEvent instead of constantly checking the distance using this function manually which is less efficient.