Difference between revisions of "B2.createFrictionJointDef"

Line 9: Line 9:
 
(table) = b2.createFrictionJointDef(bodyA,bodyB,anchorx,anchory)
 
(table) = b2.createFrictionJointDef(bodyA,bodyB,anchorx,anchory)
 
</source>
 
</source>
'''bodyA''': (b2.Body) the first attached body ''''''<br/>
+
=== Parameters ===
'''bodyB''': (b2.Body) the second attached body ''''''<br/>
+
'''bodyA''': (b2.Body) the first attached body <br/>
'''anchorx''': (number) the x coordinate of the world anchor point ''''''<br/>
+
'''bodyB''': (b2.Body) the second attached body <br/>
'''anchory''': (number) the y coordinate of the world anchor point ''''''<br/>
+
'''anchorx''': (number) the x coordinate of the world anchor point <br/>
 +
'''anchory''': (number) the y coordinate of the world anchor point <br/>
 +
=== Return values ===
 
'''Returns''' (table) A new friction joint definition table<br/>
 
'''Returns''' (table) A new friction joint definition table<br/>
 +
=== Examples ===
 +
'''Friction joint'''<br/>
 +
<source lang="lua">--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)</source>

Revision as of 11:41, 23 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)