Difference between revisions of "Contact:getVelocity"

m (1 revision: Importing from potato (again).)
(add detail)
Line 1: Line 1:
 
  
 
== Function ==
 
== Function ==
 +
Get the linear impact velocity of a contact.
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Contact:getVelocity( )
+
vx, vy = Contact:getVelocity( )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
Nothing.
+
{{param|number|vx|The x component of the velocity vector.}}
 +
{{param|number|vy|The y component of the velocity vector.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::Contact]]
 
* [[parent::Contact]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Get the linear impact velocity of a contact.}}

Revision as of 18:01, 6 March 2010

Function

Get the linear impact velocity of a contact.

Synopsis

vx, vy = Contact:getVelocity( )

Arguments

None.

Returns

number vx
The x component of the velocity vector.
number vy
The y component of the velocity vector.

See Also