B2.createPrismaticJointDef: Difference between revisions
From GiderosMobile
No edit summary |
m Text replacement - "</source>" to "</syntaxhighlight>" |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
''' | <languages /> | ||
=== | '''Available since:''' Gideros 2011.6<br/> | ||
'''Class:''' [[Special:MyLanguage/b2|b2]]<br/> | |||
Creates and returns a prismatic joint definition table with the bodies, anchors, axis, and reference angle using the world anchor and world axis. | |||
(Please refer to [[b2.World:createJoint]] function for more information about all the information needed to create a prismatic joint). | === Description === | ||
Creates and returns a prismatic joint definition table with the bodies, anchors, axis, and reference angle using the world anchor and world axis. | |||
< | |||
(Please refer to [[b2.World:createJoint]] function for more information about all the information needed to create a prismatic joint). | |||
<syntaxhighlight lang="lua"> | |||
(table) = b2.createPrismaticJointDef(bodyA,bodyB,anchorx,anchory,axisx,axisy) | (table) = b2.createPrismaticJointDef(bodyA,bodyB,anchorx,anchory,axisx,axisy) | ||
</ | </syntaxhighlight> | ||
=== | |||
'''bodyA''': (b2.Body) | === Parameters === | ||
'''bodyB''': (b2.Body) | '''bodyA''': (b2.Body) the first attached body <br/> | ||
'''anchorx''': (number) | '''bodyB''': (b2.Body) the second attached body <br/> | ||
'''anchory''': (number) | '''anchorx''': (number) the x coordinate of the world anchor point <br/> | ||
'''axisx''': (number) | '''anchory''': (number) the y coordinate of the world anchor point <br/> | ||
'''axisy''': (number) | '''axisx''': (number) the x coordinate of the world axis <br/> | ||
=== | '''axisy''': (number) the y coordinate of the world axis <br/> | ||
''' | |||
=== | === Return values === | ||
'''Returns''' (table) A new prismatic joint definition table<br/> | |||
< | |||
=== Examples === | |||
<syntaxhighlight lang="lua"> | |||
--create empty box2d body for joint | |||
local ground = world:createBody({}) | local ground = world:createBody({}) | ||
ground:setPosition(465, 480) | ground:setPosition(465, 480) | ||
--axisx, | --axisx, axisy values usually between 0 and 1 | ||
--0 | --0 0 moves freely | ||
--0 | --0 1 moves on y axis | ||
--1 | --1 0 moves on x axis | ||
--1 | --1 1 moves on diagonal | ||
local jointDef = b2.createPrismaticJointDef(body, ground, 350, 100, 0.3, 1) | local jointDef = b2.createPrismaticJointDef(body, ground, 350, 100, 0.3, 1) | ||
local prismaticJoint = world:createJoint(jointDef)</ | local prismaticJoint = world:createJoint(jointDef) | ||
</syntaxhighlight> | |||
{{B2}} | |||
Latest revision as of 13:27, 13 July 2023
Available since: Gideros 2011.6
Class: b2
Description
Creates and returns a prismatic joint definition table with the bodies, anchors, axis, and reference angle using the world anchor and world axis.
(Please refer to b2.World:createJoint function for more information about all the information needed to create a prismatic joint).
(table) = b2.createPrismaticJointDef(bodyA,bodyB,anchorx,anchory,axisx,axisy)
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
axisx: (number) the x coordinate of the world axis
axisy: (number) the y coordinate of the world axis
Return values
Returns (table) A new prismatic joint definition table
Examples
--create empty box2d body for joint
local ground = world:createBody({})
ground:setPosition(465, 480)
--axisx, axisy values usually between 0 and 1
--0 0 moves freely
--0 1 moves on y axis
--1 0 moves on x axis
--1 1 moves on diagonal
local jointDef = b2.createPrismaticJointDef(body, ground, 350, 100, 0.3, 1)
local prismaticJoint = world:createJoint(jointDef)