Difference between revisions of "Body:getAngle"

m (1 revision: Imported docs from potato.)
Line 1: Line 1:
  
 +
Get the angle of the body.
 +
 +
The angle is measured in [http://en.wikipedia.org/wiki/Radian radians]. If you need to transform it to degrees, use [http://www.lua.org/manual/5.1/manual.html#pdf-math.deg math.deg].
 +
 +
 +
A value of 0 radians will mean "looking to the right". Although radians increase counter-clockwise, the y axis points down so it becomes ''clockwise'' from our point of view.
  
 
== Function ==
 
== Function ==
Line 13: Line 19:
 
* [[parent::Body]]
 
* [[parent::Body]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Get the angle of the body.
 +
}}

Revision as of 16:17, 14 February 2010

Get the angle of the body.

The angle is measured in radians. If you need to transform it to degrees, use math.deg.


A value of 0 radians will mean "looking to the right". Although radians increase counter-clockwise, the y axis points down so it becomes clockwise from our point of view.

Function

Synopsis

angle = Body:getAngle( )

Arguments

None.

Returns

number angle
The angle in radians.

See Also