Difference between revisions of "B2.createPrismaticJointDef"

From GiderosMobile
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
'''Available since:''' Gideros 2011.6<br/>
+
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
=== Description ===
+
=== <translate>Description</translate> ===
 
<translate><br />
 
<translate><br />
 
Creates and returns a prismatic joint definition table with the bodies, anchors, axis, and reference angle using the world anchor and world axis.<br />
 
Creates and returns a prismatic joint definition table with the bodies, anchors, axis, and reference angle using the world anchor and world axis.<br />
Line 9: Line 9:
 
(table) = b2.createPrismaticJointDef(bodyA,bodyB,anchorx,anchory,axisx,axisy)
 
(table) = b2.createPrismaticJointDef(bodyA,bodyB,anchorx,anchory,axisx,axisy)
 
</source>
 
</source>
=== Parameters ===
+
=== <translate>Parameters</translate> ===
 
'''bodyA''': (b2.Body) <translate>the first attached body</translate> <br/>
 
'''bodyA''': (b2.Body) <translate>the first attached body</translate> <br/>
 
'''bodyB''': (b2.Body) <translate>the second attached body</translate> <br/>
 
'''bodyB''': (b2.Body) <translate>the second attached body</translate> <br/>
Line 16: Line 16:
 
'''axisx''': (number) <translate>the x coordinate of the world axis</translate> <br/>
 
'''axisx''': (number) <translate>the x coordinate of the world axis</translate> <br/>
 
'''axisy''': (number) <translate>the y coordinate of the world axis</translate> <br/>
 
'''axisy''': (number) <translate>the y coordinate of the world axis</translate> <br/>
=== Return values ===
+
=== <translate>Return values</translate> ===
'''Returns''' (table) <translate>A new prismatic joint definition table</translate><br/>
+
'''<translate>Returns</translate>''' (table) <translate>A new prismatic joint definition table</translate><br/>
=== Examples ===
+
=== <translate>Examples</translate> ===
 
'''Prismatic joint'''<br/>
 
'''Prismatic joint'''<br/>
 
<source lang="lua">--create empty box2d body for joint
 
<source lang="lua">--create empty box2d body for joint

Revision as of 08:27, 24 August 2018

Available since: Gideros 2011.6

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

Prismatic joint

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