Difference between revisions of "GetHeadingAngle"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>Omzy
m
imported>Omzy
m
Line 6: Line 6:
  |returnVal = -180 to 180
  |returnVal = -180 to 180
  |returnType = float
  |returnType = float
  |referenceType = ObjectRef
  |referenceType = [ObjectRef]
  |arguments =  
  |arguments =  
   {{FunctionArgument
   {{FunctionArgument

Revision as of 23:21, 30 July 2009

< [[::Category:Functions|Category:Functions]]

Link to TES4 Construction Set Wiki: GetHeadingAngle.

A function included in the GECK version 1.1.0.36.

Description

Returns the angle between the calling reference and the specified object in a range from -180 to 180 degrees.

Syntax

[help]
(-180 to 180:float) [ObjectRef].GetHeadingAngle ObjectRef:ref

Example

Player.GetHeadingAngle StrangeStatue

Notes

  • Do not confuse this function with GetAngle Z, which returns the heading angle of an object relative to the world.
  • The direction the calling reference is facing is considered 0 degrees.
  • Angles measured clockwise from 0 are positive, while angles measured counter-clockwise from 0 are negative.
  • In the example above, if the player is facing north and the object StrangeStatue is due west of the player, the returned value would be -90.
  • When you add this value to the calling references's current heading angle (Z angle), he will face the specified ObjectRef:
  set angle to Player.GetAngle Z + Player.GetHeadingAngle StrangeStatue
  Player.SetAngle Z angle 

See Also