Difference between revisions of "B2.createFrictionJointDef"

Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
'''Available since:''' Gideros 2011.6<br/>
+
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
=== Description ===
+
=== <translate>Description</translate> ===
 
<translate><br />
 
<translate><br />
 
Creates and returns a friction joint definition table with the bodies and local anchors using a world anchor point.<br />
 
Creates and returns a friction joint definition table with the bodies and local anchors using a world anchor point.<br />
Line 9: Line 9:
 
(table) = b2.createFrictionJointDef(bodyA,bodyB,anchorx,anchory)
 
(table) = b2.createFrictionJointDef(bodyA,bodyB,anchorx,anchory)
 
</source>
 
</source>
=== Parameters ===
+
=== <translate>Parameters</translate> ===
 
'''bodyA''': (b2.Body) <translate>the first attached body</translate> <br/>
 
'''bodyA''': (b2.Body) <translate>the first attached body</translate> <br/>
 
'''bodyB''': (b2.Body) <translate>the second attached body</translate> <br/>
 
'''bodyB''': (b2.Body) <translate>the second attached body</translate> <br/>
 
'''anchorx''': (number) <translate>the x coordinate of the world anchor point</translate> <br/>
 
'''anchorx''': (number) <translate>the x coordinate of the world anchor point</translate> <br/>
 
'''anchory''': (number) <translate>the y coordinate of the world anchor point</translate> <br/>
 
'''anchory''': (number) <translate>the y coordinate of the world anchor point</translate> <br/>
=== Return values ===
+
=== <translate>Return values</translate> ===
'''Returns''' (table) <translate>A new friction joint definition table</translate><br/>
+
'''<translate>Returns</translate>''' (table) <translate>A new friction joint definition table</translate><br/>
=== Examples ===
+
=== <translate>Examples</translate> ===
 
'''Friction joint'''<br/>
 
'''Friction joint'''<br/>
 
<source lang="lua">--create empty box2d body for joint
 
<source lang="lua">--create empty box2d body for joint

Revision as of 07:27, 24 August 2018

Available since: Gideros 2011.6

Description


Creates and returns a friction joint definition table with the bodies and local anchors using a world anchor point.
(Please refer to b2.World:createJoint function for more information about all the information needed to create a friction joint).

(table) = b2.createFrictionJointDef(bodyA,bodyB,anchorx,anchory)

Parameters

bodyA: (b2.Body) the first attached body
bodyB: (b2.Body) the second attached body
anchorx: (number) the x coordinate of the world anchor point
anchory: (number) the y coordinate of the world anchor point

Return values

Returns (table) A new friction joint definition table

Examples

Friction joint

--create empty box2d body for joint
local ground = world:createBody({})
ground:setPosition(350, 480)

--create friction joint
local jointDef = b2.createFrictionJointDef(body, ground, 350, 200)
local frictionJoint = world:createJoint(jointDef)

--set maximum friction force to slow down the ball
frictionJoint:setMaxForce(100)