Difference between revisions of "B2.createRopeJointDef"
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
<languages /> | <languages /> | ||
| − | ''' | + | '''Available since:''' Gideros 2012.09.3<br/> |
| − | ''' | + | '''Class:''' [[Special:MyLanguage/b2|b2]]<br/> |
| − | === | + | |
| − | + | === Description === | |
| − | Creates and returns a rope joint definition table with the bodies and local anchors using a world anchor point. | + | Creates and returns a rope 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 rope joint). | + | |
| − | + | (Please refer to [[b2.World:createJoint]] function for more information about all the information needed to create a rope joint). | |
<source lang="lua"> | <source lang="lua"> | ||
(table) = b2.createRopeJointDef(bodyA,bodyB,anchorAx,anchorAy,anchorBx,anchorBy,maxLength) | (table) = b2.createRopeJointDef(bodyA,bodyB,anchorAx,anchorAy,anchorBx,anchorBy,maxLength) | ||
</source> | </source> | ||
| − | === | + | |
| − | '''bodyA''': (b2.Body) | + | === Parameters === |
| − | '''bodyB''': (b2.Body) | + | '''bodyA''': (b2.Body) the first attached body <br/> |
| − | '''anchorAx''': (number) | + | '''bodyB''': (b2.Body) the second attached body <br/> |
| − | '''anchorAy''': (number) | + | '''anchorAx''': (number) the x coordinate of the world anchor point of bodyA <br/> |
| − | '''anchorBx''': (number) | + | '''anchorAy''': (number) the y coordinate of the world anchor point of bodyA <br/> |
| − | '''anchorBy''': (number) | + | '''anchorBx''': (number) the x coordinate of the world anchor point of bodyB <br/> |
| − | '''maxLength''': (number) | + | '''anchorBy''': (number) the y coordinate of the world anchor point of bodyB <br/> |
| − | === | + | '''maxLength''': (number) the maximum length of the rope <br/> |
| − | ''' | + | |
| + | === Return values === | ||
| + | '''Returns''' (table) A new rope joint definition table<br/> | ||
| + | |||
| + | {{B2}} | ||
Revision as of 04:57, 17 February 2020
Available since: Gideros 2012.09.3
Class: b2
Description
Creates and returns a rope 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 rope joint).
(table) = b2.createRopeJointDef(bodyA,bodyB,anchorAx,anchorAy,anchorBx,anchorBy,maxLength)
Parameters
bodyA: (b2.Body) the first attached body
bodyB: (b2.Body) the second attached body
anchorAx: (number) the x coordinate of the world anchor point of bodyA
anchorAy: (number) the y coordinate of the world anchor point of bodyA
anchorBx: (number) the x coordinate of the world anchor point of bodyB
anchorBy: (number) the y coordinate of the world anchor point of bodyB
maxLength: (number) the maximum length of the rope
Return values
Returns (table) A new rope joint definition table
