Difference between revisions of "B2.createFrictionJointDef"

 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
<languages />
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[Special:MyLanguage/b2|b2]]<br/>
 +
 
=== Description ===
 
=== Description ===
<br />
+
Creates and returns a friction joint definition table with the bodies and local anchors using a world anchor point.
Creates and returns a friction joint definition table with the bodies and local anchors using a world anchor point.<br />
+
 
(Please refer to [[b2.World:createJoint]] function for more information about all the information needed to create a friction joint).<br />
+
(Please refer to [[b2.World:createJoint]] function for more information about all the information needed to create a friction joint).
<br />
 
 
<source lang="lua">
 
<source lang="lua">
 
(table) = b2.createFrictionJointDef(bodyA,bodyB,anchorx,anchory)
 
(table) = b2.createFrictionJointDef(bodyA,bodyB,anchorx,anchory)
 
</source>
 
</source>
 +
 
=== Parameters ===
 
=== Parameters ===
 
'''bodyA''': (b2.Body) the first attached body <br/>
 
'''bodyA''': (b2.Body) the first attached body <br/>
Line 14: Line 17:
 
'''anchorx''': (number) the x 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/>
 
'''anchory''': (number) the y coordinate of the world anchor point <br/>
 +
 
=== Return values ===
 
=== Return values ===
 
'''Returns''' (table) A new friction joint definition table<br/>
 
'''Returns''' (table) A new friction joint definition table<br/>
 +
 
=== Examples ===
 
=== Examples ===
'''Friction joint'''<br/>
+
<source lang="lua">
<source lang="lua">--create empty box2d body for joint
+
--create empty box2d body for joint
 
local ground = world:createBody({})
 
local ground = world:createBody({})
 
ground:setPosition(350, 480)
 
ground:setPosition(350, 480)
Line 27: Line 32:
  
 
--set maximum friction force to slow down the ball
 
--set maximum friction force to slow down the ball
frictionJoint:setMaxForce(100)</source>
+
frictionJoint:setMaxForce(100)
 +
</source>
 +
 
 +
{{B2}}

Latest revision as of 05:42, 17 February 2020


Available since: Gideros 2011.6
Class: b2

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

--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)





LiquidFun