Difference between revisions of "B2.createFrictionJointDef"
From GiderosMobile
(Created page with "__NOTOC__ '''Available since:''' Gideros 2011.6<br/> === Description === <br /> Creates and returns a friction joint definition table with the bodies and local anchors using a...") |
m (Text replacement - "</source>" to "</syntaxhighlight>") |
||
| (8 intermediate revisions by 2 users 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 === | ||
| − | + | 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. | + | |
| − | (Please refer to [[b2.World:createJoint]] function for more information about all the information needed to create a friction joint). | + | (Please refer to [[b2.World:createJoint]] function for more information about all the information needed to create a friction joint). |
| − | < | + | <syntaxhighlight lang="lua"> |
| − | + | (table) = b2.createFrictionJointDef(bodyA,bodyB,anchorx,anchory) | |
| − | (table) | + | </syntaxhighlight> |
| − | </ | + | |
| − | '''bodyA | + | === Parameters === |
| − | '''bodyB | + | '''bodyA''': (b2.Body) the first attached body <br/> |
| − | '''anchorx | + | '''bodyB''': (b2.Body) the second attached body <br/> |
| − | '''anchory | + | '''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 === | ||
| + | <syntaxhighlight 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) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | {{B2}} | ||
Latest revision as of 14:26, 13 July 2023
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)
