Difference between revisions of "GetDistance"

Revision as of 12:07, 16 February 2008

Returns the distance in units from the calling object to the Reference "ObjectID".

Syntax:

GetDistance ObjectID

Examples:

GetDistance TestMarkerRef

Set distance to Getdistance Player

Ref Actor
 
Begin OnActivate 
  set Actor to GetActionRef 
  if Getdistance Actor > 70
    messagebox "Come closer my friend"
  endif
end

GetDistance isn't completely accurate when called on an actor who is swimming. For instance, player.getDistance player will return a value within the range of 95.0 to 110.0 while the player is swimming.
GetDistance does not return reliably in worldspaces when the target is a non-actor in a different cell. For instance, Player.GetDistance Object may not give the correct distance, whereas Object.GetDistance Player consistently does.

@@ Line 20: / Line 20: @@
 ==Notes==
 *[[GetDistance]] isn't completely accurate when called on an actor who is swimming. For instance, '''player.getDistance player''' will return a value within the range of 95.0 to 110.0 while the player is swimming.
+*[[GetDistance]] does not return reliably in worldspaces when the target is a non-actor in a different cell. For instance, '''Player.GetDistance Object''' may not give the correct distance, whereas '''Object.GetDistance Player''' consistently does.
 [[Category: Functions]]
 [[Category:Functions (CS)]]